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

Source
use super::plumbing::*;
use super::*;

use std::fmt::{self, Debug};
use std::iter;

/// `Inspect` is an iterator that calls a function with a reference to each
/// element before yielding it.
///
/// This struct is created by the [`inspect()`] method on [`ParallelIterator`]
///
/// [`inspect()`]: ParallelIterator::inspect()
#[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
#[derive(Clone)]
pub struct Inspect<I, F> {
    base: I,
    inspect_op: F,
}

impl<I: Debug, F> Debug for Inspect<I, F> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Inspect").field("base", &self.base).finish()
    }
}

impl<I, F> Inspect<I, F> {
    /// Creates a new `Inspect` iterator.
    pub(super) fn new(base: I, inspect_op: F) -> Self {
        Inspect { base, inspect_op }
    }
}

impl<I, F> ParallelIterator for Inspect<I, F>
where
    I: ParallelIterator,
    F: Fn(&I::Item) + Sync + Send,
{
    type Item = I::Item;

    fn drive_unindexed<C>(self, consumer: C) -> C::Result
    where
        C: UnindexedConsumer<Self::Item>,
    {
        let consumer1 = InspectConsumer::new(consumer, &self.inspect_op);
        self.base.drive_unindexed(consumer1)
    }

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

impl<I, F> IndexedParallelIterator for Inspect<I, F>
where
    I: IndexedParallelIterator,
    F: Fn(&I::Item) + Sync + Send,
{
    fn drive<C>(self, consumer: C) -> C::Result
    where
        C: Consumer<Self::Item>,
    {
        let consumer1 = InspectConsumer::new(consumer, &self.inspect_op);
        self.base.drive(consumer1)
    }

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

    fn with_producer<CB>(self, callback: CB) -> CB::Output
    where
        CB: ProducerCallback<Self::Item>,
    {
        return self.base.with_producer(Callback {
            callback,
            inspect_op: self.inspect_op,
        });

        struct Callback<CB, F> {
            callback: CB,
            inspect_op: F,
        }

        impl<T, F, CB> ProducerCallback<T> for Callback<CB, F>
        where
            CB: ProducerCallback<T>,
            F: Fn(&T) + Sync,
        {
            type Output = CB::Output;

            fn callback<P>(self, base: P) -> CB::Output
            where
                P: Producer<Item = T>,
            {
                let producer = InspectProducer {
                    base,
                    inspect_op: &self.inspect_op,
                };
                self.callback.callback(producer)
            }
        }
    }
}

// ////////////////////////////////////////////////////////////////////////

struct InspectProducer<'f, P, F> {
    base: P,
    inspect_op: &'f F,
}

impl<'f, P, F> Producer for InspectProducer<'f, P, F>
where
    P: Producer,
    F: Fn(&P::Item) + Sync,
{
    type Item = P::Item;
    type IntoIter = iter::Inspect<P::IntoIter, &'f F>;

    fn into_iter(self) -> Self::IntoIter {
        self.base.into_iter().inspect(self.inspect_op)
    }

    fn min_len(&self) -> usize {
        self.base.min_len()
    }

    fn max_len(&self) -> usize {
        self.base.max_len()
    }

    fn split_at(self, index: usize) -> (Self, Self) {
        let (left, right) = self.base.split_at(index);
        (
            InspectProducer {
                base: left,
                inspect_op: self.inspect_op,
            },
            InspectProducer {
                base: right,
                inspect_op: self.inspect_op,
            },
        )
    }

    fn fold_with<G>(self, folder: G) -> G
    where
        G: Folder<Self::Item>,
    {
        let folder1 = InspectFolder {
            base: folder,
            inspect_op: self.inspect_op,
        };
        self.base.fold_with(folder1).base
    }
}

// ////////////////////////////////////////////////////////////////////////
// Consumer implementation

struct InspectConsumer<'f, C, F> {
    base: C,
    inspect_op: &'f F,
}

impl<'f, C, F> InspectConsumer<'f, C, F> {
    fn new(base: C, inspect_op: &'f F) -> Self {
        InspectConsumer { base, inspect_op }
    }
}

impl<'f, T, C, F> Consumer<T> for InspectConsumer<'f, C, F>
where
    C: Consumer<T>,
    F: Fn(&T) + Sync,
{
    type Folder = InspectFolder<'f, C::Folder, F>;
    type Reducer = C::Reducer;
    type Result = C::Result;

    fn split_at(self, index: usize) -> (Self, Self, Self::Reducer) {
        let (left, right, reducer) = self.base.split_at(index);
        (
            InspectConsumer::new(left, self.inspect_op),
            InspectConsumer::new(right, self.inspect_op),
            reducer,
        )
    }

    fn into_folder(self) -> Self::Folder {
        InspectFolder {
            base: self.base.into_folder(),
            inspect_op: self.inspect_op,
        }
    }

    fn full(&self) -> bool {
        self.base.full()
    }
}

