Struct UringSource

pub struct UringSource<F: AsRawDescriptor> {
    registered_source: RegisteredSource,
    source: F,
}

UringSource wraps FD backed IO sources for use with io_uring. It is a thin wrapper around registering an IO source with the uring that provides an IoSource implementation.

Fields

registered_source: RegisteredSource

source: F

Implementations

impl<F: AsRawDescriptor> UringSource<F>

pub fn new( io_source: F, ex: &Arc<RawExecutor<UringReactor>>, ) -> Result<UringSource<F>>

Creates a new UringSource that wraps the given io_source object.

pub async fn read_to_vec( &self, file_offset: Option<u64>, vec: Vec<u8>, ) -> AsyncResult<(usize, Vec<u8>)>

Reads from the iosource at file_offset and fill the given vec.

pub async fn wait_readable(&self) -> AsyncResult<()>

Wait for the FD of self to be readable.

pub async fn read_to_mem( &self, file_offset: Option<u64>, mem: Arc<dyn BackingMemory + Send + Sync>, mem_offsets: impl IntoIterator<Item = MemRegion>, ) -> AsyncResult<usize>

Reads to the given mem at the given offsets from the file starting at file_offset.

pub async fn write_from_vec( &self, file_offset: Option<u64>, vec: Vec<u8>, ) -> AsyncResult<(usize, Vec<u8>)>

Writes from the given vec to the file starting at file_offset.

pub async fn write_from_mem( &self, file_offset: Option<u64>, mem: Arc<dyn BackingMemory + Send + Sync>, mem_offsets: impl IntoIterator<Item = MemRegion>, ) -> AsyncResult<usize>

Writes from the given mem from the given offsets to the file starting at file_offset.

pub async fn punch_hole(&self, file_offset: u64, len: u64) -> AsyncResult<()>

Deallocates the given range of a file.

pub async fn write_zeroes_at( &self, file_offset: u64, len: u64, ) -> AsyncResult<()>

Fills the given range with zeroes.

pub async fn fsync(&self) -> AsyncResult<()>

Sync all completed write operations to the backing storage.

pub async fn fdatasync(&self) -> AsyncResult<()>

Sync all data of completed write operations to the backing storage. Currently, the implementation is equivalent to fsync.

pub fn into_source(self) -> F

Yields the underlying IO source.

pub fn as_source(&self) -> &F

Provides a mutable ref to the underlying IO source.

pub fn as_source_mut(&mut self) -> &mut F

Provides a ref to the underlying IO source.

Trait Implementations

impl<F: AsRawDescriptor> Deref for UringSource<F>

type Target = F

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<F: AsRawDescriptor> DerefMut for UringSource<F>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.