Merge pull request #76 from hashmismatch/nested_example

Nested struct example

Author: rudib

README.md

@@ -35,7 +35,7 @@ provide safe packing, unpacking and runtime debugging formatters with per-field
 
 ```toml
 [dependencies]
-packed_struct = "0.5"
+packed_struct = "0.6"
 ```
 ## Importing the library with the the most common traits and the derive macros
 
@@ -190,6 +190,37 @@ fn main() -> Result<(), PackingError> {
 }
 ```
 
+## Nested packed types
+
+```rust
+use packed_struct::prelude::*;
+#[derive(PackedStruct, Debug, PartialEq)]
+#[packed_struct(endian="lsb")]
+pub struct Duration {
+    minutes: u8,
+    seconds: u8,
+}
+#[derive(PackedStruct, Debug, PartialEq)]
+pub struct Record {
+    #[packed_field(element_size_bytes="2")]
+    span: Duration,
+    events: u8,
+}
+fn main() -> Result<(), PackingError> {
+    let example = Record {
+        span: Duration {
+            minutes: 10,
+            seconds: 34,
+        },
+        events: 3,
+    };
+    let packed = example.pack()?;
+    let unpacked = Record::unpack(&packed)?;
+    assert_eq!(example, unpacked);
+    Ok(())
+}
+```
+
 ## Nested packed types within arrays
 
 ```rust

packed_struct/Cargo.toml

@@ -3,7 +3,7 @@ name = "packed_struct"
 description = "Binary-level structure packing and unpacking generator"
 repository = "https://github.com/hashmismatch/packed_struct.rs"
 homepage = "http://www.hashmismatch.net/libraries/packed-struct/"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Rudi Benkovic <[email protected]>"]
 build = "build.rs"
 license = "MIT OR Apache-2.0"
@@ -13,7 +13,7 @@ readme = "../README.md"
 edition = "2018"
 
 [dependencies]
-packed_struct_codegen = { path = "../packed_struct_codegen/", version = "0.5.0" }
+packed_struct_codegen = { path = "../packed_struct_codegen/", version = "0.6.0" }
 serde = { version = "1.0", optional = true, default-features = false }
 serde_derive = { version = "1.0", optional = true }
 

packed_struct/src/lib.rs

@@ -35,7 +35,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! packed_struct = "0.5"
+//! packed_struct = "0.6"
 //! ```
 //! ## Importing the library with the the most common traits and the derive macros
 //!
@@ -194,6 +194,37 @@
 //! }
 //! ```
 //!
+//! ## Nested packed types
+//! 
+//! ```rust
+//! use packed_struct::prelude::*;
+//! #[derive(PackedStruct, Debug, PartialEq)]
+//! #[packed_struct(endian="lsb")]
+//! pub struct Duration {
+//!     minutes: u8,
+//!     seconds: u8,
+//! }
+//! #[derive(PackedStruct, Debug, PartialEq)]
+//! pub struct Record {
+//!     #[packed_field(element_size_bytes="2")]
+//!     span: Duration,
+//!     events: u8,
+//! }
+//! fn main() -> Result<(), PackingError> {
+//!     let example = Record {
+//!         span: Duration {
+//!             minutes: 10,
+//!             seconds: 34,
+//!         },
+//!         events: 3,
+//!     };
+//!     let packed = example.pack()?;
+//!     let unpacked = Record::unpack(&packed)?;
+//!     assert_eq!(example, unpacked);
+//!     Ok(())
+//! }
+//! ```
+//!
 //! ## Nested packed types within arrays
 //!
 //! ```rust

packed_struct_codegen/Cargo.toml

@@ -2,7 +2,7 @@
 name = "packed_struct_codegen"
 description = "This crate implements the code generation for the packed_struct library."
 repository = "https://github.com/hashmismatch/packed_struct.rs"
-version = "0.5.0"
+version = "0.6.0"
 license = "MIT OR Apache-2.0"
 authors = ["Rudi Benkovic <[email protected]>"]
 edition = "2018"

packed_struct_examples/Cargo.toml

@@ -6,4 +6,4 @@ publish = false
 edition = "2018"
 
 [dependencies]
-packed_struct = { path = "../packed_struct/", version = "0.5", features = ["byte_types_64"] }
+packed_struct = { path = "../packed_struct/", version = "0.6", features = ["byte_types_64"] }

packed_struct_nostd_tests/Cargo.toml

@@ -4,4 +4,4 @@ version = "0.1.0"
 authors = ["Rudi Benkovic <[email protected]>"]
 
 [dependencies]
-packed_struct = { path = "../packed_struct/", version = "0.5", default-features = false }
+packed_struct = { path = "../packed_struct/", version = "0.6", default-features = false }

packed_struct_tests/Cargo.toml

@@ -6,6 +6,6 @@ publish = false
 edition = "2018"
 
 [dependencies]
-packed_struct = { path = "../packed_struct/", version = "0.5", features = ["byte_types_64", "use_serde"] }
+packed_struct = { path = "../packed_struct/", version = "0.6", features = ["byte_types_64", "use_serde"] }
 error-chain = "0.12.0"
 serde = "1.0"