Struct bitflags::example_generated::Flags [−] [src]

pub struct Flags { /* fields omitted */ }

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`
[src]

`fn empty() -> Flags`

Returns an empty set of flags.

`fn all() -> Flags`

Returns the set containing all flags.

`fn bits(&self) -> u32`

Returns the raw value of the flags currently stored.

`fn from_bits(bits: u32) -> Option<Flags>`

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

`fn from_bits_truncate(bits: u32) -> Flags`

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

`fn is_empty(&self) -> bool`

Returns true if no flags are currently stored.

`fn is_all(&self) -> bool`

Returns true if all flags are currently set.

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

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

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

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

`fn insert(&mut self, other: Flags)`

Inserts the specified flags in-place.

`fn remove(&mut self, other: Flags)`

Removes the specified flags in-place.

`fn toggle(&mut self, other: Flags)`

Toggles the specified flags in-place.

`fn set(&mut self, other: Flags, value: bool)`

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

Trait Implementations

`impl Copy for Flags`
[src]

`impl PartialEq for Flags`
[src]

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

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

`fn ne(&self, __arg_0: &Flags) -> bool`

This method tests for !=.

`impl Eq for Flags`
[src]

`impl Clone for Flags`
[src]

`fn clone(&self) -> Flags`

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

`impl PartialOrd for Flags`
[src]

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

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

`fn lt(&self, __arg_0: &Flags) -> bool`

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

`fn le(&self, __arg_0: &Flags) -> bool`

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

`fn gt(&self, __arg_0: &Flags) -> bool`

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

`fn ge(&self, __arg_0: &Flags) -> bool`

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

`impl Ord for Flags`
[src]

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

This method returns an Ordering between self and other. Read more

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

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

Compares and returns the maximum of two values. Read more

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

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

Compares and returns the minimum of two values. Read more

`impl Hash for Flags`
[src]

`fn hash<H: Hasher>(&self, arg_0: &mut __H)`

Feeds this value into the given [Hasher]. Read more