Struct Consumer 

pub struct Consumer<'a> { /* private fields */ }

Reads data previously written to the buffer.

Returned by crate::init. Use Consumer::read to get a GrantR for accessing the buffered data, then call GrantR::release to mark bytes as consumed.

With the async-await feature, use Consumer::wait_for_data to asynchronously wait for new data to be available.

Implementations

impl Consumer<'_>

pub fn is_empty(&self) -> bool

Returns true if there is no data available to read.

pub fn read(&mut self) -> GrantR<'_, '_>

Read data from the buffer.

If the data available to read crosses the end of the ring, this function may provide a smaller slice. Only after releasing the data up to the end of the ring will the next call provide more data.

pub async fn wait_for_data(&mut self)

Waits until there is data in the Consumer.

Trait Implementations

impl Send for Consumer<'_>