Struct ringbuf::Producer

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

Producer part of ring buffer.

Methods

impl<T: Sized> Producer<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 push(&mut self, elem: T) -> Result<(), (PushError, T)>

Pushes element into ring buffer.

On error returns pair of error and element that wasn't pushed.

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

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

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

On success returns count of elements been pushed into ring buffer.

impl<T: Sized> Producer<T>

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

Allows to write into 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 written, and some arbitrary data.
• On failure: some another arbitrary data.

On success returns data returned from f.

Trait Implementations

impl ReadFrom for Producer<u8>

fn read_from(&mut self, reader: &mut dyn Read) -> Result<usize>

Read from Read instance.

impl Write for Producer<u8>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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