Struct async_ringbuffer::Reader

pub struct Reader(_);

Read access to a nonblocking ring buffer with fixed capacity.

If there is no data in the buffer to read from, the current task is parked and notified once data becomes available.

Methods

impl Reader

pub fn is_closed(&self) -> bool

Returns true if the writer side of the ringbuffer has been closed. Reads will continue to produce data as long as there are still unread bytes in the ringbuffer.

Trait Implementations

impl Drop for Reader

fn drop(&mut self)

Executes the destructor for this type.

impl AsyncRead for Reader

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

Read data from the RingBuffer.

This only returns Ok(Ready(0)) if either buf.len() == 0, poll_close was called on the corresponding Writer and all buffered data has been read, or if the corresponding Writer has been dropped.

Errors

This never emits an error.

unsafe fn initializer(&self) -> Initializer

Determines if this AsyncReader can work with buffers of uninitialized memory.

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

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