/rust/registry/src/index.crates.io-1949cf8c6b5b557f/rayon-1.11.0/src/delegate.rs

Source
//! Macros for delegating newtype iterators to inner types.

// Note: these place `impl` bounds at the end, as token gobbling is the only way
// I know how to consume an arbitrary list of constraints, with `$($args:tt)*`.

/// Creates a parallel iterator implementation which simply wraps an inner type
/// and delegates all methods inward.  The actual struct must already be
/// declared with an `inner` field.
///
/// The implementation of `IntoParallelIterator` should be added separately.
macro_rules! delegate_iterator {
    ($iter:ty => $item:ty ,
     impl $( $args:tt )*
     ) => {
        impl $( $args )* ParallelIterator for $iter {
            type Item = $item;

            fn drive_unindexed<C>(self, consumer: C) -> C::Result
                where C: UnindexedConsumer<Self::Item>
            {
                self.inner.drive_unindexed(consumer)
            }

            fn opt_len(&self) -> Option<usize> {
                self.inner.opt_len()
            }
        }
    }
}

/// Creates an indexed parallel iterator implementation which simply wraps an
/// inner type and delegates all methods inward.  The actual struct must already
/// be declared with an `inner` field.
macro_rules! delegate_indexed_iterator {
    ($iter:ty => $item:ty ,
     impl $( $args:tt )*
     ) => {
        delegate_iterator!{
            $iter => $item ,
            impl $( $args )*
        }

        impl $( $args )* IndexedParallelIterator for $iter {
            fn drive<C>(self, consumer: C) -> C::Result
                where C: Consumer<Self::Item>
            {
                self.inner.drive(consumer)
            }

            fn len(&self) -> usize {
                self.inner.len()
            }

            fn with_producer<CB>(self, callback: CB) -> CB::Output
                where CB: ProducerCallback<Self::Item>
            {
                self.inner.with_producer(callback)
            }
        }
    }
}

#[test]
fn unindexed_example() {
    use crate::collections::btree_map::IntoIter;
    use crate::iter::plumbing::*;
    use crate::prelude::*;

    use std::collections::BTreeMap;

    struct MyIntoIter<T: Ord + Send, U: Send> {
        inner: IntoIter<T, U>,
    }

    delegate_iterator! {
        MyIntoIter<T, U> => (T, U),
        impl<T: Ord + Send, U: Send>
    }

    let map = BTreeMap::from([(1, 'a'), (2, 'b'), (3, 'c')]);
    let iter = MyIntoIter {
        inner: map.into_par_iter(),
    };
    let vec: Vec<_> = iter.map(|(k, _)| k).collect();
    assert_eq!(vec, &[1, 2, 3]);
}

#[test]
fn indexed_example() {
    use crate::iter::plumbing::*;
    use crate::prelude::*;
    use crate::vec::IntoIter;

    struct MyIntoIter<T: Send> {
        inner: IntoIter<T>,
    }

    delegate_indexed_iterator! {
        MyIntoIter<T> => T,
        impl<T: Send>
    }

    let iter = MyIntoIter {
        inner: vec![1, 2, 3].into_par_iter(),
    };
    let mut vec = vec![];
    iter.collect_into_vec(&mut vec);
    assert_eq!(vec, &[1, 2, 3]);
}

