Module rustix::io_uring

source ·
Available on crate feature io_uring only.
Expand description

Linux io_uring.

This API is very low-level. The main adaptations it makes from the raw Linux io_uring API are the use of appropriately-sized bitflags, enum, Result, OwnedFd, AsFd, RawFd, and *mut c_void in place of plain integers.

Safety

io_uring operates on raw pointers and raw file descriptors. Rustix does not attempt to provide a safe API for these, because the abstraction level is too low for this to be practical. Safety should be introduced in higher-level abstraction layers.

References

Structs

IoringCqFlags
IORING_CQ_* flags.
IoringCqeFlags
IORING_CQE_F_* flags for use with io_uring_cqe.
IoringEnterFlags
IORING_ENTER_* flags for use with io_uring_enter.
IoringFeatureFlags
IORING_FEAT_* flags for use with io_uring_params.
IoringFsyncFlags
IORING_FSYNC_* flags for use with io_uring_sqe.
IoringOpFlags
IO_URING_OP_* flags for use with io_uring_probe_op.
IoringPollFlags
IORING_POLL_* flags.
IoringSetupFlags
IORING_SETUP_* flags for use with io_uring_params.
IoringSqFlags
IORING_SQ_* flags.
IoringSqeFlags
IOSQE_* flags for use with io_uring_sqe.
IoringTimeoutFlags
IORING_TIMEOUT_* and IORING_LINK_TIMEOUT_UPDATE flags for use with io_uring_sqe.
SpliceFlags
SPLICE_F_* flags for use with io_uring_sqe.
io_cqring_offsets
io_sqring_offsets
io_uring_cqe
An io_uring Completion Queue Entry.
io_uring_files_update
io_uring_getevents_arg
io_uring_params
io_uring_probe
io_uring_probe_op
io_uring_ptr
A pointer in the io_uring API.
io_uring_restriction
io_uring_rsrc_register
io_uring_rsrc_update
io_uring_rsrc_update2
io_uring_sqe
An io_uring Submission Queue Entry.
iovec
open_how

Enums

IoringOp
IORING_OP_* constants for use with io_uring_sqe.
IoringRegisterOp
IORING_REGISTER_* and IORING_UNREGISTER_* constants for use with io_uring_register.
IoringRestrictionOp
IORING_RESTRICTION_* constants for use with io_uring_restriction.

Constants

IORING_CQE_BUFFER_SHIFT
IORING_OFF_CQ_RING
IORING_OFF_SQES
IORING_OFF_SQ_RING

Functions

io_uring_enter⚠
io_uring_enter(fd, to_submit, min_complete, flags, arg, size)—Initiate and/or complete asynchronous I/O.
io_uring_register⚠
io_uring_register(fd, opcode, arg, nr_args)—Register files or user buffers for asynchronous I/O.
io_uring_register_files_skip
IORING_REGISTER_FILES_SKIP
io_uring_setup
io_uring_setup(entries, params)—Setup a context for performing asynchronous I/O.

Unions

addr_or_splice_off_in_union
buf_union
io_uring_user_data
User data in the io_uring API.
off_or_addr2_union
op_flags_union
register_or_sqe_op_or_sqe_flags_union
splice_fd_in_or_file_index_union