impl<'f, T, C, F> UnindexedConsumer<T> for InspectConsumer<'f, C, F>
where
    C: UnindexedConsumer<T>,
    F: Fn(&T) + Sync,
{
    fn split_off_left(&self) -> Self {
        InspectConsumer::new(self.base.split_off_left(), self.inspect_op)
    }

    fn to_reducer(&self) -> Self::Reducer {
        self.base.to_reducer()
    }
}

struct InspectFolder<'f, C, F> {
    base: C,
    inspect_op: &'f F,
}

impl<'f, T, C, F> Folder<T> for InspectFolder<'f, C, F>
where
    C: Folder<T>,
    F: Fn(&T),
{
    type Result = C::Result;

    fn consume(self, item: T) -> Self {
        (self.inspect_op)(&item);
        InspectFolder {
            base: self.base.consume(item),
            inspect_op: self.inspect_op,
        }
    }

    fn consume_iter<I>(mut self, iter: I) -> Self
    where
        I: IntoIterator<Item = T>,
    {
        self.base = self
            .base
            .consume_iter(iter.into_iter().inspect(self.inspect_op));
        self
    }

    fn complete(self) -> C::Result {
        self.base.complete()
    }

    fn full(&self) -> bool {
        self.base.full()
    }
}

Coverage Report

Created: 2025-12-05 07:37

