Struct bitflags::example_generated::Flags

[+] Show declaration

pub struct Flags { /* fields omitted */ }

[−] Expand description

This is the same Flags struct defined in the crate level example. Note that this struct is just for documentation purposes only, it must not be used outside this crate.

Methods

impl Flags[−]

pub fn empty() -> Flags[−]

Returns an empty set of flags.

pub fn all() -> Flags[−]

Returns the set containing all flags.

pub fn bits(&self) -> u32[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Flags>[−]

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u32) -> Flags[−]

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool[−]

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool[−]

Returns true if all flags are currently set.

pub fn intersects(&self, other: Flags) -> bool[−]

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: Flags) -> bool[−]

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Flags)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Flags)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Flags)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: Flags, value: bool)[−]

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for Flags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl BitAnd<Flags> for Flags[+]

type Output = Flags

The resulting type after applying the & operator.

fn bitand(self, other: Flags) -> Flags[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<Flags> for Flags[+]

fn bitand_assign(&mut self, other: Flags)[−]

Disables all flags disabled in the set.

impl BitOr<Flags> for Flags[+]

type Output = Flags

The resulting type after applying the | operator.

fn bitor(self, other: Flags) -> Flags[−]

Returns the union of the two sets of flags.

impl BitOrAssign<Flags> for Flags[+]

fn bitor_assign(&mut self, other: Flags)[−]

Adds the set of flags.

impl BitXor<Flags> for Flags[+]

type Output = Flags

The resulting type after applying the ^ operator.

fn bitxor(self, other: Flags) -> Flags[−]

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Flags> for Flags[+]

fn bitxor_assign(&mut self, other: Flags)[−]

Toggles the set of flags.

impl Clone for Flags[+]

[+] Show hidden undocumented items

fn clone(&self) -> Flags[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Flags

impl Debug for Flags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for Flags

impl Extend<Flags> for Flags[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = Flags>>(&mut self, iterator: T)[−]

Extends a collection with the contents of an iterator.

impl FromIterator<Flags> for Flags[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = Flags>>(iterator: T) -> Flags[−]

Creates a value from an iterator.

impl Hash for Flags[+]

[+] Show hidden undocumented items

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 LowerHex for Flags[+]

[+] Show hidden undocumented items

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) -> Flags[−]

Returns the complement of this set of flags.

impl Octal for Flags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Ord for Flags[+]

[+] Show hidden undocumented items

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

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use] fn clamp(self, min: Self, max: Self) -> Self[−]

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

Restrict a value to a certain interval.

impl PartialEq<Flags> for Flags[+]

[+] Show hidden undocumented items

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

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

fn ne(&self, other: &Flags) -> bool[−]

This method tests for !=.

impl PartialOrd<Flags> for Flags[+]

[+] Show hidden undocumented items

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: &Flags) -> bool[−]

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

fn le(&self, other: &Flags) -> bool[−]

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

fn gt(&self, other: &Flags) -> bool[−]

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

fn ge(&self, other: &Flags) -> bool[−]

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

impl StructuralEq for Flags

impl StructuralPartialEq for Flags

impl Sub<Flags> for Flags[+]

type Output = Flags

The resulting type after applying the - operator.

fn sub(self, other: Flags) -> Flags[−]

Returns the set difference of the two sets of flags.

impl SubAssign<Flags> for Flags[+]

fn sub_assign(&mut self, other: Flags)[−]

Disables all flags enabled in the set.

impl UpperHex for Flags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.