zrx_stream/stream/barrier/advance/iter.rs
1// Copyright (c) 2025-2026 Zensical and contributors
2
3// SPDX-License-Identifier: MIT
4// All contributions are certified under the DCO
5
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to
8// deal in the Software without restriction, including without limitation the
9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23
24// ----------------------------------------------------------------------------
25
26//! Iterator implementation for [`Advance`].
27
28use zrx_scheduler::{Id, Key};
29use zrx_store::stash::{items, Items};
30use zrx_store::Stash;
31
32use super::Advance;
33
34// ----------------------------------------------------------------------------
35// Structs
36// ----------------------------------------------------------------------------
37
38/// Iterator for [`Advance`].
39pub struct Iter<'a, I> {
40 /// Inner iterator.
41 inner: items::Iter<'a>,
42 /// All known scopes.
43 stash: &'a Stash<Key<I>, Items>,
44}
45
46// ----------------------------------------------------------------------------
47// Implementations
48// ----------------------------------------------------------------------------
49
50impl<'a, I> Advance<'a, I>
51where
52 I: Id,
53{
54 /// Creates an iterator over the barrier advancement.
55 #[inline]
56 #[must_use]
57 pub fn iter(&self) -> Iter<'a, I> {
58 Iter {
59 inner: self.items.iter(),
60 stash: self.scopes,
61 }
62 }
63}
64
65// ----------------------------------------------------------------------------
66// Trait implementations
67// ----------------------------------------------------------------------------
68
69impl<'a, I> Iterator for Iter<'a, I>
70where
71 I: Id,
72{
73 type Item = &'a Key<I>;
74
75 /// Returns the next scope.
76 #[inline]
77 fn next(&mut self) -> Option<Self::Item> {
78 self.inner.next().and_then(|index| self.stash.key(index))
79 }
80}