Struct IoInitiator

pub struct IoInitiator { /* private fields */ }

Client handle for initiating IOs or spawning tasks on a specific threadpool thread.

Implementations

impl IoInitiator

pub fn probe(&self, opcode: u8) -> bool

Probes the ring for supporting a given opcode.

pub async unsafe fn issue_io<T, F>(&self, io_mem: T, f: F) -> (Result<i32>, T)

where T: 'static + Unpin, F: FnOnce(&mut T) -> Entry,

Issues an IO described by f, referencing IO memory in io_mem.

The submission queue entry for the IO is provided by f so that the IO can reference memory in the io_mem object. A reference to io_mem is passed to f after it has been pinned in memory so that it will not move for the lifetime of the IO.

Once the IO has completed, both the result and the IO memory are returned.

Safety

The caller must guarantee that f returns a submission queue entry that only references memory of static lifetime or that is part of the io_mem object passed to f.

Aborts

The process will abort if the async function is dropped before it completes. This is because the IO memory is not moved into the heap, and drop cannot synchronously wait for the IO to complete.

Trait Implementations

impl Clone for IoInitiator

fn clone(&self) -> IoInitiator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IoInitiator

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

Formats the value using the given formatter.

impl FdReadyDriver for IoInitiator

type FdReady = FdReady<IoInitiator>

The file descriptor ready type.

fn new_fd_ready(&self, fd: RawFd) -> Result<Self::FdReady>

Returns a new object for polling file descriptor readiness.

impl Initiate for IoInitiator

fn initiator(&self) -> &IoInitiator

Returns a reference to the initiator to use for IO operations.

impl Spawn for IoInitiator

fn scheduler(&self, _metadata: &TaskMetadata) -> Arc<dyn Schedule>

Gets a scheduler for a new task.

fn spawn<T>( &self, name: impl Into<Arc<str>>, fut: impl Future<Output = T> + Send + 'static, ) -> Task<T, TaskMetadata>

where T: 'static + Send, Self: Sized,

Spawns a task.

impl TimerDriver for IoInitiator

type Timer = Timer<IoInitiator>

The timer type.

fn new_timer(&self) -> Self::Timer

Returns a new timer.

impl WaitDriver for IoInitiator

type Wait = FdWait<IoInitiator>

The wait object.

fn new_wait(&self, fd: RawFd, read_size: usize) -> Result<Self::Wait>

Creates a new wait.