Struct syscall::io_uring::v1::IoUringSqeFlags

pub struct IoUringSqeFlags { /* fields omitted */ }

General flags describing a submission entry. Note that these flags are different from the syscall flags in that they describe the io_uring behavior when handling the SQE, rather than configuring the syscall.

Implementations

impl IoUringSqeFlags

pub const DRAIN: IoUringSqeFlags

Complete every command before the current command, prior to executing it.

pub const CHAIN: IoUringSqeFlags

Prevent reordering this command with the command after it.

pub const SUBSCRIBE: IoUringSqeFlags

There can be multiple completions to this submission, each with the extra parameter set to the sequence number. The completion entries share the same user data as the submission, but with a sequence number in extra if supported.

pub const DIRECT_RECV: IoUringSqeFlags

When the command completes, the current process will be awoken immediately, directly a context switch back to the kernel, rather than waiting for every other process to be scheduled first. This lowers latency a lot, especially for IRQs, but obviously takes extra system resources. Hence, it requires elevated privileges.

Note that "immediately" only applies in the userspace-to-kernel mode, since the kernel can context switch to a process whenever it likes to. In the kernel-to-userspace mode, the producer scheme will first have to call the kernel back, or if the process is dedicatedly polled by the kernel, directly after that process's CPU time. This also applies for the userspace-to-userspace scenario, with the exception that the kernel can only know when to context switch by polling.

NOTE: This flag is not implemented yet, and using it will cause ENOSYS. TODO: only for root, or a process capability?

pub const DIRECT_SEND: IoUringSqeFlags

Works similarly to DIRECT_RECV, except it context switches directly (depending on context) to the producer when sent. Also requires elevated privileges. Since the kernel will start serving the commands directly upon SYS_ENTER_IORING, doing this with userspace-to-kernel will result in EINVAL.

pub const fn empty() -> IoUringSqeFlags

Returns an empty set of flags

pub const fn all() -> IoUringSqeFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<IoUringSqeFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> IoUringSqeFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> IoUringSqeFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: IoUringSqeFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: IoUringSqeFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: IoUringSqeFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: IoUringSqeFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: IoUringSqeFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: IoUringSqeFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for IoUringSqeFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl BitAnd<IoUringSqeFlags> for IoUringSqeFlags

type Output = IoUringSqeFlags

The resulting type after applying the & operator.

fn bitand(self, other: IoUringSqeFlags) -> IoUringSqeFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<IoUringSqeFlags> for IoUringSqeFlags

fn bitand_assign(&mut self, other: IoUringSqeFlags)

Disables all flags disabled in the set.

impl BitOr<IoUringSqeFlags> for IoUringSqeFlags

type Output = IoUringSqeFlags

The resulting type after applying the | operator.

fn bitor(self, other: IoUringSqeFlags) -> IoUringSqeFlags

Returns the union of the two sets of flags.

impl BitOrAssign<IoUringSqeFlags> for IoUringSqeFlags

fn bitor_assign(&mut self, other: IoUringSqeFlags)

Adds the set of flags.

impl BitXor<IoUringSqeFlags> for IoUringSqeFlags

type Output = IoUringSqeFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: IoUringSqeFlags) -> IoUringSqeFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<IoUringSqeFlags> for IoUringSqeFlags

fn bitxor_assign(&mut self, other: IoUringSqeFlags)

Toggles the set of flags.

impl Clone for IoUringSqeFlags

fn clone(&self) -> IoUringSqeFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for IoUringSqeFlags

impl Debug for IoUringSqeFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for IoUringSqeFlags

impl Extend<IoUringSqeFlags> for IoUringSqeFlags

fn extend<T: IntoIterator<Item = IoUringSqeFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<IoUringSqeFlags> for IoUringSqeFlags

fn from_iter<T: IntoIterator<Item = IoUringSqeFlags>>(
    iterator: T
) -> IoUringSqeFlags

Creates a value from an iterator.

impl Hash for IoUringSqeFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for IoUringSqeFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Not for IoUringSqeFlags

type Output = IoUringSqeFlags

The resulting type after applying the ! operator.

fn not(self) -> IoUringSqeFlags

Returns the complement of this set of flags.

impl Octal for IoUringSqeFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Ord for IoUringSqeFlags

fn cmp(&self, other: &IoUringSqeFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<IoUringSqeFlags> for IoUringSqeFlags

fn eq(&self, other: &IoUringSqeFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IoUringSqeFlags) -> bool

This method tests for !=.

impl PartialOrd<IoUringSqeFlags> for IoUringSqeFlags

fn partial_cmp(&self, other: &IoUringSqeFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &IoUringSqeFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &IoUringSqeFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &IoUringSqeFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &IoUringSqeFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for IoUringSqeFlags

impl StructuralPartialEq for IoUringSqeFlags

impl Sub<IoUringSqeFlags> for IoUringSqeFlags

type Output = IoUringSqeFlags

The resulting type after applying the - operator.

fn sub(self, other: IoUringSqeFlags) -> IoUringSqeFlags

Returns the set difference of the two sets of flags.

impl SubAssign<IoUringSqeFlags> for IoUringSqeFlags

fn sub_assign(&mut self, other: IoUringSqeFlags)

Disables all flags enabled in the set.

impl UpperHex for IoUringSqeFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.