Line	Count	Source
1		//! Macros for delegating newtype iterators to inner types.
2
3		// Note: these place `impl` bounds at the end, as token gobbling is the only way
4		// I know how to consume an arbitrary list of constraints, with `$($args:tt)*`.
5
6		/// Creates a parallel iterator implementation which simply wraps an inner type
7		/// and delegates all methods inward. The actual struct must already be
8		/// declared with an `inner` field.
9		///
10		/// The implementation of `IntoParallelIterator` should be added separately.
11		macro_rules! delegate_iterator {
12		($iter:ty => $item:ty ,
13		impl $( $args:tt )*
14		) => {
15		impl $( $args )* ParallelIterator for $iter {
16		type Item = $item;
17
18	0	fn drive_unindexed<C>(self, consumer: C) -> C::Result
19	0	where C: UnindexedConsumer<Self::Item>
20		{
21	0	self.inner.drive_unindexed(consumer)
22	0	} Unexecuted instantiation: <rayon::option::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::option::IterMut<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::result::IntoIter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::result::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::result::IterMut<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::binary_heap::IntoIter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::binary_heap::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::linked_list::IntoIter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::linked_list::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::linked_list::IterMut<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_map::IntoIter<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_map::Iter<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_map::IterMut<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_map::Drain<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_set::IntoIter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_set::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::hash_set::Drain<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::btree_map::IntoIter<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::btree_map::Iter<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::btree_map::IterMut<_, _> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::btree_set::IntoIter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::btree_set::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::vec_deque::IntoIter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::vec_deque::Iter<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_> Unexecuted instantiation: <rayon::collections::vec_deque::IterMut<_> as rayon::iter::ParallelIterator>::drive_unindexed::<_>
23
24	0	fn opt_len(&self) -> Option<usize> {
25	0	self.inner.opt_len()
26	0	} Unexecuted instantiation: <rayon::option::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::option::IterMut<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::result::IntoIter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::result::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::result::IterMut<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::binary_heap::IntoIter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::binary_heap::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::linked_list::IntoIter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::linked_list::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::linked_list::IterMut<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_map::IntoIter<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_map::Iter<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_map::IterMut<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_map::Drain<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_set::IntoIter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_set::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::hash_set::Drain<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::btree_map::IntoIter<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::btree_map::Iter<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::btree_map::IterMut<_, _> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::btree_set::IntoIter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::btree_set::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::vec_deque::IntoIter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::vec_deque::Iter<_> as rayon::iter::ParallelIterator>::opt_len Unexecuted instantiation: <rayon::collections::vec_deque::IterMut<_> as rayon::iter::ParallelIterator>::opt_len
27		}
28		}
29		}
30
31		/// Creates an indexed parallel iterator implementation which simply wraps an
32		/// inner type and delegates all methods inward. The actual struct must already
33		/// be declared with an `inner` field.
34		macro_rules! delegate_indexed_iterator {
35		($iter:ty => $item:ty ,
36		impl $( $args:tt )*
37		) => {
38		delegate_iterator!{
39		$iter => $item ,
40		impl $( $args )*
41		}
42
43		impl $( $args )* IndexedParallelIterator for $iter {
44	0	fn drive<C>(self, consumer: C) -> C::Result
45	0	where C: Consumer<Self::Item>
46		{
47	0	self.inner.drive(consumer)
48	0	} Unexecuted instantiation: <rayon::option::Iter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::option::IterMut<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::result::IntoIter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::result::Iter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::result::IterMut<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::collections::binary_heap::IntoIter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::collections::binary_heap::Iter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::collections::vec_deque::IntoIter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::collections::vec_deque::Iter<_> as rayon::iter::IndexedParallelIterator>::drive::<_> Unexecuted instantiation: <rayon::collections::vec_deque::IterMut<_> as rayon::iter::IndexedParallelIterator>::drive::<_>
49
50	0	fn len(&self) -> usize {
51	0	self.inner.len()
52	0	} Unexecuted instantiation: <rayon::option::Iter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::option::IterMut<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::result::IntoIter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::result::Iter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::result::IterMut<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::collections::binary_heap::IntoIter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::collections::binary_heap::Iter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::collections::vec_deque::IntoIter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::collections::vec_deque::Iter<_> as rayon::iter::IndexedParallelIterator>::len Unexecuted instantiation: <rayon::collections::vec_deque::IterMut<_> as rayon::iter::IndexedParallelIterator>::len
53
54	0	fn with_producer<CB>(self, callback: CB) -> CB::Output
55	0	where CB: ProducerCallback<Self::Item>
56		{
57	0	self.inner.with_producer(callback)
58	0	} Unexecuted instantiation: <rayon::option::Iter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::option::IterMut<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::result::IntoIter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::result::Iter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::result::IterMut<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::collections::binary_heap::IntoIter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::collections::binary_heap::Iter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::collections::vec_deque::IntoIter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::collections::vec_deque::Iter<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_> Unexecuted instantiation: <rayon::collections::vec_deque::IterMut<_> as rayon::iter::IndexedParallelIterator>::with_producer::<_>
59		}
60		}
61		}
62
63		#[test]
64		fn unindexed_example() {
65		use crate::collections::btree_map::IntoIter;
66		use crate::iter::plumbing::*;
67		use crate::prelude::*;
68
69		use std::collections::BTreeMap;
70
71		struct MyIntoIter<T: Ord + Send, U: Send> {
72		inner: IntoIter<T, U>,
73		}
74
75		delegate_iterator! {
76		MyIntoIter<T, U> => (T, U),
77		impl<T: Ord + Send, U: Send>
78		}
79
80		let map = BTreeMap::from([(1, 'a'), (2, 'b'), (3, 'c')]);
81		let iter = MyIntoIter {
82		inner: map.into_par_iter(),
83		};
84		let vec: Vec<_> = iter.map(\|(k, _)\| k).collect();
85		assert_eq!(vec, &[1, 2, 3]);
86		}
87
88		#[test]
89		fn indexed_example() {
90		use crate::iter::plumbing::*;
91		use crate::prelude::*;
92		use crate::vec::IntoIter;
93
94		struct MyIntoIter<T: Send> {
95		inner: IntoIter<T>,
96		}
97
98		delegate_indexed_iterator! {
99		MyIntoIter<T> => T,
100		impl<T: Send>
101		}
102
103		let iter = MyIntoIter {
104		inner: vec![1, 2, 3].into_par_iter(),
105		};
106		let mut vec = vec![];
107		iter.collect_into_vec(&mut vec);
108		assert_eq!(vec, &[1, 2, 3]);
109		}

Coverage Report

Created: 2025-10-12 08:06