Struct Flags

pub struct Flags(/* private fields */)
where
    u32: BitflagPrimitive;

Example of the generated code by bitflag macro.

Implementations

impl Flags

pub const A: Self

The value A, at bit position 0.

pub const B: Self

The value B, at bit position 1.

pub const C: Self

The value C, at bit position 2.

pub const ABC: Self

The combination of A, B, and C.

pub const fn bits(&self) -> u32

Return the underlying bits of the bitflag

pub const fn from_bits(bits: u32) -> Option<Self>

Converts from a bits value. Returning None is any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from bits value exactly.

pub fn from_flag_name(name: &str) -> Option<Self>

Convert from a flag name.

pub const fn empty() -> Self

Construct an empty bitflag.

pub const fn is_empty(&self) -> bool

Returns true if the flag is empty.

pub const fn all_bits() -> Self

Returns a bitflag that contains all value.

This will include bits that do not have any flags/meaning. Use all if you want only the specified flags set.

pub const fn is_all_bits(&self) -> bool

Returns true if the bitflag contains all value bits set.

This will check for all bits. Use is_all if you want to check for all specified flags.

pub const fn all() -> Self

Construct a bitflag with all known flags set.

This will only set the flags specified as associated constant.

pub const fn is_all(&self) -> bool

Returns true if the bitflag contais all known flags.

pub const fn truncate(&self) -> Self

Returns a bit flag that only has bits corresponding to the specified flags as associated constant.

pub const fn intersects(&self, other: Self) -> bool

Returns true if this bitflag intersects with any value in other.

This is equivalent to (self & other) != Self::empty()

pub const fn contains(&self, other: Self) -> bool

Returns true if this bitflag contains all values of other.

This is equivalent to (self & other) == other

pub const fn not(self) -> Self

Returns the bitwise NOT of the flag.

This function does not truncate unused bits (bits that do not have any flags/meaning). Use complement if you want that the result to be truncated in one call.

pub const fn and(self, other: Self) -> Self

Returns the bitwise AND of the flag.

pub const fn or(self, other: Self) -> Self

Returns the bitwise OR of the flag with other.

pub const fn xor(self, other: Self) -> Self

Returns the bitwise XOR of the flag with other.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection from this value with other.

pub const fn union(self, other: Self) -> Self

Returns the union from this value with other

pub const fn difference(self, other: Self) -> Self

Returns the difference from this value with other.

In other words, returns the intersection of this value with the negation of other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference from this value with other.

pub const fn complement(self) -> Self

Returns the complement of the value.

This is very similar to the not, but truncates non used bits

pub fn set(&mut self, other: Self)

Set the flags in other in the value.

pub fn unset(&mut self, other: Self)

Unset the flags in other in the value.

pub fn toggle(&mut self, other: Self)

Toggle the flags in other in the value.

impl Flags

pub const fn iter(&self) -> FlagsIter

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> FlagsIterNames

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd for Flags

type Output = Flags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for Flags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Flags

type Output = Flags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for Flags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for Flags

type Output = Flags

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for Flags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Flags

where u32: BitflagPrimitive,

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Extend<Flags> for Flags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iter: T)

Set all flags of iter to self

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Flags> for u32

fn from(val: Flags) -> Self

Converts to this type from the input type.

impl From<u32> for Flags

fn from(val: u32) -> Self

Converts to this type from the input type.

impl FromIterator<Flags> for Flags

fn from_iter<T: IntoIterator<Item = Self>>(iter: T) -> Self

Create a #ty_name from a iterator of flags.

impl Hash for Flags

where u32: BitflagPrimitive,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for &Flags

type Item = Flags

The type of the elements being iterated over.

type IntoIter = FlagsIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Flags

type Item = Flags

The type of the elements being iterated over.

type IntoIter = FlagsIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

type Output = Flags

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

where u32: BitflagPrimitive,

fn cmp(&self, other: &Flags) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Flags

where u32: BitflagPrimitive,

fn eq(&self, other: &Flags) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Flags

where u32: BitflagPrimitive,

fn partial_cmp(&self, other: &Flags) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for Flags

fn sub(self, rhs: Self) -> Self::Output

The intersection of a source flag with the complement of a target flags value

type Output = Flags

The resulting type after applying the - operator.

impl SubAssign for Flags

fn sub_assign(&mut self, rhs: Self)

The intersection of a source flag with the complement of a target flags value

impl UpperHex for Flags

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

Formats the value using the given formatter.

impl Copy for Flags

where u32: BitflagPrimitive,

impl Eq for Flags

where u32: BitflagPrimitive,

impl StructuralPartialEq for Flags

where u32: BitflagPrimitive,