Attribute Macro modular_bitfield_impl::bitfield

#[bitfield]

Attribute applicable to structs that turns them into bitfield structs.

Generates getters and setters for all fields in the struct. Can be used modularily in combination with enums that derive from BitfieldSpecifier via `#[derive(BitfieldSpecifier)].

Also generates a simple constructor new that initializes all bits to 0.

It is possible to attach #[bits = N] attribute to struct fields to assert that they are of size N bits.

Example

use modular_bitfield::prelude::*;

#[bitfield]
struct Example {
    a: B1,  // Uses 1 bit
    #[bits = 7] // Optional, just asserts that B7 uses exactly 7 bits.
    b: B7,  // Uses 7 bits
    c: B24, // Uses 24 bits
}

fn main() {
    let mut example = Example::new();
    assert_eq!(example.get_a(), 0);
    assert_eq!(example.get_b(), 0);
    assert_eq!(example.get_c(), 0);
    example.set_a(1);
    example.set_b(0b0100_0000);
    example.set_c(1337);
    assert_eq!(example.get_a(), 1);
    assert_eq!(example.get_b(), 0b0100_0000);
    assert_eq!(example.get_c(), 1337);
}