zrx-stream 0.0.23

// Copyright (c) 2025-2026 Zensical and contributors

// SPDX-License-Identifier: MIT
// All contributions are certified under the DCO

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

// ----------------------------------------------------------------------------

//! Barrier advancement.

use zrx_scheduler::{Id, Key};
use zrx_store::stash::Items;
use zrx_store::Stash;

mod iter;

pub use iter::Iter;

// ----------------------------------------------------------------------------
// Structs
// ----------------------------------------------------------------------------

/// Barrier advancement.
#[derive(Debug)]
pub struct Advance<'a, I> {
    /// Barrier scope for identification.
    key: &'a Key<I>,
    /// Contained scopes.
    items: &'a Items,
    /// All known scopes.
    scopes: &'a Stash<Key<I>, Items>,
}

// ----------------------------------------------------------------------------
// Implementations
// ----------------------------------------------------------------------------

impl<'a, I> Advance<'a, I> {
    /// Converts the barrier advancement into an event.
    #[must_use]
    pub fn new(
        key: &'a Key<I>, items: &'a Items, scopes: &'a Stash<Key<I>, Items>,
    ) -> Self {
        Self { key, items, scopes }
    }
}

#[allow(clippy::must_use_candidate)]
impl<I> Advance<'_, I> {
    /// Returns a reference to the scope.
    #[inline]
    pub fn scope(&self) -> &Key<I> {
        self.key
    }
}

// ----------------------------------------------------------------------------
// Trait implementations
// ----------------------------------------------------------------------------

impl<'a, I> IntoIterator for &'a Advance<'a, I>
where
    I: Id,
{
    type Item = &'a Key<I>;
    type IntoIter = Iter<'a, I>;

    /// Creates a consuming iterator over the barrier advancement.
    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}