Struct rustix::io_uring::IoringOpFlags
source · [−]pub struct IoringOpFlags { /* private fields */ }
io_uring
only.Expand description
IO_URING_OP_*
flags for use with io_uring_probe_op
.
Implementations
sourceimpl IoringOpFlags
impl IoringOpFlags
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
.
Trait Implementations
sourceimpl Binary for IoringOpFlags
impl Binary for IoringOpFlags
sourceimpl BitAnd<IoringOpFlags> for IoringOpFlags
impl BitAnd<IoringOpFlags> for IoringOpFlags
type Output = IoringOpFlags
type Output = IoringOpFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<IoringOpFlags> for IoringOpFlags
impl BitAndAssign<IoringOpFlags> for IoringOpFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<IoringOpFlags> for IoringOpFlags
impl BitOr<IoringOpFlags> for IoringOpFlags
sourcefn bitor(self, other: IoringOpFlags) -> Self
fn bitor(self, other: IoringOpFlags) -> Self
Returns the union of the two sets of flags.
type Output = IoringOpFlags
type Output = IoringOpFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<IoringOpFlags> for IoringOpFlags
impl BitOrAssign<IoringOpFlags> for IoringOpFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<IoringOpFlags> for IoringOpFlags
impl BitXor<IoringOpFlags> for IoringOpFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = IoringOpFlags
type Output = IoringOpFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<IoringOpFlags> for IoringOpFlags
impl BitXorAssign<IoringOpFlags> for IoringOpFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for IoringOpFlags
impl Clone for IoringOpFlags
sourcefn clone(&self) -> IoringOpFlags
fn clone(&self) -> IoringOpFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for IoringOpFlags
impl Debug for IoringOpFlags
sourceimpl Default for IoringOpFlags
impl Default for IoringOpFlags
sourcefn default() -> IoringOpFlags
fn default() -> IoringOpFlags
Returns the “default value” for a type. Read more
sourceimpl Extend<IoringOpFlags> for IoringOpFlags
impl Extend<IoringOpFlags> for IoringOpFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<IoringOpFlags> for IoringOpFlags
impl FromIterator<IoringOpFlags> for IoringOpFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for IoringOpFlags
impl Hash for IoringOpFlags
sourceimpl LowerHex for IoringOpFlags
impl LowerHex for IoringOpFlags
sourceimpl Not for IoringOpFlags
impl Not for IoringOpFlags
type Output = IoringOpFlags
type Output = IoringOpFlags
The resulting type after applying the !
operator.
sourceimpl Octal for IoringOpFlags
impl Octal for IoringOpFlags
sourceimpl Ord for IoringOpFlags
impl Ord for IoringOpFlags
sourceimpl PartialEq<IoringOpFlags> for IoringOpFlags
impl PartialEq<IoringOpFlags> for IoringOpFlags
sourcefn eq(&self, other: &IoringOpFlags) -> bool
fn eq(&self, other: &IoringOpFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &IoringOpFlags) -> bool
fn ne(&self, other: &IoringOpFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<IoringOpFlags> for IoringOpFlags
impl PartialOrd<IoringOpFlags> for IoringOpFlags
sourcefn partial_cmp(&self, other: &IoringOpFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &IoringOpFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<IoringOpFlags> for IoringOpFlags
impl Sub<IoringOpFlags> for IoringOpFlags
type Output = IoringOpFlags
type Output = IoringOpFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<IoringOpFlags> for IoringOpFlags
impl SubAssign<IoringOpFlags> for IoringOpFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for IoringOpFlags
impl UpperHex for IoringOpFlags
impl Copy for IoringOpFlags
impl Eq for IoringOpFlags
impl StructuralEq for IoringOpFlags
impl StructuralPartialEq for IoringOpFlags
Auto Trait Implementations
impl RefUnwindSafe for IoringOpFlags
impl Send for IoringOpFlags
impl Sync for IoringOpFlags
impl Unpin for IoringOpFlags
impl UnwindSafe for IoringOpFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more