pub struct StatusFlags { /* private fields */ }
Expand description
Port status bits, reported in [PortStatus.flags
].
Implementations§
source§impl StatusFlags
impl StatusFlags
sourcepub const ONLINE: Self = _
pub const ONLINE: Self = _
Port is online, i.e., data path is open and any ongoing sessions may send and receive frames.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§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§
source§impl Binary for StatusFlags
impl Binary for StatusFlags
source§impl BitAnd for StatusFlags
impl BitAnd for StatusFlags
source§impl BitAndAssign for StatusFlags
impl BitAndAssign for StatusFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for StatusFlags
impl BitOr for StatusFlags
source§fn bitor(self, other: StatusFlags) -> Self
fn bitor(self, other: StatusFlags) -> Self
Returns the union of the two sets of flags.
§type Output = StatusFlags
type Output = StatusFlags
|
operator.source§impl BitOrAssign for StatusFlags
impl BitOrAssign for StatusFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for StatusFlags
impl BitXor for StatusFlags
source§impl BitXorAssign for StatusFlags
impl BitXorAssign for StatusFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for StatusFlags
impl Clone for StatusFlags
source§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 moresource§impl Debug for StatusFlags
impl Debug for StatusFlags
source§impl Decode<StatusFlags> for StatusFlags
impl Decode<StatusFlags> for StatusFlags
source§impl Default for StatusFlags
impl Default for StatusFlags
source§fn default() -> StatusFlags
fn default() -> StatusFlags
source§impl Encode<StatusFlags> for StatusFlags
impl Encode<StatusFlags> for StatusFlags
source§impl Extend<StatusFlags> for StatusFlags
impl Extend<StatusFlags> for StatusFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<StatusFlags> for StatusFlags
impl FromIterator<StatusFlags> for StatusFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for StatusFlags
impl Hash for StatusFlags
source§impl LowerHex for StatusFlags
impl LowerHex for StatusFlags
source§impl Not for StatusFlags
impl Not for StatusFlags
source§impl Octal for StatusFlags
impl Octal for StatusFlags
source§impl Ord for StatusFlags
impl Ord for StatusFlags
source§fn cmp(&self, other: &StatusFlags) -> Ordering
fn cmp(&self, other: &StatusFlags) -> 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 StatusFlags
impl PartialEq for StatusFlags
source§fn eq(&self, other: &StatusFlags) -> bool
fn eq(&self, other: &StatusFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for StatusFlags
impl PartialOrd for StatusFlags
source§fn partial_cmp(&self, other: &StatusFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StatusFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for StatusFlags
impl Sub for StatusFlags
source§impl SubAssign for StatusFlags
impl SubAssign for StatusFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl TypeMarker for StatusFlags
impl TypeMarker for StatusFlags
§type Owned = StatusFlags
type Owned = StatusFlags
source§fn inline_align(_context: Context) -> usize
fn inline_align(_context: Context) -> usize
source§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.source§impl UpperHex for StatusFlags
impl UpperHex for StatusFlags
source§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