Struct rustix::io_uring::IoringMsgringFlags
source · pub struct IoringMsgringFlags(/* private fields */);
io_uring
only.Expand description
IORING_MSG_RING_*
flags for use with io_uring_sqe
.
Implementations§
source§impl IoringMsgringFlags
impl IoringMsgringFlags
sourcepub const FLAGS_PASS: Self = _
pub const FLAGS_PASS: Self = _
IORING_MSG_RING_FLAGS_PASS
source§impl IoringMsgringFlags
impl IoringMsgringFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl IoringMsgringFlags
impl IoringMsgringFlags
sourcepub const fn iter(&self) -> Iter<IoringMsgringFlags>
pub const fn iter(&self) -> Iter<IoringMsgringFlags>
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<IoringMsgringFlags>
pub const fn iter_names(&self) -> IterNames<IoringMsgringFlags>
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 IoringMsgringFlags
impl Binary for IoringMsgringFlags
source§impl BitAnd for IoringMsgringFlags
impl BitAnd for IoringMsgringFlags
source§impl BitAndAssign for IoringMsgringFlags
impl BitAndAssign for IoringMsgringFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for IoringMsgringFlags
impl BitOr for IoringMsgringFlags
source§fn bitor(self, other: IoringMsgringFlags) -> Self
fn bitor(self, other: IoringMsgringFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = IoringMsgringFlags
type Output = IoringMsgringFlags
|
operator.source§impl BitOrAssign for IoringMsgringFlags
impl BitOrAssign for IoringMsgringFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for IoringMsgringFlags
impl BitXor for IoringMsgringFlags
source§impl BitXorAssign for IoringMsgringFlags
impl BitXorAssign for IoringMsgringFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for IoringMsgringFlags
impl Clone for IoringMsgringFlags
source§fn clone(&self) -> IoringMsgringFlags
fn clone(&self) -> IoringMsgringFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for IoringMsgringFlags
impl Debug for IoringMsgringFlags
source§impl Default for IoringMsgringFlags
impl Default for IoringMsgringFlags
source§fn default() -> IoringMsgringFlags
fn default() -> IoringMsgringFlags
source§impl Extend<IoringMsgringFlags> for IoringMsgringFlags
impl Extend<IoringMsgringFlags> for IoringMsgringFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 IoringMsgringFlags
impl Flags for IoringMsgringFlags
source§const FLAGS: &'static [Flag<IoringMsgringFlags>] = _
const FLAGS: &'static [Flag<IoringMsgringFlags>] = _
source§fn from_bits_retain(bits: u32) -> IoringMsgringFlags
fn from_bits_retain(bits: u32) -> IoringMsgringFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§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.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§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.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<IoringMsgringFlags> for IoringMsgringFlags
impl FromIterator<IoringMsgringFlags> for IoringMsgringFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for IoringMsgringFlags
impl Hash for IoringMsgringFlags
source§impl IntoIterator for IoringMsgringFlags
impl IntoIterator for IoringMsgringFlags
source§impl LowerHex for IoringMsgringFlags
impl LowerHex for IoringMsgringFlags
source§impl Not for IoringMsgringFlags
impl Not for IoringMsgringFlags
source§impl Octal for IoringMsgringFlags
impl Octal for IoringMsgringFlags
source§impl PartialEq for IoringMsgringFlags
impl PartialEq for IoringMsgringFlags
source§fn eq(&self, other: &IoringMsgringFlags) -> bool
fn eq(&self, other: &IoringMsgringFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for IoringMsgringFlags
impl PublicFlags for IoringMsgringFlags
source§impl Sub for IoringMsgringFlags
impl Sub for IoringMsgringFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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.
§type Output = IoringMsgringFlags
type Output = IoringMsgringFlags
-
operator.source§impl SubAssign for IoringMsgringFlags
impl SubAssign for IoringMsgringFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.