pub struct SessionFlags { /* private fields */ }
Expand description
Additional session options.
Implementations§
source§impl SessionFlags
impl SessionFlags
sourcepub const PRIMARY: Self = _
pub const PRIMARY: Self = _
Attach as primary session.
Sessions marked with the PRIMARY
bit get the following different
treatment:
- If no PRIMARY sessions are attached, the device will not serve rx frames to non-PRIMARY sessions.
- If there’s only one PRIMARY session active, it may get a zero-copy data path from the the backing hardware, if the underlying implementation supports it.
sourcepub const LISTEN_TX: Self = _
pub const LISTEN_TX: Self = _
Listen for outgoing frames.
LISTEN_TX
sessions receive any outgoing frames (from all sessions) on
its rx path. Can be used for snooping traffic. Sessions marked with
LISTEN_TX
may also send frames, but they should keep in mind that
they’ll ALWAYS receive those frames back on their rx path (no origin
session filtering is performed).
sourcepub const REPORT_INVALID_RX: Self = _
pub const REPORT_INVALID_RX: Self = _
Receive invalid rx frames.
Sessions marked with REPORT_INVALID_RX
are interested in receiving
frames that were rejected by internal device checks or payload
validation performed by hardware. Due to the nature of some hardware
platforms, sessions marked with REPORT_INVALID_RX
may still not
receive frames that fail validation if the hardware implementation
simply drops the frame and doesn’t expose it to the software stack.
Sessions NOT marked with REPORT_INVALID_RX
, in contrast, will NEVER
receive an rx frame with the RX_VALIDATION_ERROR
flag set.
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 SessionFlags
impl SessionFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u16
get_unknown_bits
Trait Implementations§
source§impl Binary for SessionFlags
impl Binary for SessionFlags
source§impl BitAnd for SessionFlags
impl BitAnd for SessionFlags
source§impl BitAndAssign for SessionFlags
impl BitAndAssign for SessionFlags
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 SessionFlags
impl BitOr for SessionFlags
source§fn bitor(self, other: SessionFlags) -> Self
fn bitor(self, other: SessionFlags) -> Self
Returns the union of the two sets of flags.
§type Output = SessionFlags
type Output = SessionFlags
|
operator.source§impl BitOrAssign for SessionFlags
impl BitOrAssign for SessionFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for SessionFlags
impl BitXor for SessionFlags
source§impl BitXorAssign for SessionFlags
impl BitXorAssign for SessionFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for SessionFlags
impl Clone for SessionFlags
source§fn clone(&self) -> SessionFlags
fn clone(&self) -> SessionFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SessionFlags
impl Debug for SessionFlags
source§impl Decode<SessionFlags> for SessionFlags
impl Decode<SessionFlags> for SessionFlags
source§impl Default for SessionFlags
impl Default for SessionFlags
source§fn default() -> SessionFlags
fn default() -> SessionFlags
source§impl Encode<SessionFlags> for SessionFlags
impl Encode<SessionFlags> for SessionFlags
source§impl Extend<SessionFlags> for SessionFlags
impl Extend<SessionFlags> for SessionFlags
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<SessionFlags> for SessionFlags
impl FromIterator<SessionFlags> for SessionFlags
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 SessionFlags
impl Hash for SessionFlags
source§impl LowerHex for SessionFlags
impl LowerHex for SessionFlags
source§impl Not for SessionFlags
impl Not for SessionFlags
source§impl Octal for SessionFlags
impl Octal for SessionFlags
source§impl Ord for SessionFlags
impl Ord for SessionFlags
source§fn cmp(&self, other: &SessionFlags) -> Ordering
fn cmp(&self, other: &SessionFlags) -> 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 SessionFlags
impl PartialEq for SessionFlags
source§fn eq(&self, other: &SessionFlags) -> bool
fn eq(&self, other: &SessionFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for SessionFlags
impl PartialOrd for SessionFlags
source§fn partial_cmp(&self, other: &SessionFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &SessionFlags) -> 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 SessionFlags
impl Sub for SessionFlags
source§impl SubAssign for SessionFlags
impl SubAssign for SessionFlags
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 SessionFlags
impl TypeMarker for SessionFlags
§type Owned = SessionFlags
type Owned = SessionFlags
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 SessionFlags
impl UpperHex for SessionFlags
source§impl ValueTypeMarker for SessionFlags
impl ValueTypeMarker for SessionFlags
§type Borrowed<'a> = SessionFlags
type Borrowed<'a> = SessionFlags
Encode<Self>
type cheaply obtainable from &Self::Owned
. There are three cases: Read more