Struct bitbag::BitBag

#[repr(transparent)]
pub struct BitBag<Flag, Prim> { /* fields omitted */ }

A transparent wrapper over a primitive, with helper methods for checking flags

Implementations

impl<Flag, Prim> BitBag<Flag, Prim> where
    Prim: PrimInt + BitAndAssign<Prim>,
    Flag: Into<Prim> + Copy, 

pub fn is_set(&self, flag: Flag) -> bool

Return true if the flag is set

pub fn set(&mut self, flag: Flag)

Set the flag

pub fn unset(&mut self, flag: Flag)

Unset the flag

pub fn clear_all(&mut self)

Unset all flags

pub fn new_unchecked(prim: Prim) -> Self

Don’t check the primitive for non-flag bits

impl<Flag, Prim> BitBag<Flag, Prim> where
    Prim: PrimInt + BitAndAssign<Prim>,
    Flag: Into<Prim> + IntoEnumIterator, 

pub fn new(prim: Prim) -> Result<Self, InvalidFlag<Flag, Prim>>

Check the bits of prim, and return an InvalidFlag error if it has bits set which can’t be represented by a flag.

Trait Implementations

impl<Flag: Clone, Prim: Clone> Clone for BitBag<Flag, Prim>

fn clone(&self) -> BitBag<Flag, Prim>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Flag: Debug, Prim: Debug> Debug for BitBag<Flag, Prim>

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

Formats the value using the given formatter.

impl<Flag: Default, Prim: Default> Default for BitBag<Flag, Prim>

fn default() -> BitBag<Flag, Prim>

Returns the “default value” for a type.

impl<Flag, Prim> From<BitBag<Flag, Prim>> for (Prim, PhantomData<Flag>)

fn from(original: BitBag<Flag, Prim>) -> Self

Performs the conversion.

impl<Flag, Prim> IntoIterator for BitBag<Flag, Prim> where
    Prim: PrimInt + BitAndAssign<Prim>,
    Flag: Into<Prim> + IntoEnumIterator + Copy, 

type Item = Flag

The type of the elements being iterated over.

type IntoIter = BitBagIterator<Flag, Prim>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Flag, Prim> IntoIterator for &BitBag<Flag, Prim> where
    Prim: PrimInt + BitAndAssign<Prim>,
    Flag: Into<Prim> + IntoEnumIterator + Copy, 

type Item = Flag

The type of the elements being iterated over.

type IntoIter = BitBagIterator<Flag, Prim>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Flag: Copy, Prim: Copy> Copy for BitBag<Flag, Prim>