#[repr(C)]pub struct Uint16Bits(/* private fields */);
Implementations§
Source§impl Uint16Bits
impl Uint16Bits
pub const ZEROTH: Self
pub const FIRST: Self
pub const SECOND: Self
pub const THIRD: Self
pub const FOURTH: Self
pub const FIFTH: Self
pub const SIXTH: Self
pub const SEVENTH: Self
pub const EIGHT: Self
pub const NINTH: Self
pub const TENTH: Self
pub const ELEVENTH: Self
pub const TWELFTH: Self
pub const THIRTEENTH: Self
pub const FOURTEENTH: Self
pub const FIFTHTEENTH: Self
Source§impl Uint16Bits
impl Uint16Bits
Sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl Uint16Bits
impl Uint16Bits
Sourcepub const fn iter(&self) -> Iter<Uint16Bits>
pub const fn iter(&self) -> Iter<Uint16Bits>
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.
Sourcepub const fn iter_names(&self) -> IterNames<Uint16Bits>
pub const fn iter_names(&self) -> IterNames<Uint16Bits>
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§
Source§impl Binary for Uint16Bits
impl Binary for Uint16Bits
Source§impl BitAnd for Uint16Bits
impl BitAnd for Uint16Bits
Source§impl BitAndAssign for Uint16Bits
impl BitAndAssign for Uint16Bits
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for Uint16Bits
impl BitOr for Uint16Bits
Source§fn bitor(self, other: Uint16Bits) -> Self
fn bitor(self, other: Uint16Bits) -> Self
The bitwise or (|
) of the bits in two flags values.
Source§type Output = Uint16Bits
type Output = Uint16Bits
|
operator.Source§impl BitOrAssign for Uint16Bits
impl BitOrAssign for Uint16Bits
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for Uint16Bits
impl BitXor for Uint16Bits
Source§impl BitXorAssign for Uint16Bits
impl BitXorAssign for Uint16Bits
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for Uint16Bits
impl Clone for Uint16Bits
Source§fn clone(&self) -> Uint16Bits
fn clone(&self) -> Uint16Bits
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Uint16Bits
impl Debug for Uint16Bits
Source§impl Extend<Uint16Bits> for Uint16Bits
impl Extend<Uint16Bits> for Uint16Bits
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Source§impl Flags for Uint16Bits
impl Flags for Uint16Bits
Source§const FLAGS: &'static [Flag<Uint16Bits>]
const FLAGS: &'static [Flag<Uint16Bits>]
Source§fn from_bits_retain(bits: u16) -> Uint16Bits
fn from_bits_retain(bits: u16) -> Uint16Bits
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.Source§impl FromBytes for Uint16Bits
impl FromBytes for Uint16Bits
Source§impl FromIterator<Uint16Bits> for Uint16Bits
impl FromIterator<Uint16Bits> for Uint16Bits
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
Source§impl FromZeros for Uint16Bits
impl FromZeros for Uint16Bits
Source§impl Hash for Uint16Bits
impl Hash for Uint16Bits
Source§impl IntoBytes for Uint16Bits
impl IntoBytes for Uint16Bits
Source§impl IntoIterator for Uint16Bits
impl IntoIterator for Uint16Bits
Source§impl LowerHex for Uint16Bits
impl LowerHex for Uint16Bits
Source§impl Not for Uint16Bits
impl Not for Uint16Bits
Source§impl Octal for Uint16Bits
impl Octal for Uint16Bits
Source§impl Ord for Uint16Bits
impl Ord for Uint16Bits
Source§fn cmp(&self, other: &Uint16Bits) -> Ordering
fn cmp(&self, other: &Uint16Bits) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for Uint16Bits
impl PartialEq for Uint16Bits
Source§impl PartialOrd for Uint16Bits
impl PartialOrd for Uint16Bits
Source§impl Sub for Uint16Bits
impl Sub for Uint16Bits
Source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§type Output = Uint16Bits
type Output = Uint16Bits
-
operator.Source§impl SubAssign for Uint16Bits
impl SubAssign for Uint16Bits
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.