Auto merge of #55 - japaric:late-resources, r=japaric

homunkulus · homunkulus · commit d1bff24422f9 · 2017-12-09T13:46:32.000Z
[RFC] rename LateResourceValues to LateResources After writing `LateResourceValues` several times I now think it's too long to type. I'd like that struct to be renamed to `LateResources`. I don't think there would be a loss in readability with the rename because you can think of "late resources" as resources that "don't exist" until `init` ends instead of as resources that are not initialized after `init` ends -- the second meaning maps better to `LateResourceValues`. This would be a breaking-change but we are moving to v0.3.0 due to #50 in any case. cc jonas-schievink
diff --git a/examples/late-resources.rs b/examples/late-resources.rs
@@ -55,15 +55,15 @@ app! {
 }
 
 // The signature of `init` is now required to have a specific return type.
-fn init(_p: init::Peripherals, _r: init::Resources) -> init::LateResourceValues {
+fn init(_p: init::Peripherals, _r: init::Resources) -> init::LateResources {
     // `init::Resources` does not contain `IP_ADDRESS`, since it is not yet
     // initialized.
     //_r.IP_ADDRESS;     // doesn't compile
 
     // ...obtain value for IP_ADDRESS from EEPROM/DHCP...
     let ip_address = 0x7f000001;
 
-    init::LateResourceValues {
+    init::LateResources {
         // This struct will contain fields for all resources with omitted
         // initializers.
         IP_ADDRESS: ip_address,
diff --git a/macros/src/trans.rs b/macros/src/trans.rs
@@ -234,17 +234,17 @@ fn init(app: &App, main: &mut Vec<Tokens>, root: &mut Vec<Tokens>) {
         root.push(quote! {
             #[allow(non_camel_case_types)]
             #[allow(non_snake_case)]
-            pub struct _initLateResourceValues {
+            pub struct _initLateResources {
                 #(#fields)*
             }
         });
 
         mod_items.push(quote! {
-            pub use ::_initLateResourceValues as LateResourceValues;
+            pub use ::_initLateResources as LateResources;
         });
 
         // `init` must return the initialized resources
-        ret = Some(quote!( -> ::init::LateResourceValues));
+        ret = Some(quote!( -> ::init::LateResources));
     }
 
     root.push(quote! {
diff --git a/src/examples/_5_late_resources.rs b/src/examples/_5_late_resources.rs
@@ -57,15 +57,15 @@
 //! }
 //! 
 //! // The signature of `init` is now required to have a specific return type.
-//! fn init(_p: init::Peripherals, _r: init::Resources) -> init::LateResourceValues {
+//! fn init(_p: init::Peripherals, _r: init::Resources) -> init::LateResources {
 //!     // `init::Resources` does not contain `IP_ADDRESS`, since it is not yet
 //!     // initialized.
 //!     //_r.IP_ADDRESS;     // doesn't compile
 //! 
 //!     // ...obtain value for IP_ADDRESS from EEPROM/DHCP...
 //!     let ip_address = 0x7f000001;
 //! 
-//!     init::LateResourceValues {
+//!     init::LateResources {
 //!         // This struct will contain fields for all resources with omitted
 //!         // initializers.
 //!         IP_ADDRESS: ip_address,
diff --git a/tests/cfail/late-resource-init.rs b/tests/cfail/late-resource-init.rs
@@ -30,12 +30,12 @@ app! {
     },
 }
 
-fn init(_p: init::Peripherals, r: init::Resources) -> init::LateResourceValues {
+fn init(_p: init::Peripherals, r: init::Resources) -> init::LateResources {
     // Try to use a resource that's not yet initialized:
     r.LATE;
     //~^ error: no field `LATE`
 
-    init::LateResourceValues {
+    init::LateResources {
         LATE: 0,
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,12 +30,12 @@ app! {`
`30`	`30`	`},`
`31`	`31`	`}`
`32`	`32`
`33`		`-fn init(_p: init::Peripherals, r: init::Resources) -> init::LateResourceValues {`
	`33`	`+fn init(_p: init::Peripherals, r: init::Resources) -> init::LateResources {`
`34`	`34`	`// Try to use a resource that's not yet initialized:`
`35`	`35`	`r.LATE;`
`36`	`36`	//~^ error: no field `LATE`
`37`	`37`
`38`		`- init::LateResourceValues {`
	`38`	`+ init::LateResources {`
`39`	`39`	`LATE: 0,`
`40`	`40`	`}`
`41`	`41`	`}`