Enum bitfield_layout::layouts::FlagType

pub enum FlagType<'a> {
    Significant(&'a str, &'a str),
    Reserved(&'a str),
    ShouldBe0,
    ShouldBe1,
    Unknown,
    Undefined,
}

Complex enumeration for several types of bit (flag)

This enum variants may be used to show difference beetween meaningful and reserved flags.

// Bitfield type definition
struct Light(u8);
impl Light {
    const LAYOUT: [FlagType<'static>; 8] = [
        FlagType::Significant("Red", "Red is the color at the long wavelength end"),
        FlagType::Significant("Blue", "Blue is one of the three primary colours of pigments"),
        FlagType::Significant("Green", "Green is the color between blue and yellow"),
        FlagType::Reserved("Invisible"),
        FlagType::ShouldBe0,
        FlagType::ShouldBe1,
        FlagType::Unknown,
        FlagType::Undefined,
    ];
}
// Implementation
impl Layout for Light {
    type Layout = slice::Iter<'static, FlagType<'static>>;
    fn layout() -> Self::Layout { Light::LAYOUT.iter() }
}
impl BitFieldLayout for Light {
    type Value = u8;
    fn get(&self) -> Self::Value { self.0 }
    fn set(&mut self, new: Self::Value) { self.0 = new; }
}

// Value assignment
let white = Light(0b00100111);

let result = white.flags()
    .enumerate()
    .find(|(n, f)| n == &5 && f.is_set == true)
    .map(|(_, f)| *f.value);
let sample = Some(FlagType::ShouldBe1);

assert_eq!(sample, result);

Variants

Significant

Has two strings - one for meaning, other for long description

Tuple Fields of Significant

0: &'a str1: &'a str

Reserved

Reserved bit (flag) may has different types of reservation. Ex: OEM and Future using

Tuple Fields of Reserved

0: &'a str

ShouldBe0

Should always be set

ShouldBe1

Should always be unset

Unknown

Unknown for current specification

Undefined

Undefined in current specification

Trait Implementations

impl<'a> Clone for FlagType<'a>

fn clone(&self) -> FlagType<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for FlagType<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Display for FlagType<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Hash for FlagType<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for FlagType<'a>

fn cmp(&self, other: &FlagType<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<FlagType<'a>> for FlagType<'a>

fn eq(&self, other: &FlagType<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FlagType<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<FlagType<'a>> for FlagType<'a>

fn partial_cmp(&self, other: &FlagType<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for FlagType<'a>

impl<'a> Eq for FlagType<'a>

impl<'a> StructuralEq for FlagType<'a>

impl<'a> StructuralPartialEq for FlagType<'a>