Struct Writer

pub struct Writer(/* private fields */);

Write access to a nonblocking ring buffer with fixed capacity.

If there is no space in the buffer to write to, the current task is parked and notified once space becomes available.

Implementations

impl Writer

pub fn is_closed(&self) -> bool

Returns true if the writer has been closed, and will therefore no longer accept writes.

Trait Implementations

impl AsyncWrite for Writer

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Write data to the RingBuffer.

This only returns Ok(Ready(0)) if either buf.len() == 0, poll_close has been called, or if the corresponding Reader has been dropped and no more data will be read to free up space for new data.

Errors

This never emits an error.

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

Errors

This never emits an error.

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

Once closing is complete, the corresponding reader will always return Ok(Ready(0)) on poll_read once all remaining buffered data has been read.

Errors

This never emits an error.

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 Drop for Writer

fn drop(&mut self)

Executes the destructor for this type.