pub struct TxReturnFlags { /* private fields */ }
Expand description
Flags set by a Device when returning a tx buffer back to a client.
Set by Devices on the return_flags
field of a tx descriptor.
Implementations§
source§impl TxReturnFlags
impl TxReturnFlags
sourcepub const TX_RET_NOT_SUPPORTED: Self = _
pub const TX_RET_NOT_SUPPORTED: Self = _
Requested operation in inbound_flags
is not supported; the frame was
not sent.
Always set in conjunction with TX_RET_ERROR
.
sourcepub const TX_RET_OUT_OF_RESOURCES: Self = _
pub const TX_RET_OUT_OF_RESOURCES: Self = _
Could not allocate resources to send frame.
Always set in conjunction with TX_RET_ERROR
.
sourcepub const TX_RET_NOT_AVAILABLE: Self = _
pub const TX_RET_NOT_AVAILABLE: Self = _
Device is not available (offline or disconnected); the frame was not sent.
Always set in conjunction with TX_RET_ERROR
.
pub const TX_RET_ERROR: Self = _
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 TxReturnFlags
impl TxReturnFlags
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 TxReturnFlags
impl Binary for TxReturnFlags
source§impl BitAnd for TxReturnFlags
impl BitAnd for TxReturnFlags
source§impl BitAndAssign for TxReturnFlags
impl BitAndAssign for TxReturnFlags
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 TxReturnFlags
impl BitOr for TxReturnFlags
source§fn bitor(self, other: TxReturnFlags) -> Self
fn bitor(self, other: TxReturnFlags) -> Self
Returns the union of the two sets of flags.
§type Output = TxReturnFlags
type Output = TxReturnFlags
|
operator.source§impl BitOrAssign for TxReturnFlags
impl BitOrAssign for TxReturnFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for TxReturnFlags
impl BitXor for TxReturnFlags
source§impl BitXorAssign for TxReturnFlags
impl BitXorAssign for TxReturnFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for TxReturnFlags
impl Clone for TxReturnFlags
source§fn clone(&self) -> TxReturnFlags
fn clone(&self) -> TxReturnFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TxReturnFlags
impl Debug for TxReturnFlags
source§impl Decode<TxReturnFlags> for TxReturnFlags
impl Decode<TxReturnFlags> for TxReturnFlags
source§impl Default for TxReturnFlags
impl Default for TxReturnFlags
source§fn default() -> TxReturnFlags
fn default() -> TxReturnFlags
source§impl Encode<TxReturnFlags> for TxReturnFlags
impl Encode<TxReturnFlags> for TxReturnFlags
source§impl Extend<TxReturnFlags> for TxReturnFlags
impl Extend<TxReturnFlags> for TxReturnFlags
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<TxReturnFlags> for TxReturnFlags
impl FromIterator<TxReturnFlags> for TxReturnFlags
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 TxReturnFlags
impl Hash for TxReturnFlags
source§impl LowerHex for TxReturnFlags
impl LowerHex for TxReturnFlags
source§impl Not for TxReturnFlags
impl Not for TxReturnFlags
source§impl Octal for TxReturnFlags
impl Octal for TxReturnFlags
source§impl Ord for TxReturnFlags
impl Ord for TxReturnFlags
source§fn cmp(&self, other: &TxReturnFlags) -> Ordering
fn cmp(&self, other: &TxReturnFlags) -> 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 TxReturnFlags
impl PartialEq for TxReturnFlags
source§fn eq(&self, other: &TxReturnFlags) -> bool
fn eq(&self, other: &TxReturnFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for TxReturnFlags
impl PartialOrd for TxReturnFlags
source§fn partial_cmp(&self, other: &TxReturnFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &TxReturnFlags) -> 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 TxReturnFlags
impl Sub for TxReturnFlags
source§impl SubAssign for TxReturnFlags
impl SubAssign for TxReturnFlags
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 TxReturnFlags
impl TypeMarker for TxReturnFlags
§type Owned = TxReturnFlags
type Owned = TxReturnFlags
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 TxReturnFlags
impl UpperHex for TxReturnFlags
source§impl ValueTypeMarker for TxReturnFlags
impl ValueTypeMarker for TxReturnFlags
§type Borrowed<'a> = TxReturnFlags
type Borrowed<'a> = TxReturnFlags
Encode<Self>
type cheaply obtainable from &Self::Owned
. There are three cases: Read more