Struct ExampleFlags

pub struct ExampleFlags(/* private fields */)
where
    u32: BitsPrimitive;

A example bitflag

Implementations

impl ExampleFlags

pub const Flag1: Self

pub const Flag2: Self

pub const Flag3: Self

pub const Flag4: Self

pub const Flag5: Self

pub const Flag6: Self

pub const Flag7: Self

pub const Flag8: Self

pub const Flag9: Self

pub const Flag10: Self

pub const Flag11: Self

pub const Flag12: Self

impl ExampleFlags

pub const fn bits(&self) -> u32

Return the underlying bits of this 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 a flags value with all bits unset.

pub const fn is_empty(&self) -> bool

Returns true if the flag value has all bits unset.

pub const fn all_bits() -> Self

Returns a flag value 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 flag value 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 flag value 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 flag value contais all known flags.

pub const fn contains_unknown_bits(&self) -> bool

Returns true if there are any unknown bits set in the flag value.

pub const fn truncated(&self) -> Self

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

pub fn truncate(&mut self)

Removes unknown bits from the flag value.

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

Returns true if this flag value 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 flag value 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.

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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 bits in other in the value.

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

Toggle the flags in other in the value.

impl ExampleFlags

pub const fn iter(&self) -> Iter<Self>

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) -> IterNames<Self>

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 ExampleFlags

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

Formats the value using the given formatter.

impl BitAnd for ExampleFlags

type Output = ExampleFlags

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for ExampleFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for ExampleFlags

type Output = ExampleFlags

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for ExampleFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for ExampleFlags

type Output = ExampleFlags

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for ExampleFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for ExampleFlags

where u32: BitsPrimitive,

fn clone(&self) -> ExampleFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleFlags

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

Formats the value using the given formatter.

impl Extend<ExampleFlags> for ExampleFlags

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 Flags for ExampleFlags

const KNOWN_FLAGS: &'static [(&'static str, ExampleFlags)]

The set of named defined flags.

const EXTRA_VALID_BITS: u32 = 4_294_967_295u32

Extra possible bits values for the flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> Self::Bits

Return the underlying bits of this bitflag.

fn from_bits_retain(bits: Self::Bits) -> Self

Convert from bits value exactly.

fn from_bits(bits: Self::Bits) -> Option<Self>

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

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from bits value, unsetting any unknown bits.

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

Convert from a flag name.

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

Get a flags value with the bits of a flag with the given name set.

fn empty() -> Self

Construct a flag value with all bits unset.

fn is_empty(&self) -> bool

Returns true if the flag value has all bits unset.

fn all_bits() -> Self

Returns a flag value that contains all value.

fn is_all_bits(&self) -> bool

Returns true if the bitflag contains all value bits set.

fn all() -> Self

Construct a flag value with all known flags set.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn contains_unknown_bits(&self) -> bool

Returns true if there are any unknown bits set in the flag value.

fn truncated(&self) -> Self

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

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

where Self: Sized,

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

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

where Self: Sized,

Returns true if this flag value contains all values of other.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

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

Returns the intersection from this value with other.

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

Returns the union from this value with other.

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

Returns the difference from this value with other.

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

TReturns the symmetric difference from this value with other..

fn complement(self) -> Self

Returns the complement of the value.

fn set(&mut self, other: Self)

where Self: Sized,

Set the flags in other in the value.

fn unset(&mut self, other: Self)

where Self: Sized,

/// Unset the flags bits in other in the value.

fn toggle(&mut self, other: Self)

where Self: Sized,

Toggle the flags in other in the value.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

impl From<ExampleFlags> for u32

fn from(val: ExampleFlags) -> Self

Converts to this type from the input type.

impl From<u32> for ExampleFlags

fn from(val: u32) -> Self

Converts to this type from the input type.

impl FromIterator<ExampleFlags> for ExampleFlags

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

Create a ExampleFlags from a iterator of flags.

impl FromStr for ExampleFlags

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ExampleFlags

where u32: BitsPrimitive,

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 &ExampleFlags

type Item = ExampleFlags

The type of the elements being iterated over.

type IntoIter = Iter<ExampleFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ExampleFlags

type Item = ExampleFlags

The type of the elements being iterated over.

type IntoIter = Iter<ExampleFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ExampleFlags

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

Formats the value using the given formatter.

impl Not for ExampleFlags

type Output = ExampleFlags

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for ExampleFlags

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

Formats the value using the given formatter.

impl Ord for ExampleFlags

where u32: BitsPrimitive,

fn cmp(&self, other: &ExampleFlags) -> 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 ExampleFlags

where u32: BitsPrimitive,

fn eq(&self, other: &ExampleFlags) -> 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 ExampleFlags

where u32: BitsPrimitive,

fn partial_cmp(&self, other: &ExampleFlags) -> 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 ExampleFlags

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

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

type Output = ExampleFlags

The resulting type after applying the - operator.

impl SubAssign for ExampleFlags

fn sub_assign(&mut self, rhs: Self)

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

impl UpperHex for ExampleFlags

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

Formats the value using the given formatter.

impl Copy for ExampleFlags

where u32: BitsPrimitive,

impl Eq for ExampleFlags

where u32: BitsPrimitive,

impl StructuralPartialEq for ExampleFlags

where u32: BitsPrimitive,

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes