Struct syscall::io_uring::v1::SqEntry64

#[repr(C, align(64))]pub struct SqEntry64 {
    pub opcode: u8,
    pub flags: u8,
    pub priority: u16,
    pub syscall_flags: u32,
    pub fd: u64,
    pub len: u64,
    pub user_data: u64,
    pub addr: u64,
    pub offset: u64,
    pub additional1: u64,
    pub additional2: u64,
}

A 64-bit Submission Queue Entry, representing a syscall to submit. Takes up 128 bytes of space. Implements Ord by comparing priority, so that they can be stored in BinaryHeap. This entry type is only meant to be used on 64-bit platforms.

Fields

opcode: u8

An opcode with varying definitions; by default it is one of StandardOpcode, which takes values in the 0..=127 range, unless special flags are set during initialization. In the userspace-to-kernel mode, it can also be one of KernelOpcode. Similarly, for userspace-to-userspace, the consumer and producer are free to use other opcodes above 127 for custom opcodes.

This field belongs to the "implicit fields".

flags: u8

Flags specifying how the submission is going to be executed, and etc.

This field belongs to the "implicit fields".

priority: u16

The priority of the syscall; higher priorities may cause the syscall to be reordererd with lower priority syscalls.

This field belongs to the "implicit fields".

syscall_flags: u32

Specific to the opcode, but usually bitflags.

fd: u64

Specific to the opcode, but usually a file descriptor to operate on.

len: u64

Specific to the opcode, but usually the length of a buffer, or number of items.

user_data: u64

A custom value that is simply passed on to the completion entry, allowing completions to be distinguished between each other, and mapped to their corresponding submissions.

This field belongs to the "implicit fields".

addr: u64

Specific to the syscall, but usually an address to a buffer.

offset: u64

Specific to the syscall, and can be used for many different purposes.

additional1: u64

Extends the syscall with 64 additional bits of information, and is not included for SqEntry32.

additional2: u64

Like additional1, extends the syscall with 64 additional bits of information, and is not included for SqEntry32.

Implementations

impl SqEntry64

pub fn linked(self) -> Self

pub fn unlinked(self) -> Self

pub fn drain_first(self) -> Self

pub fn dont_drain_first(self) -> Self

pub fn with_priority(self, priority: u16) -> Self

pub fn with_user_data(self, user_data: u64) -> Self

pub fn new(flags: IoUringSqeFlags, priority: u16, user_data: u64) -> Self

pub fn open(self, path: &[u8], open_flags: u64) -> Self

pub fn write(self, fd: u64, buf: &[u8]) -> Self

pub fn pwrite(self, fd: u64, buf: &[u8], offset: u64) -> Self

pub fn writev(self, fd: u64, vecs: &[IoVec]) -> Self

pub fn pwritev(self, fd: u64, vecs: &[IoVec], offset: u64) -> Self

pub fn read(self, fd: u64, buf: &mut [u8]) -> Self

pub fn pread(self, fd: u64, buf: &mut [u8], offset: u64) -> Self

pub fn readv(self, fd: u64, vecs: &[IoVec]) -> Self

pub fn preadv(self, fd: u64, vecs: &[IoVec], offset: u64) -> Self

pub fn file_update(self, fd: u64, on: EventFlags, oneshot: bool) -> Self

pub fn files_update(self, fds: &[u64], on: EventFlags, oneshot: bool) -> Self

pub fn close_many(self, start_fd: u64, count: u64, flush: bool) -> Self

pub fn close(self, fd: u64, flush: bool) -> Self

Trait Implementations

impl Clone for SqEntry64

fn clone(&self) -> SqEntry64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SqEntry64

impl Debug for SqEntry64

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

Formats the value using the given formatter.

impl Default for SqEntry64

fn default() -> SqEntry64

Returns the "default value" for a type.

impl Eq for SqEntry64

impl GenericSubmissionEntry for SqEntry64

fn opcode(&self) -> u8

fn sqe_flags(&self) -> u8

fn priority(&self) -> u16

fn syscall_flags(&self) -> u32

fn len_raw(&self) -> Either<u32, u64>

fn user_data_raw(&self) -> Either<u32, u64>

fn fd_raw(&self) -> Either<u32, u64>

fn addr_raw(&self) -> Either<u32, u64>

fn offset(&self) -> u64

impl Hash for SqEntry64

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 Ord for SqEntry64

fn cmp(&self, other: &Self) -> 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<SqEntry64> for SqEntry64

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

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

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

This method tests for !=.

impl PartialOrd<SqEntry64> for SqEntry64

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for SqEntry64

impl StructuralPartialEq for SqEntry64