Struct orx_concurrent_iter::ConIterOfVec

pub struct ConIterOfVec<T: Send + Sync + Default> { /* private fields */ }

A concurrent iterator over a vector, consuming the vector and yielding its elements.

Implementations

impl<T: Send + Sync + Default> ConIterOfVec<T>

pub fn new(vec: Vec<T>) -> Self

Consumes and creates a concurrent iterator of the given vec.

Trait Implementations

impl<T: Send + Sync + Default> AtomicIter<T> for ConIterOfVec<T>

fn counter(&self) -> &AtomicCounter

Returns a reference to the underlying advanced item counter.

fn progress_and_get_begin_idx(&self, number_to_fetch: usize) -> Option<usize>

Progresses the atomic counter by number_to_fetch elements and returns the beginning index of the elements to be fetched. Returns None if the iterator is terminated and there are no more elements to be fetched.

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

Returns the item_idx-th item that the iterator yields; returns None if the iterator completes before.

fn fetch_n( &self, n: usize, ) -> Option<NextChunk<T, impl ExactSizeIterator<Item = T>>>

Returns an iterator of the next n consecutive items that the iterator yields. It might return an iterator of less or no items if the iteration does not have sufficient elements left.

fn early_exit(&self)

Skips all remaining elements of the iterator and assumes that the end of the iterator is reached.

fn fetch_one(&self) -> Option<Next<T>>

Returns the next item that the iterator yields; returns None if the iteration has completed.

impl<T: Send + Sync + Default> AtomicIterWithInitialLen<T> for ConIterOfVec<T>

fn initial_len(&self) -> usize

Returns the initial length of the atomic iterator.

impl<T: Send + Sync + Default> ConcurrentIter for ConIterOfVec<T>

fn into_seq_iter(self) -> Self::SeqIter

Converts the concurrent iterator back to the original wrapped type which is the source of the elements to be iterated. Already progressed elements are skipped.

Examples

use orx_concurrent_iter::*;

let vec: Vec<_> = (0..1024).map(|x| x.to_string()).collect();
let con_iter = vec.into_con_iter();

std::thread::scope(|s| {
    s.spawn(|| {
        for _ in 0..42 {
            _ = con_iter.next();
        }

        let mut buffered = con_iter.buffered_iter(32);
        let _chunk = buffered.next().unwrap();
    });
});

let num_used = 42 + 32;

// converts the remaining elements into a sequential iterator
let seq_iter = con_iter.into_seq_iter();

assert_eq!(seq_iter.len(), 1024 - num_used);
for (i, x) in seq_iter.enumerate() {
    assert_eq!(x, (num_used + i).to_string());
}

type Item = T

Type of the items that the iterator yields.

type BufferedIter = BufferedVec

Type of the buffered iterator returned by the chunk_iter method when elements are fetched in chunks by each thread.

type SeqIter = Skip<IntoIter<T>>

Inner type which is the source of the data to be iterated, which in addition is a regular sequential Iterator.

fn next_id_and_value(&self) -> Option<Next<Self::Item>>

Advances the iterator and returns the next value together with its enumeration index.

fn next_chunk( &self, chunk_size: usize, ) -> Option<NextChunk<Self::Item, impl ExactSizeIterator<Item = Self::Item>>>

Advances the iterator chunk_size times and returns an iterator of at most chunk_size consecutive next values. Further, the beginning enumeration index of the yielded values is returned.

fn buffered_iter( &self, chunk_size: usize, ) -> BufferedIter<'_, Self::Item, Self::BufferedIter>

Creates an iterator which pulls elements from this iterator as chunks of the given chunk_size.

fn try_get_len(&self) -> Option<usize>

Returns Some of the remaining length of the iterator if it is known; returns None otherwise.

fn skip_to_end(&self)

Skips all remaining elements of the iterator and assumes that the end of the iterator is reached.

fn next(&self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn values(&self) -> ConIterValues<'_, Self>

where Self: Sized,

Returns an Iterator over the values of elements of the concurrent iterator.

fn ids_and_values(&self) -> ConIterIdsAndValues<'_, Self>

where Self: Sized,

Returns an Iterator over the ids and values of elements of the concurrent iterator.

fn for_each<Fun: FnMut(Self::Item)>(&self, chunk_size: usize, fun: Fun)

where Self: Sized,

Applies the function fun to each element of the iterator concurrently.

fn enumerate_for_each<Fun: FnMut(usize, Self::Item)>( &self, chunk_size: usize, fun: Fun, )

where Self: Sized,

Applies the function fun to each index and corresponding element of the iterator concurrently.

fn fold<B, Fold>(&self, chunk_size: usize, neutral: B, fold: Fold) -> B

where Fold: FnMut(B, Self::Item) -> B, Self: Sized,

Folds the elements of the iterator pulled concurrently using fold function.

fn has_more(&self) -> HasMore

Returns whether or not the concurrent iterator has more elements to yield.

impl<T: Debug + Send + Sync + Default> Debug for ConIterOfVec<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Send + Sync + Default> ExactSizeConcurrentIter for ConIterOfVec<T>

fn len(&self) -> usize

Returns the exact remaining length of the concurrent iterator.

fn is_empty(&self) -> bool

Returns true if the iterator is empty.

impl<T: Send + Sync + Default> From<Vec<T>> for ConIterOfVec<T>

fn from(vec: Vec<T>) -> Self

Consumes and creates a concurrent iterator of the given vec.

impl<T: Send + Sync + Default> Send for ConIterOfVec<T>

impl<T: Send + Sync + Default> Sync for ConIterOfVec<T>