Struct ringbahn::Ring

pub struct Ring<IO, D = DemoDriver<'static>> { /* fields omitted */ }

A wrapper that runs a handle's IO on io-uring.

Takes any object that implements AsRawFd and runs the IO for that object on io-uring, instead of using blocking interfaces. Ring implements AsyncRead, AsyncWrite, and AsyncBufRead.

Note that using AsyncBufRead interfaces instead of AsyncRead will likely be more performant, if possible.

Implementations

impl<IO: AsRawFd, D: Drive + Default> Ring<IO, D>

pub fn new(io: IO) -> Ring<IO, D>

Construct a new Ring on the default driver

impl<IO: AsRawFd, D: Drive> Ring<IO, D>

pub fn on_driver(io: IO, driver: D) -> Ring<IO, D>

Construct a new Ring on a driver of your choice

pub fn cancel(&mut self)

Cancel interest in any ongoing IO.

Trait Implementations

impl<IO: Read + AsRawFd, D: Drive> AsyncBufRead for Ring<IO, 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<IO: Read + AsRawFd, D: Drive> AsyncRead for Ring<IO, 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<IO: Write + AsRawFd, D: Drive> AsyncWrite for Ring<IO, D>

fn poll_write(
    self: Pin<&mut Self>,
    ctx: &mut Context,
    buf: &[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.