Module mycelium_bitfield::example

source ·
Available on trace_macros only.
Expand description

An example of the code generated by the bitfield! macro.

Warning: This module is included for DEMONSTRATION PURPOSES ONLY. This module is not part of the public API of this crate; it is provided as documentation only, and may change in non-breaking releases.

The ExampleBitfield type in this module was generated by the following bitfield! invocation:

ⓘ
use crate::{
    bitfield,
    example::{AnotherTestEnum, TestEnum},
};

bitfield! {
    /// An example bitfield type.
    ///
    /// This type was generated by the following [`bitfield!`]
    /// macro invocation:
    /// ```
    #[doc = include_str!("example_bitfield.rs")]
    /// ```
    #[derive(PartialEq, Eq, Hash)]
    pub struct ExampleBitfield<u64> {
        /// Six bits of arbitrary meaning.
        pub const SOME_BITS = 6;

        /// A bit flag.
        ///
        /// This is `true` if foo is enabled. What that means is left
        /// as an exercise to the reader.
        pub const FOO_ENABLED: bool;

        /// Another bit flag.
        ///
        /// This is `true` if bar is enabled. What that means is left
        /// as an exercise to the reader.
        pub const BAR_ENABLED: bool;

        /// These bits are reserved and should always be 0.
        const _RESERVED_1 = 2;

        /// An enum value
        pub const TEST_ENUM: TestEnum;

        const _RESERVED_BITS = 4;

        /// Another enum.
        pub const ANOTHER_ENUM: AnotherTestEnum;

        /// An 8-bit signed integer value.
        ///
        /// Who knows what this means.
        pub const A_BYTE: i8;

        /// `..` can be used to create a packing spec for all the remaining
        /// bits in a bitfield.
        pub const REST = ..;
    }
}

This module also contains two example types implementing the FromBits trait, as a demonstration of how typed enums can be used with the bitfield! macro.

Structs

Enums