Struct ringbuf::Consumer

pub struct Consumer<T> { /* fields omitted */ }

Consumer part of ring buffer.

Methods

impl<T: Sized> Consumer<T>

pub fn capacity(&self) -> usize

Returns capacity of the ring buffer.

pub fn is_empty(&self) -> bool

Checks if the ring buffer is empty.

pub fn is_full(&self) -> bool

Checks if the ring buffer is full.

pub fn pop(&mut self) -> Result<T, PopError>

Retrieves element from ring buffer.

On success returns element been retrieved.

impl<T: Sized + Copy> Consumer<T>

pub fn pop_slice(&mut self, elems: &mut [T]) -> Result<usize, PopError>

Retrieves elements from ring buffer into slice. Elements should be cloneable.

On success returns count of elements been retrieved from ring buffer.

impl<T: Sized> Consumer<T>

pub unsafe fn pop_access<R, E, F>(     &mut self,     f: F ) -> Result<Result<(usize, R), E>, PopAccessError> where     R: Sized,     E: Sized,     F: FnOnce(&mut [T], &mut [T]) -> Result<(usize, R), E>,

Allows to read from ring buffer memory directry.

This function is unsafe beacuse it gives access to possibly uninitialized memory and transfers responsibility of manually calling destructors

Takes a function f as argument. f takes two slices of ring buffer content (the second one may be empty). First slice contains older elements.

f should return:

• On success: pair of number of elements been read, and some arbitrary data.
• On failure: some another arbitrary data.

On success returns data returned from f.

Trait Implementations

impl WriteInto for Consumer<u8>

fn write_into(&mut self, writer: &mut dyn Write) -> Result<usize>

Write into Write instance.

impl Read for Consumer<u8>

fn read(&mut self, buffer: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

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

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where     R: Read,

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.