Struct FromBitsError

pub struct FromBitsError<T: BitFlag> { /* private fields */ }

The error struct used by BitFlags::from_bits and the TryFrom implementation for invalid values.

Note that the implementation of [std::error::Error] for this type is gated on the std feature flag.

#[bitflags]
#[derive(Clone, Copy, Debug)]
#[repr(u8)]
enum MyFlags {
    A = 0b0001,
    B = 0b0010,
    C = 0b0100,
    D = 0b1000,
}

let result: Result<BitFlags<MyFlags>, _> = 0b10101u8.try_into();
assert!(result.is_err());
let error = result.unwrap_err();
assert_eq!(error.truncate(), MyFlags::C | MyFlags::A);
assert_eq!(error.invalid_bits(), 0b10000);

Implementations

impl<T: BitFlag> FromBitsError<T>

pub fn truncate(self) -> BitFlags<T>

Return the truncated result of the conversion.

pub fn invalid_bits(self) -> T::Numeric

Return the bits that didn’t correspond to any flags.

Trait Implementations

impl<T: Clone + BitFlag> Clone for FromBitsError<T>

where T::Numeric: Clone,

fn clone(&self) -> FromBitsError<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + BitFlag> Debug for FromBitsError<T>

where T::Numeric: Debug,

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

Formats the value using the given formatter.

impl<T: BitFlag + Debug> Display for FromBitsError<T>

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

Formats the value using the given formatter.

impl<T: Copy + BitFlag> Copy for FromBitsError<T>

where T::Numeric: Copy,