summary refs log tree commit diff
path: root/bit_field/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'bit_field/src/lib.rs')
-rw-r--r--bit_field/src/lib.rs24
1 files changed, 24 insertions, 0 deletions
diff --git a/bit_field/src/lib.rs b/bit_field/src/lib.rs
index 64a309b..bd11c3c 100644
--- a/bit_field/src/lib.rs
+++ b/bit_field/src/lib.rs
@@ -101,6 +101,30 @@
 //! }
 //! ```
 //!
+//! Fields may be user-defined single element tuple struct with primitive types. Use must specify
+//! the width with `#[bits = N]`. This should be used to improve type safety.
+//!
+//! ```
+//! extern crate bit_field;
+//!
+//! use bit_field::*;
+//!
+//! #[bitfield]
+//! #[bits = 60]
+//! struct AddressField(u64);
+//!
+//! impl AddressField {
+//!     pub fn new(addr: u64) -> AddressField {
+//!         AddressField(addr >> 4)
+//!     }
+//!
+//!     pub fn get_addr(&self) -> u64 {
+//!         self.0 << 4
+//!     }
+//! }
+//!
+//! ```
+//!
 //! Finally, fields may be of user-defined enum types. The enum must satisfy one of the following
 //! requirements.
 //!