Rust procedural macro to quickly generate bitfield from a structure.
The macro can be used as following: ```rust
// Where size can be: u8 u16 u32 u64 u128
// And order can be lsb or msb ``` The size parameter will constrain the total size of the bitfield. The order parameter will alter the order in which the fields are declared. When setting the order parameter to msb, the first declared field of the struct will be set on the most significant bit, and the other way around when using the lsb mode.
The size and position of the field is based on the field declaration :
rust
struct Example
{
any_case_name_intBitfieldSize: BogusType,
}
Finally, the internal, full value of the field can be accessed as : ``` rust let e = Example::default(); println!("{}", e.raw);
```
Considering the following bitfield:
``` 7 0 0 0 0 0 0 0 0 0 | | | | | | | |_ field1 - Size 1 | | | | | | |_ field2 - Size 1 | | | | | |_ field3 - Size 1 | | \|/_ reserved - Size 3 \ /____ field4 - Size 2
```
It can be achieved with the following declaration and macro usage
```rust
struct MyStruct { fielda1: (), fieldA1: (), FieldA1: (), reserved3: (), FieldA_2: (), } ```
This will generate the following structure and associated methods
```rust struct MyStruct { pub raw: u8, }
impl MyStruct { fn fielda() -> u8 { ... } fn setfield_a(val: u8) { ... } }
impl Default for MyStruct { ... } ```
So you can easily set and read values of each defined bitfield:
rust
let mut bf = MyStruct::default;
bf.set_field1(1);
println!("{:#010b}", bf.field1());