Struct ringbahn::File

pub struct File<D: Drive = DemoDriver<'static>> { /* fields omitted */ }

A file handle that runs on io-uring

Implementations

impl File

pub fn open(path: impl AsRef<Path>) -> Open

Open a file using the default driver

pub fn create(path: impl AsRef<Path>) -> Create

Create a new file using the default driver

impl<D: Drive + Clone> File<D>

pub fn open_on_driver(path: impl AsRef<Path>, driver: D) -> Open<D>

Open a file

pub fn create_on_driver(path: impl AsRef<Path>, driver: D) -> Create<D>

Create a file

impl<D: Drive> File<D>

pub fn run_on_driver(file: File, driver: D) -> File<D>

Take an existing file and run its IO on an io-uring driver

pub fn read_buffered(&self) -> &[u8]

Access any data that has been read into the buffer, but not consumed

This is similar to the fill_buf method from AsyncBufRead, but instead of performing IO if the buffer is empty, it will just return an empty slice. This method can be used to copy out any left over buffered data before closing or performing a write.

Trait Implementations

impl<D: Drive> AsyncBufRead for File<D>

fn poll_fill_buf(self: Pin<&mut Self>, ctx: &mut Context) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to [poll_read].

impl<D: Drive> AsyncRead for File<D>

fn poll_read(
    self: Pin<&mut Self>,
    ctx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<D: Drive> AsyncSeek for File<D>

fn poll_seek(
    self: Pin<&mut Self>,
    ctx: &mut Context,
    pos: SeekFrom
) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<D: Drive> AsyncWrite for File<D>

fn poll_write(
    self: Pin<&mut Self>,
    ctx: &mut Context,
    slice: &[u8]
) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, ctx: &mut Context) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, ctx: &mut Context) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<D: Drive> Drop for File<D>

fn drop(&mut self)

Executes the destructor for this type.

impl<D: Drive> From<File<D>> for File

fn from(file: File<D>) -> File

Performs the conversion.

impl From<File> for File

fn from(file: File) -> File

Performs the conversion.