Struct ReadView 

pub struct ReadView<'a, T, PW: OptionalWaiter, CW: OptionalWaiter> {
    pub slices: (&'a mut [T], &'a mut [T]),
    /* private fields */
}

Ring buffer available contents, as two slices.

The two slices are similar to how VecDeque::to_slices work - when concatenated, they contain the available contents of the buffer at the time of calling.

After the contents have been examined, you may call consume or consume_all to remove the items from the buffer and free up their slots for the producer.

Fields

slices: (&'a mut [T], &'a mut [T])

Implementations

impl<'a, T, PW: OptionalWaiter, CW: OptionalWaiter> ReadView<'a, T, PW, CW>

pub fn consume(self, amnt: usize)

Consumes the first amnt items from the buffer, dropping them and freeing the slots for the producer to fill.

amnt is clamped to the number of items in this view.

pub fn consume_all(self)

Consumes all items in this view from the buffer.

pub fn iter(&mut self) -> Chain<IterMut<'_, T>, IterMut<'_, T>>

Iterates through each available element, in order.

Equivalent to chaining the two slice’s iterators.

pub fn is_empty(&self) -> bool

Checks if the view is empty.

Equivalent to testing if the first slices is empty. If the first slice is empty, the second one will be as well.

pub fn len(&self) -> usize

Gets how many items are in the view.

This is the sum of the lengths of the two slices.

pub fn get(&self, i: usize) -> Option<&T>

Gets an item from the view, at the i’th place, or None if out of bounds.

Mimics slice::get.

Trait Implementations

impl<'a, T, PW: OptionalWaiter, CW: OptionalWaiter> Deref for ReadView<'a, T, PW, CW>

type Target = (&'a mut [T], &'a mut [T])

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T, PW: OptionalWaiter, CW: OptionalWaiter> DerefMut for ReadView<'a, T, PW, CW>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T, PW: OptionalWaiter, CW: OptionalWaiter> Index<usize> for ReadView<'a, T, PW, CW>

type Output = T

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.