Struct ConIterSlice

pub struct ConIterSlice<'a, T>
where
    T: Send + Sync,
{ /* private fields */ }

Concurrent iterator of a slice.

It can be created by calling into_con_iter on a slice.

Alternatively, it can be created calling con_iter on the type that owns the slice.

Examples

use orx_concurrent_iter::*;

// &[T]: IntoConcurrentIter
let vec = vec![0, 1, 2, 3];
let slice = &vec[1..3];
let con_iter = slice.into_con_iter();
assert_eq!(con_iter.next(), Some(&1));
assert_eq!(con_iter.next(), Some(&2));
assert_eq!(con_iter.next(), None);

// Vec<T>: ConcurrentIterable
let vec = vec![1, 2];
let con_iter = vec.con_iter();
assert_eq!(con_iter.next(), Some(&1));
assert_eq!(con_iter.next(), Some(&2));
assert_eq!(con_iter.next(), None);

Trait Implementations

impl<T> Clone for ConIterSlice<'_, T>

where T: Send + Sync,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T> ConcurrentIter for ConIterSlice<'a, T>

where T: Send + Sync,

type Item = &'a T

Type of the element that the concurrent iterator yields.

type SequentialIter = Skip<Iter<'a, T>>

Type of the sequential iterator that the concurrent iterator can be converted into using the into_seq_iter method.

type ChunkPuller<'i> = ChunkPullerSlice<'i, 'a, T> where Self: 'i

Type of the chunk puller that can be created using the chunk_puller method.

fn into_seq_iter(self) -> Self::SequentialIter

Converts the concurrent iterator into its sequential regular counterpart. Note that the sequential iterator is a regular Iterator, and hence, does not have any overhead related with atomic states. Therefore, it is useful where the program decides to iterate over a single thread rather than concurrently by multiple threads.

fn skip_to_end(&self)

Immediately jumps to the end of the iterator, skipping the remaining elements.

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

Returns the next element of the iterator. It returns None if there are no more elements left.

fn next_with_idx(&self) -> Option<(usize, Self::Item)>

Returns the next element of the iterator together its index. It returns None if there are no more elements left.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn chunk_puller(&self, chunk_size: usize) -> Self::ChunkPuller<'_>

Creates a ChunkPuller from the concurrent iterator. The created chunk puller can be used to pull chunk_size elements at once from the data source, rather than pulling one by one.

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

Returns Some(x) if the number of remaining items is known with certainly and if it is equal to x.

fn item_puller(&self) -> ItemPuller<'_, Self>

where Self: Sized,

Creates a ItemPuller from the concurrent iterator. The created item puller can be used to pull elements one by one from the data source.

fn item_puller_with_idx(&self) -> EnumeratedItemPuller<'_, Self>

where Self: Sized,

Creates a EnumeratedItemPuller from the concurrent iterator. The created item puller can be used to pull elements one by one from the data source together with the index of the elements.

fn copied<'a, T>(self) -> ConIterCopied<'a, Self, T>

where T: Send + Sync + Copy, Self: ConcurrentIter<Item = &'a T> + Sized,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> ConIterCloned<'a, Self, T>

where T: Send + Sync + Clone, Self: ConcurrentIter<Item = &'a T> + Sized,

Creates an iterator which clones all of its elements.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

impl<T> Debug for ConIterSlice<'_, T>

where T: Send + Sync,

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

Formats the value using the given formatter.

impl<T> Default for ConIterSlice<'_, T>

where T: Send + Sync,

fn default() -> Self

Returns the “default value” for a type.

impl<T> ExactSizeConcurrentIter for ConIterSlice<'_, T>

where T: Send + Sync,

fn len(&self) -> usize

Returns the number remaining elements in the concurrent iterator.

fn is_empty(&self) -> bool

Returns true if there are no elements left in the concurrent iterator. Returns false otherwise.