Struct orx_concurrent_iter::ConIterOfRange
source · pub struct ConIterOfRange<Idx>where
Idx: Send + Sync + Clone + Copy + From<usize> + Into<usize> + Add<Idx, Output = Idx> + Sub<Idx, Output = Idx> + Ord,
Range<Idx>: Iterator<Item = Idx>,{ /* private fields */ }
Expand description
A concurrent iterator over a slice yielding references to the elements.
Implementations§
Trait Implementations§
source§impl<Idx> AtomicIter<Idx> for ConIterOfRange<Idx>
impl<Idx> AtomicIter<Idx> for ConIterOfRange<Idx>
source§fn counter(&self) -> &AtomicCounter
fn counter(&self) -> &AtomicCounter
Returns a reference to the underlying advanced item counter.
source§fn progress_and_get_begin_idx(&self, number_to_fetch: usize) -> Option<usize>
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. Read moresource§fn get(&self, item_idx: usize) -> Option<Idx>
fn get(&self, item_idx: usize) -> Option<Idx>
Returns the
item_idx
-th item that the iterator yields; returns None if the iterator completes before.source§fn fetch_n(
&self,
n: usize,
) -> Option<NextChunk<Idx, impl ExactSizeIterator<Item = Idx>>>
fn fetch_n( &self, n: usize, ) -> Option<NextChunk<Idx, impl ExactSizeIterator<Item = Idx>>>
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.source§fn early_exit(&self)
fn early_exit(&self)
Skips all remaining elements of the iterator and assumes that the end of the iterator is reached. Read more
source§impl<Idx> AtomicIterWithInitialLen<Idx> for ConIterOfRange<Idx>
impl<Idx> AtomicIterWithInitialLen<Idx> for ConIterOfRange<Idx>
source§fn initial_len(&self) -> usize
fn initial_len(&self) -> usize
Returns the initial length of the atomic iterator.
source§impl<Idx> Clone for ConIterOfRange<Idx>
impl<Idx> Clone for ConIterOfRange<Idx>
source§fn clone(&self) -> ConIterOfRange<Idx>
fn clone(&self) -> ConIterOfRange<Idx>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<Idx> ConcurrentIter for ConIterOfRange<Idx>
impl<Idx> ConcurrentIter for ConIterOfRange<Idx>
source§fn into_seq_iter(self) -> Self::SeqIter
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 range = 0..1024;
let con_iter = range.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);
}
§type BufferedIter = BufferedRange
type BufferedIter = BufferedRange
Type of the buffered iterator returned by the
chunk_iter
method when elements are fetched in chunks by each thread.§type SeqIter = Range<Idx>
type SeqIter = Range<Idx>
Inner type which is the source of the data to be iterated, which in addition is a regular sequential
Iterator
.source§fn next_id_and_value(&self) -> Option<Next<Self::Item>>
fn next_id_and_value(&self) -> Option<Next<Self::Item>>
Advances the iterator and returns the next value together with its enumeration index. Read more
source§fn next_chunk(
&self,
chunk_size: usize,
) -> Option<NextChunk<Self::Item, impl ExactSizeIterator<Item = Self::Item>>>
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. Read moresource§fn buffered_iter(
&self,
chunk_size: usize,
) -> BufferedIter<'_, Self::Item, Self::BufferedIter>
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
. Read moresource§fn try_get_len(&self) -> Option<usize>
fn try_get_len(&self) -> Option<usize>
Returns Some of the remaining length of the iterator if it is known; returns None otherwise.
source§fn skip_to_end(&self)
fn skip_to_end(&self)
Skips all remaining elements of the iterator and assumes that the end of the iterator is reached. Read more
source§fn next(&self) -> Option<Self::Item>
fn next(&self) -> Option<Self::Item>
Advances the iterator and returns the next value. Read more
source§fn values(&self) -> ConIterValues<'_, Self> ⓘwhere
Self: Sized,
fn values(&self) -> ConIterValues<'_, Self> ⓘwhere
Self: Sized,
Returns an
Iterator
over the values of elements of the concurrent iterator. Read moresource§fn ids_and_values(&self) -> ConIterIdsAndValues<'_, Self> ⓘwhere
Self: Sized,
fn ids_and_values(&self) -> ConIterIdsAndValues<'_, Self> ⓘwhere
Self: Sized,
Returns an
Iterator
over the ids and values of elements of the concurrent iterator. Read moresource§fn for_each<Fun: FnMut(Self::Item)>(&self, chunk_size: usize, fun: Fun)where
Self: Sized,
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. Read moresource§fn enumerate_for_each<Fun: FnMut(usize, Self::Item)>(
&self,
chunk_size: usize,
fun: Fun,
)where
Self: Sized,
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. Read moresource§impl<Idx> Debug for ConIterOfRange<Idx>
impl<Idx> Debug for ConIterOfRange<Idx>
source§impl<Idx> ExactSizeConcurrentIter for ConIterOfRange<Idx>
impl<Idx> ExactSizeConcurrentIter for ConIterOfRange<Idx>
source§impl<Idx> From<Range<Idx>> for ConIterOfRange<Idx>
impl<Idx> From<Range<Idx>> for ConIterOfRange<Idx>
impl<Idx> Send for ConIterOfRange<Idx>
impl<Idx> Sync for ConIterOfRange<Idx>
Auto Trait Implementations§
impl<Idx> !Freeze for ConIterOfRange<Idx>
impl<Idx> RefUnwindSafe for ConIterOfRange<Idx>where
Idx: RefUnwindSafe,
impl<Idx> Unpin for ConIterOfRange<Idx>where
Idx: Unpin,
impl<Idx> UnwindSafe for ConIterOfRange<Idx>where
Idx: 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