Struct mju_bits::bitfield::BitFieldImpl

pub struct BitFieldImpl<TOwner, Shift, Mask> { /* fields omitted */ }

Marker type representing an owned bitfield. TOwner is the owning type of the bitfield. Shift and Mask are typenum::Unsigned types representing the shift and mask values used to access the bitfield. These are both converted to constants in the BitFieldTrait implemented for this struct.

While this type can be used directly, it is more convenient to use the BitField type alias to define a bit range rather than the lower-level shift and mask.

Trait Implementations

impl<TOwner, TShift, TMask> BitFieldTrait for BitFieldImpl<TOwner, TShift, TMask> where
    TShift: Unsigned,
    TMask: Unsigned, 

Implementation for BitFieldImpl explicitly converts the typenum shift and mask calculations into constants. Forcing the conversion here prevents infinite recursion by the compiler when these values are used by Storage to provide access to the field.

type Owner = TOwner

The owner, typically a Storage, bound to this bit field

const SHIFT: u32

The number of bits the field is shifted in the owner

const MASK: u64

The bit mask used to to select or clear the field bits in the owner