Struct ringbuf::wrap::frozen::Frozen

pub struct Frozen<R: RbRef, const P: bool, const C: bool> { /* private fields */ }

Frozen wrapper of the ring buffer.

Implementations

impl<R: RbRef, const P: bool, const C: bool> Frozen<R, P, C>

pub fn new(rb: R) -> Self

Create a new ring buffer frozen wrapper.

Panics if wrapper with matching rights already exists.

pub fn observe(&self) -> Obs<R>

Get ring buffer observer.

impl<R: RbRef, const P: bool, const C: bool> Frozen<R, P, C>

pub fn commit(&self)

Commit changes to the ring buffer.

pub fn fetch(&self)

Fetch changes from the ring buffer.

pub fn sync(&self)

Commit changes to and fetch updates from the ring buffer.

impl<R: RbRef> Frozen<R, true, false>

pub fn discard(&mut self)

Discard new items pushed since last sync.

Trait Implementations

impl<R: RbRef, const P: bool, const C: bool> AsMut<Frozen<R, P, C>> for Frozen<R, P, C>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<R: RbRef, const P: bool, const C: bool> AsRef<Frozen<R, P, C>> for Frozen<R, P, C>

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl<R: RbRef, const P: bool, const C: bool> Drop for Frozen<R, P, C>

fn drop(&mut self)

Executes the destructor for this type.

impl<R: RbRef, const P: bool, const C: bool> Observer for Frozen<R, P, C>

type Item = <<R as RbRef>::Rb as Observer>::Item

fn capacity(&self) -> NonZeroUsize

Capacity of the ring buffer.

fn read_index(&self) -> usize

Index of the last item in the ring buffer.

fn write_index(&self) -> usize

Index of the next empty slot in the ring buffer.

unsafe fn unsafe_slices( &self, start: usize, end: usize, ) -> (&[MaybeUninit<Self::Item>], &[MaybeUninit<Self::Item>])

Get slice between start and end indices.

unsafe fn unsafe_slices_mut( &self, start: usize, end: usize, ) -> (&mut [MaybeUninit<Self::Item>], &mut [MaybeUninit<Self::Item>])

Get mutable slice between start and end indices.

fn read_is_held(&self) -> bool

Whether read end is held by consumer.

fn write_is_held(&self) -> bool

Whether write end is held by producer.

fn occupied_len(&self) -> usize

The number of items stored in the buffer.

fn vacant_len(&self) -> usize

The number of remaining free places in the buffer.

fn is_empty(&self) -> bool

Checks if the ring buffer is empty.

fn is_full(&self) -> bool

Checks if the ring buffer is full.

impl<R: RbRef, const P: bool, const C: bool> Wrap for Frozen<R, P, C>

type RbRef = R

Ring buffer reference type.

fn rb_ref(&self) -> &R

Underlying ring buffer reference.

fn into_rb_ref(self) -> R

Destructure into underlying ring buffer reference.

fn rb(&self) -> &<Self::RbRef as RbRef>::Rb

Underlying ring buffer.