Struct ringbuf::ring_buffer::RbWriteCache

pub struct RbWriteCache<T, R: RbRef>where
    R::Rb: RbWrite<T>,{ /* private fields */ }

Caching write end of some ring buffer.

Inserted items is not visible for an opposite write end until Self::commit/Self::sync is called or Self is dropped. A free space of items removed by an opposite write end is not visible for Self until Self::sync is called.

Used to implement PostponedConsumer.

Implementations

impl<T, R: RbRef> RbWriteCache<T, R>where R::Rb: RbWrite<T>,

pub unsafe fn new(rb_ref: R) -> Self

Create new ring buffer cache.

Safety

There must be only one instance containing the same ring buffer reference.

pub fn commit(&mut self)

Commit changes to the ring buffer.

pub fn discard(&mut self)

Discard new items pushed since last sync.

pub fn sync(&mut self)

Commit changes and fetch updates from the ring buffer.

pub fn release(self) -> R

Commit and destroy Self returning underlying ring buffer.

Trait Implementations

impl<T, R: RbRef> Drop for RbWriteCache<T, R>where R::Rb: RbWrite<T>,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, R: RbRef> RbBase<T> for RbWriteCache<T, R>where R::Rb: RbWrite<T>,

unsafe fn slices( &self, head: usize, tail: usize ) -> (&mut [MaybeUninit<T>], &mut [MaybeUninit<T>])

Returns part of underlying raw ring buffer memory as slices.

fn capacity_nonzero(&self) -> NonZeroUsize

Capacity of the ring buffer.

fn head(&self) -> usize

Head position.

fn tail(&self) -> usize

Tail position.

fn modulus(&self) -> NonZeroUsize

Modulus for head and tail values.

fn occupied_len(&self) -> usize

The number of items stored in the buffer at the moment.

fn vacant_len(&self) -> usize

The number of vacant places in the buffer at the moment.

fn is_empty(&self) -> bool

Checks if the occupied range is empty.

fn is_full(&self) -> bool

Checks if the vacant range is empty.

impl<T, R: RbRef> RbWrite<T> for RbWriteCache<T, R>where R::Rb: RbWrite<T>,

unsafe fn set_tail(&self, value: usize)

Sets the new tail position.

unsafe fn advance_tail(&self, count: usize)

Move tail position by count items forward.

fn vacant_ranges(&self) -> (Range<usize>, Range<usize>)

Returns a pair of ranges of Self::vacant_slices location in underlying container.

unsafe fn vacant_slices(&self) -> (&mut [MaybeUninit<T>], &mut [MaybeUninit<T>])

Provides a direct access to the ring buffer vacant memory. Returns a pair of slices of uninitialized memory, the second one may be empty.