pub struct AtRestFlags(/* private fields */);
Expand description
Bitflags type for transaction header at-rest flags.
Implementations§
Source§impl AtRestFlags
impl AtRestFlags
Sourcepub const USE_V2_WIRE_FORMAT: AtRestFlags
pub const USE_V2_WIRE_FORMAT: AtRestFlags
Indicates that the V2 wire format should be used instead of the V1 wire format. This includes the following RFCs:
- Efficient envelopes
- Inlining small values in FIDL envelopes
Source§impl AtRestFlags
impl AtRestFlags
Sourcepub const fn empty() -> AtRestFlags
pub const fn empty() -> AtRestFlags
Get a flags value with all bits unset.
Sourcepub const fn all() -> AtRestFlags
pub const fn all() -> AtRestFlags
Get a flags value with all known bits set.
Sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u16) -> Option<AtRestFlags>
pub const fn from_bits(bits: u16) -> Option<AtRestFlags>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u16) -> AtRestFlags
pub const fn from_bits_truncate(bits: u16) -> AtRestFlags
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u16) -> AtRestFlags
pub const fn from_bits_retain(bits: u16) -> AtRestFlags
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<AtRestFlags>
pub fn from_name(name: &str) -> Option<AtRestFlags>
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.
Sourcepub const fn intersects(&self, other: AtRestFlags) -> bool
pub const fn intersects(&self, other: AtRestFlags) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: AtRestFlags) -> bool
pub const fn contains(&self, other: AtRestFlags) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn insert(&mut self, other: AtRestFlags)
pub fn insert(&mut self, other: AtRestFlags)
The bitwise or (|
) of the bits in two flags values.
Sourcepub fn remove(&mut self, other: AtRestFlags)
pub fn remove(&mut self, other: AtRestFlags)
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.
Sourcepub fn toggle(&mut self, other: AtRestFlags)
pub fn toggle(&mut self, other: AtRestFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: AtRestFlags, value: bool)
pub fn set(&mut self, other: AtRestFlags, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: AtRestFlags) -> AtRestFlags
pub const fn intersection(self, other: AtRestFlags) -> AtRestFlags
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: AtRestFlags) -> AtRestFlags
pub const fn union(self, other: AtRestFlags) -> AtRestFlags
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: AtRestFlags) -> AtRestFlags
pub const fn difference(self, other: AtRestFlags) -> AtRestFlags
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.
Sourcepub const fn symmetric_difference(self, other: AtRestFlags) -> AtRestFlags
pub const fn symmetric_difference(self, other: AtRestFlags) -> AtRestFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> AtRestFlags
pub const fn complement(self) -> AtRestFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl AtRestFlags
impl AtRestFlags
Sourcepub const fn iter(&self) -> Iter<AtRestFlags>
pub const fn iter(&self) -> Iter<AtRestFlags>
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.
Sourcepub const fn iter_names(&self) -> IterNames<AtRestFlags>
pub const fn iter_names(&self) -> IterNames<AtRestFlags>
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.
Trait Implementations§
Source§impl Binary for AtRestFlags
impl Binary for AtRestFlags
Source§impl BitAnd for AtRestFlags
impl BitAnd for AtRestFlags
Source§fn bitand(self, other: AtRestFlags) -> AtRestFlags
fn bitand(self, other: AtRestFlags) -> AtRestFlags
The bitwise and (&
) of the bits in two flags values.
Source§type Output = AtRestFlags
type Output = AtRestFlags
&
operator.Source§impl BitAndAssign for AtRestFlags
impl BitAndAssign for AtRestFlags
Source§fn bitand_assign(&mut self, other: AtRestFlags)
fn bitand_assign(&mut self, other: AtRestFlags)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for AtRestFlags
impl BitOr for AtRestFlags
Source§fn bitor(self, other: AtRestFlags) -> AtRestFlags
fn bitor(self, other: AtRestFlags) -> AtRestFlags
The bitwise or (|
) of the bits in two flags values.
Source§type Output = AtRestFlags
type Output = AtRestFlags
|
operator.Source§impl BitOrAssign for AtRestFlags
impl BitOrAssign for AtRestFlags
Source§fn bitor_assign(&mut self, other: AtRestFlags)
fn bitor_assign(&mut self, other: AtRestFlags)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for AtRestFlags
impl BitXor for AtRestFlags
Source§fn bitxor(self, other: AtRestFlags) -> AtRestFlags
fn bitxor(self, other: AtRestFlags) -> AtRestFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§type Output = AtRestFlags
type Output = AtRestFlags
^
operator.Source§impl BitXorAssign for AtRestFlags
impl BitXorAssign for AtRestFlags
Source§fn bitxor_assign(&mut self, other: AtRestFlags)
fn bitxor_assign(&mut self, other: AtRestFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for AtRestFlags
impl Clone for AtRestFlags
Source§fn clone(&self) -> AtRestFlags
fn clone(&self) -> AtRestFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AtRestFlags
impl Debug for AtRestFlags
Source§impl Extend<AtRestFlags> for AtRestFlags
impl Extend<AtRestFlags> for AtRestFlags
Source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = AtRestFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = AtRestFlags>,
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
)Source§impl Flags for AtRestFlags
impl Flags for AtRestFlags
Source§const FLAGS: &'static [Flag<AtRestFlags>]
const FLAGS: &'static [Flag<AtRestFlags>]
Source§fn from_bits_retain(bits: u16) -> AtRestFlags
fn from_bits_retain(bits: u16) -> AtRestFlags
§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.Source§impl FromIterator<AtRestFlags> for AtRestFlags
impl FromIterator<AtRestFlags> for AtRestFlags
Source§fn from_iter<T>(iterator: T) -> AtRestFlagswhere
T: IntoIterator<Item = AtRestFlags>,
fn from_iter<T>(iterator: T) -> AtRestFlagswhere
T: IntoIterator<Item = AtRestFlags>,
The bitwise or (|
) of the bits in each flags value.
Source§impl Hash for AtRestFlags
impl Hash for AtRestFlags
Source§impl IntoIterator for AtRestFlags
impl IntoIterator for AtRestFlags
Source§type Item = AtRestFlags
type Item = AtRestFlags
Source§type IntoIter = Iter<AtRestFlags>
type IntoIter = Iter<AtRestFlags>
Source§fn into_iter(self) -> <AtRestFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <AtRestFlags as IntoIterator>::IntoIter
Source§impl LowerHex for AtRestFlags
impl LowerHex for AtRestFlags
Source§impl Not for AtRestFlags
impl Not for AtRestFlags
Source§fn not(self) -> AtRestFlags
fn not(self) -> AtRestFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§type Output = AtRestFlags
type Output = AtRestFlags
!
operator.Source§impl Octal for AtRestFlags
impl Octal for AtRestFlags
Source§impl Ord for AtRestFlags
impl Ord for AtRestFlags
Source§fn cmp(&self, other: &AtRestFlags) -> Ordering
fn cmp(&self, other: &AtRestFlags) -> 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 AtRestFlags
impl PartialEq for AtRestFlags
Source§impl PartialOrd for AtRestFlags
impl PartialOrd for AtRestFlags
Source§impl Sub for AtRestFlags
impl Sub for AtRestFlags
Source§fn sub(self, other: AtRestFlags) -> AtRestFlags
fn sub(self, other: AtRestFlags) -> AtRestFlags
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.
Source§type Output = AtRestFlags
type Output = AtRestFlags
-
operator.Source§impl SubAssign for AtRestFlags
impl SubAssign for AtRestFlags
Source§fn sub_assign(&mut self, other: AtRestFlags)
fn sub_assign(&mut self, other: AtRestFlags)
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.