pub struct Enumerate<I>where
I: ConcurrentIter,{ /* private fields */ }
Expand description
An enumerated version of a concurrent iterator which additionally yields the index of elements in the source collection.
It can be created by calling enumerate
on a concurrent iterator.
§Examples
use orx_concurrent_iter::*;
let vec = vec!['x', 'y'];
let con_iter = vec.con_iter().enumerate();
assert_eq!(con_iter.next(), Some((0, &'x')));
assert_eq!(con_iter.next(), Some((1, &'y')));
assert_eq!(con_iter.next(), None);
Trait Implementations§
Source§impl<I> ConcurrentIter for Enumerate<I>where
I: ConcurrentIter,
impl<I> ConcurrentIter for Enumerate<I>where
I: ConcurrentIter,
Source§type Item = (usize, <I as ConcurrentIter>::Item)
type Item = (usize, <I as ConcurrentIter>::Item)
Type of the element that the concurrent iterator yields.
Source§type SequentialIter = Enumerate<<I as ConcurrentIter>::SequentialIter>
type SequentialIter = Enumerate<<I as ConcurrentIter>::SequentialIter>
Type of the sequential iterator that the concurrent iterator can be converted
into using the
into_seq_iter
method.Source§type ChunkPuller<'i> = EnumeratedChunkPuller<<I as ConcurrentIter>::ChunkPuller<'i>>
where
Self: 'i
type ChunkPuller<'i> = EnumeratedChunkPuller<<I as ConcurrentIter>::ChunkPuller<'i>> where Self: 'i
Type of the chunk puller that can be created using the
chunk_puller
method.Source§fn into_seq_iter(self) -> Self::SequentialIter
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. Read moreSource§fn skip_to_end(&self)
fn skip_to_end(&self)
Immediately jumps to the end of the iterator, skipping the remaining elements. Read more
Source§fn next(&self) -> Option<Self::Item>
fn next(&self) -> Option<Self::Item>
Returns the next element of the iterator.
It returns None if there are no more elements left. Read more
Source§fn next_with_idx(&self) -> Option<(usize, Self::Item)>
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. Read more
Source§fn size_hint(&self) -> (usize, Option<usize>)
fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator. Read more
Source§fn chunk_puller(&self, chunk_size: usize) -> Self::ChunkPuller<'_>
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. Read moreSource§fn try_get_len(&self) -> Option<usize>
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
. Read moreSource§fn item_puller(&self) -> ItemPuller<'_, Self> ⓘwhere
Self: Sized,
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. Read moreSource§fn item_puller_with_idx(&self) -> EnumeratedItemPuller<'_, Self> ⓘwhere
Self: Sized,
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. Read moreSource§fn copied<'a, T>(self) -> ConIterCopied<'a, Self, T>
fn copied<'a, T>(self) -> ConIterCopied<'a, Self, T>
Creates an iterator which copies all of its elements. Read more
Source§fn cloned<'a, T>(self) -> ConIterCloned<'a, Self, T>
fn cloned<'a, T>(self) -> ConIterCloned<'a, Self, T>
Creates an iterator which clones all of its elements. Read more
Auto Trait Implementations§
impl<I> Freeze for Enumerate<I>where
I: Freeze,
impl<I> RefUnwindSafe for Enumerate<I>where
I: RefUnwindSafe,
impl<I> Send for Enumerate<I>
impl<I> Sync for Enumerate<I>
impl<I> Unpin for Enumerate<I>where
I: Unpin,
impl<I> UnwindSafe for Enumerate<I>where
I: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more