Struct fidl_fuchsia_hardware_network::RxFlags
source · pub struct RxFlags { /* private fields */ }
Expand description
Flags set by a Device when handing a buffer to a client on the rx path.
Set by devices on the inbound_flags
field of an rx descriptor.
Implementations§
source§impl RxFlags
impl RxFlags
sourcepub const RX_ACCEL_0: Self = _
pub const RX_ACCEL_0: Self = _
Acceleration flag 0.
Acceleration flags are mapped to the acceleration features reported by
the [Device
] in [Info.rx_accel
]. The n-th feature in rx_accel
maps
to the RX_ACCEL_n
RxFlag
.
pub const RX_ACCEL_1: Self = _
pub const RX_ACCEL_2: Self = _
pub const RX_ACCEL_3: Self = _
pub const RX_ACCEL_4: Self = _
pub const RX_ACCEL_5: Self = _
pub const RX_ACCEL_6: Self = _
pub const RX_ACCEL_7: Self = _
pub const RX_ACCEL_8: Self = _
pub const RX_ACCEL_9: Self = _
pub const RX_ACCEL_10: Self = _
pub const RX_ACCEL_11: Self = _
pub const RX_ACCEL_12: Self = _
pub const RX_ACCEL_13: Self = _
pub const RX_ACCEL_14: Self = _
pub const RX_ACCEL_15: Self = _
sourcepub const RX_OVERRUN: Self = _
pub const RX_OVERRUN: Self = _
Device experienced a hardware rx overrun.
Rx overruns are typically set by hardware controllers when a frame event was detected but the frame data couldn’t be captured. Devices should clear the controller flag once this is set on an inbound frame, so future overruns can be detected and reported.
sourcepub const RX_VALIDATION_ERROR: Self = _
pub const RX_VALIDATION_ERROR: Self = _
This bit is set if frame validation is performed (such as by hardware acceleration features) and fails.
It’s important to note that some devices may simply discard frames for
which validation fails and never notify the client. Rx frames that
failed validation are only transmitted to the client if the
SessionFlags::REPORT_INVALID_RX
option is selected when creating a
session.
sourcepub const RX_ECHOED_TX: Self = _
pub const RX_ECHOED_TX: Self = _
This is an echoed tx frame, created by a tx request.
Can only be set in sessions that have the LISTEN_TX
flag.
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 RxFlags
impl RxFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u32
get_unknown_bits
Trait Implementations§
source§impl BitAndAssign for RxFlags
impl BitAndAssign for RxFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign for RxFlags
impl BitOrAssign for RxFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign for RxFlags
impl BitXorAssign for RxFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Decode<RxFlags> for RxFlags
impl Decode<RxFlags> for RxFlags
source§impl Extend<RxFlags> for RxFlags
impl Extend<RxFlags> for RxFlags
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<RxFlags> for RxFlags
impl FromIterator<RxFlags> for RxFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for RxFlags
impl Ord for RxFlags
source§impl PartialEq for RxFlags
impl PartialEq for RxFlags
source§impl PartialOrd for RxFlags
impl PartialOrd for RxFlags
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 SubAssign for RxFlags
impl SubAssign for RxFlags
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 RxFlags
impl TypeMarker for RxFlags
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.