[−][src]Struct bitflags::example_generated::Flags
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]
pub const A: Flags
[src]
pub const B: Flags
[src]
pub const C: Flags
[src]
pub const ABC: Flags
[src]
pub const fn empty() -> Flags
[src]
Returns an empty set of flags
pub const fn all() -> Flags
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> u32
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<Flags>
[src]
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u32) -> Flags
[src]
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: Flags) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: Flags) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: Flags)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: Flags)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: Flags)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: Flags, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl PartialEq<Flags> for Flags
[src]
impl Eq for Flags
[src]
impl Ord for Flags
[src]
fn cmp(&self, other: &Flags) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
[src]
clamp
)Restrict a value to a certain interval. Read more
impl PartialOrd<Flags> for Flags
[src]
fn partial_cmp(&self, other: &Flags) -> Option<Ordering>
[src]
fn lt(&self, other: &Flags) -> bool
[src]
fn le(&self, other: &Flags) -> bool
[src]
fn gt(&self, other: &Flags) -> bool
[src]
fn ge(&self, other: &Flags) -> bool
[src]
impl Hash for Flags
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Sub<Flags> for Flags
[src]
type Output = Flags
The resulting type after applying the -
operator.
fn sub(self, other: Flags) -> Flags
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<Flags> for Flags
[src]
fn sub_assign(&mut self, other: Flags)
[src]
Disables all flags enabled in the set.
impl Not for Flags
[src]
type Output = Flags
The resulting type after applying the !
operator.
fn not(self) -> Flags
[src]
Returns the complement of this set of flags.
impl BitAnd<Flags> for Flags
[src]
type Output = Flags
The resulting type after applying the &
operator.
fn bitand(self, other: Flags) -> Flags
[src]
Returns the intersection between the two sets of flags.
impl BitOr<Flags> for Flags
[src]
type Output = Flags
The resulting type after applying the |
operator.
fn bitor(self, other: Flags) -> Flags
[src]
Returns the union of the two sets of flags.
impl BitXor<Flags> for Flags
[src]
type Output = Flags
The resulting type after applying the ^
operator.
fn bitxor(self, other: Flags) -> Flags
[src]
Returns the left flags, but with all the right flags toggled.
impl BitAndAssign<Flags> for Flags
[src]
fn bitand_assign(&mut self, other: Flags)
[src]
Disables all flags disabled in the set.
impl BitOrAssign<Flags> for Flags
[src]
fn bitor_assign(&mut self, other: Flags)
[src]
Adds the set of flags.
impl BitXorAssign<Flags> for Flags
[src]
fn bitxor_assign(&mut self, other: Flags)
[src]
Toggles the set of flags.
impl Debug for Flags
[src]
impl FromIterator<Flags> for Flags
[src]
fn from_iter<T: IntoIterator<Item = Flags>>(iterator: T) -> Flags
[src]
impl Octal for Flags
[src]
impl Binary for Flags
[src]
impl LowerHex for Flags
[src]
impl UpperHex for Flags
[src]
impl Copy for Flags
[src]
impl Extend<Flags> for Flags
[src]
fn extend<T: IntoIterator<Item = Flags>>(&mut self, iterator: T)
[src]
impl Clone for Flags
[src]
Auto Trait Implementations
Blanket Implementations
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,