Struct StatusFlags
pub struct StatusFlags(/* private fields */);
Expand description
Port status bits, reported in [PortStatus.flags
].
Implementations§
§impl StatusFlags
impl StatusFlags
pub const ONLINE: StatusFlags
pub const ONLINE: StatusFlags
Port is online, i.e., data path is open and any ongoing sessions may send and receive frames.
§impl StatusFlags
impl StatusFlags
pub const fn empty() -> StatusFlags
pub const fn empty() -> StatusFlags
Get a flags value with all bits unset.
pub const fn all() -> StatusFlags
pub const fn all() -> StatusFlags
Get a flags value with all known bits set.
pub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
pub const fn from_bits(bits: u32) -> Option<StatusFlags>
pub const fn from_bits(bits: u32) -> Option<StatusFlags>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u32) -> StatusFlags
pub const fn from_bits_truncate(bits: u32) -> StatusFlags
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u32) -> StatusFlags
pub const fn from_bits_retain(bits: u32) -> StatusFlags
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<StatusFlags>
pub fn from_name(name: &str) -> Option<StatusFlags>
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: StatusFlags) -> bool
pub const fn intersects(&self, other: StatusFlags) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: StatusFlags) -> bool
pub const fn contains(&self, other: StatusFlags) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn insert(&mut self, other: StatusFlags)
pub fn insert(&mut self, other: StatusFlags)
The bitwise or (|
) of the bits in two flags values.
pub fn remove(&mut self, other: StatusFlags)
pub fn remove(&mut self, other: StatusFlags)
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: StatusFlags)
pub fn toggle(&mut self, other: StatusFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: StatusFlags, value: bool)
pub fn set(&mut self, other: StatusFlags, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: StatusFlags) -> StatusFlags
pub const fn intersection(self, other: StatusFlags) -> StatusFlags
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: StatusFlags) -> StatusFlags
pub const fn union(self, other: StatusFlags) -> StatusFlags
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: StatusFlags) -> StatusFlags
pub const fn difference(self, other: StatusFlags) -> StatusFlags
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: StatusFlags) -> StatusFlags
pub const fn symmetric_difference(self, other: StatusFlags) -> StatusFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> StatusFlags
pub const fn complement(self) -> StatusFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl StatusFlags
impl StatusFlags
pub const fn iter(&self) -> Iter<StatusFlags>
pub const fn iter(&self) -> Iter<StatusFlags>
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<StatusFlags>
pub const fn iter_names(&self) -> IterNames<StatusFlags>
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 StatusFlags
impl StatusFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u32
get_unknown_bits
Trait Implementations§
§impl Binary for StatusFlags
impl Binary for StatusFlags
§impl BitAnd for StatusFlags
impl BitAnd for StatusFlags
§fn bitand(self, other: StatusFlags) -> StatusFlags
fn bitand(self, other: StatusFlags) -> StatusFlags
The bitwise and (&
) of the bits in two flags values.
§type Output = StatusFlags
type Output = StatusFlags
&
operator.§impl BitAndAssign for StatusFlags
impl BitAndAssign for StatusFlags
§fn bitand_assign(&mut self, other: StatusFlags)
fn bitand_assign(&mut self, other: StatusFlags)
The bitwise and (&
) of the bits in two flags values.
§impl BitOr for StatusFlags
impl BitOr for StatusFlags
§fn bitor(self, other: StatusFlags) -> StatusFlags
fn bitor(self, other: StatusFlags) -> StatusFlags
The bitwise or (|
) of the bits in two flags values.
§type Output = StatusFlags
type Output = StatusFlags
|
operator.§impl BitOrAssign for StatusFlags
impl BitOrAssign for StatusFlags
§fn bitor_assign(&mut self, other: StatusFlags)
fn bitor_assign(&mut self, other: StatusFlags)
The bitwise or (|
) of the bits in two flags values.
§impl BitXor for StatusFlags
impl BitXor for StatusFlags
§fn bitxor(self, other: StatusFlags) -> StatusFlags
fn bitxor(self, other: StatusFlags) -> StatusFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = StatusFlags
type Output = StatusFlags
^
operator.§impl BitXorAssign for StatusFlags
impl BitXorAssign for StatusFlags
§fn bitxor_assign(&mut self, other: StatusFlags)
fn bitxor_assign(&mut self, other: StatusFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl Clone for StatusFlags
impl Clone for StatusFlags
§fn clone(&self) -> StatusFlags
fn clone(&self) -> StatusFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for StatusFlags
impl Debug for StatusFlags
§impl<D> Decode<StatusFlags, D> for StatusFlagswhere
D: ResourceDialect,
impl<D> Decode<StatusFlags, D> for StatusFlagswhere
D: ResourceDialect,
§fn new_empty() -> StatusFlags
fn new_empty() -> StatusFlags
Self
. The specific value does not matter,
since it will be overwritten by decode
.§impl Default for StatusFlags
impl Default for StatusFlags
§fn default() -> StatusFlags
fn default() -> StatusFlags
§impl<D> Encode<StatusFlags, D> for StatusFlagswhere
D: ResourceDialect,
impl<D> Encode<StatusFlags, D> for StatusFlagswhere
D: ResourceDialect,
§impl Extend<StatusFlags> for StatusFlags
impl Extend<StatusFlags> for StatusFlags
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = StatusFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = StatusFlags>,
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 StatusFlags
impl Flags for StatusFlags
§const FLAGS: &'static [Flag<StatusFlags>]
const FLAGS: &'static [Flag<StatusFlags>]
§fn from_bits_retain(bits: u32) -> StatusFlags
fn from_bits_retain(bits: u32) -> StatusFlags
§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<StatusFlags> for StatusFlags
impl FromIterator<StatusFlags> for StatusFlags
§fn from_iter<T>(iterator: T) -> StatusFlagswhere
T: IntoIterator<Item = StatusFlags>,
fn from_iter<T>(iterator: T) -> StatusFlagswhere
T: IntoIterator<Item = StatusFlags>,
The bitwise or (|
) of the bits in each flags value.
§impl Hash for StatusFlags
impl Hash for StatusFlags
§impl IntoIterator for StatusFlags
impl IntoIterator for StatusFlags
§type Item = StatusFlags
type Item = StatusFlags
§type IntoIter = Iter<StatusFlags>
type IntoIter = Iter<StatusFlags>
§fn into_iter(self) -> <StatusFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <StatusFlags as IntoIterator>::IntoIter
§impl LowerHex for StatusFlags
impl LowerHex for StatusFlags
§impl Not for StatusFlags
impl Not for StatusFlags
§fn not(self) -> StatusFlags
fn not(self) -> StatusFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = StatusFlags
type Output = StatusFlags
!
operator.§impl Octal for StatusFlags
impl Octal for StatusFlags
§impl Ord for StatusFlags
impl Ord for StatusFlags
§impl PartialEq for StatusFlags
impl PartialEq for StatusFlags
§impl PartialOrd for StatusFlags
impl PartialOrd for StatusFlags
§impl Sub for StatusFlags
impl Sub for StatusFlags
§fn sub(self, other: StatusFlags) -> StatusFlags
fn sub(self, other: StatusFlags) -> StatusFlags
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 = StatusFlags
type Output = StatusFlags
-
operator.§impl SubAssign for StatusFlags
impl SubAssign for StatusFlags
§fn sub_assign(&mut self, other: StatusFlags)
fn sub_assign(&mut self, other: StatusFlags)
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 StatusFlags
impl TypeMarker for StatusFlags
§type Owned = StatusFlags
type Owned = StatusFlags
§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 StatusFlags
impl UpperHex for StatusFlags
§impl ValueTypeMarker for StatusFlags
impl ValueTypeMarker for StatusFlags
§type Borrowed<'a> = StatusFlags
type Borrowed<'a> = StatusFlags
Encode<Self>
type cheaply obtainable from &Self::Owned
. There are three cases: Read more§fn borrow(
value: &<StatusFlags as TypeMarker>::Owned,
) -> <StatusFlags as ValueTypeMarker>::Borrowed<'_>
fn borrow( value: &<StatusFlags as TypeMarker>::Owned, ) -> <StatusFlags as ValueTypeMarker>::Borrowed<'_>
&Self::Owned
to Self::Borrowed
.