Struct mutringbuf::iterators::sync_iterators::cons_iter::ConsIter

pub struct ConsIter<B: MutRB, const W: bool> { /* private fields */ }

Iterator used to pop data from the buffer.

When working with types which implement both Copy and Clone traits, copy methods should be preferred over clone methods.

Implementations

impl<B: MutRB<Item = T>, T, const W: bool> ConsIter<B, W>

pub fn is_prod_alive(&self) -> bool

Returns true if the producer iterator is still alive, false if it has been dropped.

pub fn is_work_alive(&self) -> bool

Returns true if the worker iterator is still alive, false if it has been dropped.

Note: when the buffer is used in non-mutable mode this will always return false.

pub fn reset_index(&mut self)

Resets the index of the iterator. I.e., moves the iterator to the location occupied by its successor.

pub fn peek_ref<'a>(&mut self) -> Option<&'a T>

Returns a reference to an element.

Being this a reference, Self::advance() has to be called when done with the data in order to move the iterator.

pub fn peek_slice<'a>(&mut self, count: usize) -> Option<(&'a [T], &'a [T])>

Returns a tuple of slice references, the sum of which with len equal to count.

Being these references, Self::advance() has to be called when done with the data in order to move the iterator.

pub fn peek_available<'a>(&mut self) -> Option<(&'a [T], &'a [T])>

Returns a tuple of slice references, the sum of which with len equal to available data.

Being these references, Self::advance() has to be called when done with the data in order to move the iterator.

pub unsafe fn pop(&mut self) -> Option<T>

Tries to pop an element, moving it.

Safety

This items moves items, so locations from which they are moved out are left uninitialised. These locations must be re-initialised used proper ProdIter methods (*_init) ones

pub fn copy_item(&mut self, dst: &mut T) -> Option<()>

where T: Copy,

• Returns Some(()), copying next item into dst, if available.
• Returns None doing nothing, otherwise.

This method uses copy and should be preferred over clone version, if possible.

Unlike peek* methods, this one automatically advances the iterator.

pub fn clone_item(&mut self, dst: &mut T) -> Option<()>

where T: Clone,

Same as Self::copy_item, but uses clone, instead.

Unlike peek* methods, this one automatically advances the iterator.

pub fn copy_slice(&mut self, dst: &mut [T]) -> Option<()>

where T: Copy,

• Returns Some(()), filling dst slice with the next dst.len() values, if available.
• Returns None doing nothing, otherwise.

This method fills the slice using copy and should be preferred over clone version, if possible.

Unlike peek* methods, this one automatically advances the iterator.

pub fn clone_slice(&mut self, dst: &mut [T]) -> Option<()>

where T: Clone,

Same as Self::copy_slice, but uses clone, instead.

Unlike peek* methods, this one automatically advances the iterator.

Trait Implementations

impl<B: MutRB + IterManager, const W: bool> Drop for ConsIter<B, W>

fn drop(&mut self)

Executes the destructor for this type.

impl<B: MutRB<Item = T>, T, const W: bool> MRBIterator<T> for ConsIter<B, W>

fn available(&mut self) -> usize

Returns the number of items available for an iterator.

unsafe fn advance(&mut self, count: usize)

Advances the iterator by count.

fn index(&self) -> usize

Returns the index of the iterator.

fn buf_len(&self) -> usize

Returns the length of the buffer.

impl<B: ConcurrentRB + MutRB<Item = T>, T, const W: bool> Send for ConsIter<B, W>