Struct WorkIter

pub struct WorkIter<'buf, B: MutRB> { /* 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 Detached can be obtained by calling Self::detach.

Implementations

impl<'buf, B: MutRB<Item = T>, T> WorkIter<'buf, B>

pub fn reset_index(&mut self)

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

Trait Implementations

impl<'buf, B: MutRB + IterManager> Drop for WorkIter<'buf, B>

fn drop(&mut self)

Executes the destructor for this type.

impl<'buf, B: MutRB<Item = T>, T> MRBIterator for WorkIter<'buf, B>

type Item = T

fn available(&mut self) -> usize

Returns the number of items available for an iterator.

fn is_prod_alive(&self) -> bool

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

fn is_work_alive(&self) -> bool

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

fn is_cons_alive(&self) -> bool

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

fn prod_index(&self) -> usize

Returns the index of the producer.

fn work_index(&self) -> usize

Returns the index of the worker.

fn cons_index(&self) -> usize

Returns the index of the consumer.

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

Advances the iterator by count.

fn index(&self) -> usize

Returns the index of the iterator.

fn set_index(&mut self, index: usize)

Sets the local index.

fn buf_len(&self) -> usize

Returns the length of the buffer.

fn detach(self) -> Detached<Self>

where Self: Sized,

Detaches the iterator yielding a Detached.

fn wait_for(&mut self, count: usize)

Waits, blocking the thread in a loop, until there are at least count available items.

fn get_workable<'a>(&mut self) -> Option<&'a mut Self::Item>

Returns a mutable references to the current value.

fn get_workable_slice_exact<'a>( &mut self, count: usize, ) -> Option<(&'a mut [<Self as MRBIterator>::Item], &'a mut [<Self as MRBIterator>::Item])>

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

fn get_workable_slice_avail<'a>( &mut self, ) -> Option<(&'a mut [<Self as MRBIterator>::Item], &'a mut [<Self as MRBIterator>::Item])>

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

fn get_workable_slice_multiple_of<'a>( &mut self, rhs: usize, ) -> Option<(&'a mut [<Self as MRBIterator>::Item], &'a mut [<Self as MRBIterator>::Item])>

Returns a tuple of mutable slice references, the sum of which with len equal to the higher multiple of rhs.

impl<'buf, B: ConcurrentRB + MutRB<Item = T>, T> Send for WorkIter<'buf, B>