Struct mutringbuf::iterators::impls::work_iter::WorkIter

pub struct WorkIter<B: MutRB<T>, T, A> { /* private fields */ }

Iterator used to mutate elements in-place.

This iterator returns mutable references to data stored within the buffer. Thus, as stated in the docs below, Self::advance has to be called when done with the mutation in order to move the iterator.

Self::advance updates a global iterator, which is read by the consumer to decide if it can move on. To avoid this, a DetachedWorkIter can be obtained by calling Self::detach.

Implementations

impl<B: MutRB<T>, T, A> WorkIter<B, T, A>

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_cons_alive(&self) -> bool

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

pub fn detach(self) -> DetachedWorkIter<B, T, A>

Detaches the iterator yielding a DetachedWorkIter.

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 get_workable(&mut self) -> Option<(&mut T, &mut A)>

Returns a tuple containing mutable references to actual value and accumulator.

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

pub fn get_workable_slice_exact( &mut self, count: usize ) -> Option<WorkableSlice<'_, T, A>>

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

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

pub fn get_workable_slice_avail(&mut self) -> Option<WorkableSlice<'_, T, A>>

Returns a tuple of mutable slice references, the sum of which with len equal to Self::available(), along with accumulator.

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

pub fn get_workable_slice_multiple_of( &mut self, rhs: usize ) -> Option<WorkableSlice<'_, T, A>>

Returns a tuple of mutable slice references, the sum of which with len equal to the maximum multiple of modulo, along with accumulator.

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

Trait Implementations

impl<B: MutRB<T> + IterManager, T, A> Drop for WorkIter<B, T, A>

fn drop(&mut self)

Executes the destructor for this type.

impl<B: MutRB<T>, T, A> MRBIterator<T> for WorkIter<B, T, A>

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<T>, T, A> Send for WorkIter<B, T, A>