Line	Count	Source
1		use super::plumbing::*;
2		use super::*;
3
4		use std::fmt::{self, Debug};
5		use std::iter;
6
7		/// `Inspect` is an iterator that calls a function with a reference to each
8		/// element before yielding it.
9		///
10		/// This struct is created by the [`inspect()`] method on [`ParallelIterator`]
11		///
12		/// [`inspect()`]: ParallelIterator::inspect()
13		#[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
14		#[derive(Clone)]
15		pub struct Inspect<I, F> {
16		base: I,
17		inspect_op: F,
18		}
19
20		impl<I: Debug, F> Debug for Inspect<I, F> {
21	0	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
22	0	f.debug_struct("Inspect").field("base", &self.base).finish()
23	0	}
24		}
25
26		impl<I, F> Inspect<I, F> {
27		/// Creates a new `Inspect` iterator.
28	0	pub(super) fn new(base: I, inspect_op: F) -> Self {
29	0	Inspect { base, inspect_op }
30	0	}
31		}
32
33		impl<I, F> ParallelIterator for Inspect<I, F>
34		where
35		I: ParallelIterator,
36		F: Fn(&I::Item) + Sync + Send,
37		{
38		type Item = I::Item;
39
40	0	fn drive_unindexed<C>(self, consumer: C) -> C::Result
41	0	where
42	0	C: UnindexedConsumer<Self::Item>,
43		{
44	0	let consumer1 = InspectConsumer::new(consumer, &self.inspect_op);
45	0	self.base.drive_unindexed(consumer1)
46	0	}
47
48	0	fn opt_len(&self) -> Option<usize> {
49	0	self.base.opt_len()
50	0	}
51		}
52
53		impl<I, F> IndexedParallelIterator for Inspect<I, F>
54		where
55		I: IndexedParallelIterator,
56		F: Fn(&I::Item) + Sync + Send,
57		{
58	0	fn drive<C>(self, consumer: C) -> C::Result
59	0	where
60	0	C: Consumer<Self::Item>,
61		{
62	0	let consumer1 = InspectConsumer::new(consumer, &self.inspect_op);
63	0	self.base.drive(consumer1)
64	0	}
65
66	0	fn len(&self) -> usize {
67	0	self.base.len()
68	0	}
69
70	0	fn with_producer<CB>(self, callback: CB) -> CB::Output
71	0	where
72	0	CB: ProducerCallback<Self::Item>,
73		{
74	0	return self.base.with_producer(Callback {
75	0	callback,
76	0	inspect_op: self.inspect_op,
77	0	});
78
79		struct Callback<CB, F> {
80		callback: CB,
81		inspect_op: F,
82		}
83
84		impl<T, F, CB> ProducerCallback<T> for Callback<CB, F>
85		where
86		CB: ProducerCallback<T>,
87		F: Fn(&T) + Sync,
88		{
89		type Output = CB::Output;
90
91	0	fn callback<P>(self, base: P) -> CB::Output
92	0	where
93	0	P: Producer<Item = T>,
94		{
95	0	let producer = InspectProducer {
96	0	base,
97	0	inspect_op: &self.inspect_op,
98	0	};
99	0	self.callback.callback(producer)
100	0	}
101		}
102	0	}
103		}
104
105		// ////////////////////////////////////////////////////////////////////////
106
107		struct InspectProducer<'f, P, F> {
108		base: P,
109		inspect_op: &'f F,
110		}
111
112		impl<'f, P, F> Producer for InspectProducer<'f, P, F>
113		where
114		P: Producer,
115		F: Fn(&P::Item) + Sync,
116		{
117		type Item = P::Item;
118		type IntoIter = iter::Inspect<P::IntoIter, &'f F>;
119
120	0	fn into_iter(self) -> Self::IntoIter {
121	0	self.base.into_iter().inspect(self.inspect_op)
122	0	}
123
124	0	fn min_len(&self) -> usize {
125	0	self.base.min_len()
126	0	}
127
128	0	fn max_len(&self) -> usize {
129	0	self.base.max_len()
130	0	}
131
132	0	fn split_at(self, index: usize) -> (Self, Self) {
133	0	let (left, right) = self.base.split_at(index);
134	0	(
135	0	InspectProducer {
136	0	base: left,
137	0	inspect_op: self.inspect_op,
138	0	},
139	0	InspectProducer {
140	0	base: right,
141	0	inspect_op: self.inspect_op,
142	0	},
143	0	)
144	0	}
145
146	0	fn fold_with<G>(self, folder: G) -> G
147	0	where
148	0	G: Folder<Self::Item>,
149		{
150	0	let folder1 = InspectFolder {
151	0	base: folder,
152	0	inspect_op: self.inspect_op,
153	0	};
154	0	self.base.fold_with(folder1).base
155	0	}
156		}
157
158		// ////////////////////////////////////////////////////////////////////////
159		// Consumer implementation
160
161		struct InspectConsumer<'f, C, F> {
162		base: C,
163		inspect_op: &'f F,
164		}
165
166		impl<'f, C, F> InspectConsumer<'f, C, F> {
167	0	fn new(base: C, inspect_op: &'f F) -> Self {
168	0	InspectConsumer { base, inspect_op }
169	0	}
170		}
171
172		impl<'f, T, C, F> Consumer<T> for InspectConsumer<'f, C, F>
173		where
174		C: Consumer<T>,
175		F: Fn(&T) + Sync,
176		{
177		type Folder = InspectFolder<'f, C::Folder, F>;
178		type Reducer = C::Reducer;
179		type Result = C::Result;
180
181	0	fn split_at(self, index: usize) -> (Self, Self, Self::Reducer) {
182	0	let (left, right, reducer) = self.base.split_at(index);
183	0	(
184	0	InspectConsumer::new(left, self.inspect_op),
185	0	InspectConsumer::new(right, self.inspect_op),
186	0	reducer,
187	0	)
188	0	}
189
190	0	fn into_folder(self) -> Self::Folder {
191	0	InspectFolder {
192	0	base: self.base.into_folder(),
193	0	inspect_op: self.inspect_op,
194	0	}
195	0	}
196
197	0	fn full(&self) -> bool {
198	0	self.base.full()
199	0	}
200		}
201
202		impl<'f, T, C, F> UnindexedConsumer<T> for InspectConsumer<'f, C, F>
203		where
204		C: UnindexedConsumer<T>,
205		F: Fn(&T) + Sync,
206		{
207	0	fn split_off_left(&self) -> Self {
208	0	InspectConsumer::new(self.base.split_off_left(), self.inspect_op)
209	0	}
210
211	0	fn to_reducer(&self) -> Self::Reducer {
212	0	self.base.to_reducer()
213	0	}
214		}
215
216		struct InspectFolder<'f, C, F> {
217		base: C,
218		inspect_op: &'f F,
219		}
220
221		impl<'f, T, C, F> Folder<T> for InspectFolder<'f, C, F>
222		where
223		C: Folder<T>,
224		F: Fn(&T),
225		{
226		type Result = C::Result;
227
228	0	fn consume(self, item: T) -> Self {
229	0	(self.inspect_op)(&item);
230	0	InspectFolder {
231	0	base: self.base.consume(item),
232	0	inspect_op: self.inspect_op,
233	0	}
234	0	}
235
236	0	fn consume_iter<I>(mut self, iter: I) -> Self
237	0	where
238	0	I: IntoIterator<Item = T>,
239		{
240	0	self.base = self
241	0	.base
242	0	.consume_iter(iter.into_iter().inspect(self.inspect_op));
243	0	self
244	0	}
245
246	0	fn complete(self) -> C::Result {
247	0	self.base.complete()
248	0	}
249
250	0	fn full(&self) -> bool {
251	0	self.base.full()
252	0	}
253		}