Struct ToggleStateFlags
pub struct ToggleStateFlags(/* private fields */);
Expand description
A series of flags determining the state of an input device mute toggle.
Implementations§
§impl ToggleStateFlags
impl ToggleStateFlags
pub const AVAILABLE: ToggleStateFlags
pub const AVAILABLE: ToggleStateFlags
The input device exists and is neither muted nor disabled.
pub const ACTIVE: ToggleStateFlags
pub const ACTIVE: ToggleStateFlags
The input device is being used.
pub const MUTED: ToggleStateFlags
pub const MUTED: ToggleStateFlags
The input device could be available if it was enabled, but it is muted.
pub const DISABLED: ToggleStateFlags
pub const DISABLED: ToggleStateFlags
The input device is permanently disabled, e.g. by policy.
pub const ERROR: ToggleStateFlags
pub const ERROR: ToggleStateFlags
The state cannot be determined.
§impl ToggleStateFlags
impl ToggleStateFlags
pub const fn empty() -> ToggleStateFlags
pub const fn empty() -> ToggleStateFlags
Get a flags value with all bits unset.
pub const fn all() -> ToggleStateFlags
pub const fn all() -> ToggleStateFlags
Get a flags value with all known bits set.
pub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
pub const fn from_bits(bits: u64) -> Option<ToggleStateFlags>
pub const fn from_bits(bits: u64) -> Option<ToggleStateFlags>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u64) -> ToggleStateFlags
pub const fn from_bits_truncate(bits: u64) -> ToggleStateFlags
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u64) -> ToggleStateFlags
pub const fn from_bits_retain(bits: u64) -> ToggleStateFlags
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<ToggleStateFlags>
pub fn from_name(name: &str) -> Option<ToggleStateFlags>
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.
pub const fn intersects(&self, other: ToggleStateFlags) -> bool
pub const fn intersects(&self, other: ToggleStateFlags) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: ToggleStateFlags) -> bool
pub const fn contains(&self, other: ToggleStateFlags) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn insert(&mut self, other: ToggleStateFlags)
pub fn insert(&mut self, other: ToggleStateFlags)
The bitwise or (|
) of the bits in two flags values.
pub fn remove(&mut self, other: ToggleStateFlags)
pub fn remove(&mut self, other: ToggleStateFlags)
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.
pub fn toggle(&mut self, other: ToggleStateFlags)
pub fn toggle(&mut self, other: ToggleStateFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: ToggleStateFlags, value: bool)
pub fn set(&mut self, other: ToggleStateFlags, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: ToggleStateFlags) -> ToggleStateFlags
pub const fn intersection(self, other: ToggleStateFlags) -> ToggleStateFlags
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: ToggleStateFlags) -> ToggleStateFlags
pub const fn union(self, other: ToggleStateFlags) -> ToggleStateFlags
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: ToggleStateFlags) -> ToggleStateFlags
pub const fn difference(self, other: ToggleStateFlags) -> ToggleStateFlags
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.
pub const fn symmetric_difference(
self,
other: ToggleStateFlags,
) -> ToggleStateFlags
pub const fn symmetric_difference( self, other: ToggleStateFlags, ) -> ToggleStateFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> ToggleStateFlags
pub const fn complement(self) -> ToggleStateFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl ToggleStateFlags
impl ToggleStateFlags
pub const fn iter(&self) -> Iter<ToggleStateFlags>
pub const fn iter(&self) -> Iter<ToggleStateFlags>
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<ToggleStateFlags>
pub const fn iter_names(&self) -> IterNames<ToggleStateFlags>
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.
§impl ToggleStateFlags
impl ToggleStateFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u64
get_unknown_bits
Trait Implementations§
§impl Binary for ToggleStateFlags
impl Binary for ToggleStateFlags
§impl BitAnd for ToggleStateFlags
impl BitAnd for ToggleStateFlags
§fn bitand(self, other: ToggleStateFlags) -> ToggleStateFlags
fn bitand(self, other: ToggleStateFlags) -> ToggleStateFlags
The bitwise and (&
) of the bits in two flags values.
§type Output = ToggleStateFlags
type Output = ToggleStateFlags
&
operator.§impl BitAndAssign for ToggleStateFlags
impl BitAndAssign for ToggleStateFlags
§fn bitand_assign(&mut self, other: ToggleStateFlags)
fn bitand_assign(&mut self, other: ToggleStateFlags)
The bitwise and (&
) of the bits in two flags values.
§impl BitOr for ToggleStateFlags
impl BitOr for ToggleStateFlags
§fn bitor(self, other: ToggleStateFlags) -> ToggleStateFlags
fn bitor(self, other: ToggleStateFlags) -> ToggleStateFlags
The bitwise or (|
) of the bits in two flags values.
§type Output = ToggleStateFlags
type Output = ToggleStateFlags
|
operator.§impl BitOrAssign for ToggleStateFlags
impl BitOrAssign for ToggleStateFlags
§fn bitor_assign(&mut self, other: ToggleStateFlags)
fn bitor_assign(&mut self, other: ToggleStateFlags)
The bitwise or (|
) of the bits in two flags values.
§impl BitXor for ToggleStateFlags
impl BitXor for ToggleStateFlags
§fn bitxor(self, other: ToggleStateFlags) -> ToggleStateFlags
fn bitxor(self, other: ToggleStateFlags) -> ToggleStateFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = ToggleStateFlags
type Output = ToggleStateFlags
^
operator.§impl BitXorAssign for ToggleStateFlags
impl BitXorAssign for ToggleStateFlags
§fn bitxor_assign(&mut self, other: ToggleStateFlags)
fn bitxor_assign(&mut self, other: ToggleStateFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl Clone for ToggleStateFlags
impl Clone for ToggleStateFlags
§fn clone(&self) -> ToggleStateFlags
fn clone(&self) -> ToggleStateFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ToggleStateFlags
impl Debug for ToggleStateFlags
§impl<D> Decode<ToggleStateFlags, D> for ToggleStateFlagswhere
D: ResourceDialect,
impl<D> Decode<ToggleStateFlags, D> for ToggleStateFlagswhere
D: ResourceDialect,
§fn new_empty() -> ToggleStateFlags
fn new_empty() -> ToggleStateFlags
Self
. The specific value does not matter,
since it will be overwritten by decode
.§impl Default for ToggleStateFlags
impl Default for ToggleStateFlags
§fn default() -> ToggleStateFlags
fn default() -> ToggleStateFlags
§impl<D> Encode<ToggleStateFlags, D> for ToggleStateFlagswhere
D: ResourceDialect,
impl<D> Encode<ToggleStateFlags, D> for ToggleStateFlagswhere
D: ResourceDialect,
§impl Extend<ToggleStateFlags> for ToggleStateFlags
impl Extend<ToggleStateFlags> for ToggleStateFlags
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ToggleStateFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ToggleStateFlags>,
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
)§impl Flags for ToggleStateFlags
impl Flags for ToggleStateFlags
§const FLAGS: &'static [Flag<ToggleStateFlags>]
const FLAGS: &'static [Flag<ToggleStateFlags>]
§fn from_bits_retain(bits: u64) -> ToggleStateFlags
fn from_bits_retain(bits: u64) -> ToggleStateFlags
§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§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.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§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.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.§impl FromIterator<ToggleStateFlags> for ToggleStateFlags
impl FromIterator<ToggleStateFlags> for ToggleStateFlags
§fn from_iter<T>(iterator: T) -> ToggleStateFlagswhere
T: IntoIterator<Item = ToggleStateFlags>,
fn from_iter<T>(iterator: T) -> ToggleStateFlagswhere
T: IntoIterator<Item = ToggleStateFlags>,
The bitwise or (|
) of the bits in each flags value.
§impl Hash for ToggleStateFlags
impl Hash for ToggleStateFlags
§impl IntoIterator for ToggleStateFlags
impl IntoIterator for ToggleStateFlags
§type Item = ToggleStateFlags
type Item = ToggleStateFlags
§type IntoIter = Iter<ToggleStateFlags>
type IntoIter = Iter<ToggleStateFlags>
§fn into_iter(self) -> <ToggleStateFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <ToggleStateFlags as IntoIterator>::IntoIter
§impl LowerHex for ToggleStateFlags
impl LowerHex for ToggleStateFlags
§impl Not for ToggleStateFlags
impl Not for ToggleStateFlags
§fn not(self) -> ToggleStateFlags
fn not(self) -> ToggleStateFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = ToggleStateFlags
type Output = ToggleStateFlags
!
operator.§impl Octal for ToggleStateFlags
impl Octal for ToggleStateFlags
§impl Ord for ToggleStateFlags
impl Ord for ToggleStateFlags
§fn cmp(&self, other: &ToggleStateFlags) -> Ordering
fn cmp(&self, other: &ToggleStateFlags) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
§impl PartialEq for ToggleStateFlags
impl PartialEq for ToggleStateFlags
§impl PartialOrd for ToggleStateFlags
impl PartialOrd for ToggleStateFlags
§impl Sub for ToggleStateFlags
impl Sub for ToggleStateFlags
§fn sub(self, other: ToggleStateFlags) -> ToggleStateFlags
fn sub(self, other: ToggleStateFlags) -> ToggleStateFlags
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.
§type Output = ToggleStateFlags
type Output = ToggleStateFlags
-
operator.§impl SubAssign for ToggleStateFlags
impl SubAssign for ToggleStateFlags
§fn sub_assign(&mut self, other: ToggleStateFlags)
fn sub_assign(&mut self, other: ToggleStateFlags)
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.
§impl TypeMarker for ToggleStateFlags
impl TypeMarker for ToggleStateFlags
§type Owned = ToggleStateFlags
type Owned = ToggleStateFlags
§fn inline_align(_context: Context) -> usize
fn inline_align(_context: Context) -> usize
§fn inline_size(_context: Context) -> usize
fn inline_size(_context: Context) -> usize
inline_align
.§fn encode_is_copy() -> bool
fn encode_is_copy() -> bool
Self::Owned
matches the FIDL wire
format and encoding requires no validation. When true, we can optimize
encoding arrays and vectors of Self::Owned
to a single memcpy. Read more§fn decode_is_copy() -> bool
fn decode_is_copy() -> bool
Self::Owned
matches the FIDL wire
format and decoding requires no validation. When true, we can optimize
decoding arrays and vectors of Self::Owned
to a single memcpy.§impl UpperHex for ToggleStateFlags
impl UpperHex for ToggleStateFlags
§impl ValueTypeMarker for ToggleStateFlags
impl ValueTypeMarker for ToggleStateFlags
§type Borrowed<'a> = ToggleStateFlags
type Borrowed<'a> = ToggleStateFlags
Encode<Self>
type cheaply obtainable from &Self::Owned
. There are three cases: Read more§fn borrow(
value: &<ToggleStateFlags as TypeMarker>::Owned,
) -> <ToggleStateFlags as ValueTypeMarker>::Borrowed<'_>
fn borrow( value: &<ToggleStateFlags as TypeMarker>::Owned, ) -> <ToggleStateFlags as ValueTypeMarker>::Borrowed<'_>
&Self::Owned
to Self::Borrowed
.