zrx-scheduler 0.0.18

// 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.

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

//! Step.

use crate::scheduler::engine::Tag;

pub mod effect;
pub mod error;
mod macros;
mod scoped;
mod set;

use effect::Effect;
pub use error::{Error, Result};
pub use scoped::Scoped;
pub use set::{IntoSteps, Steps};

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

/// Step.
#[derive(Debug)]
pub struct Step<I, C = ()> {
    /// Scoped identifier .
    pub scoped: Scoped<I>,
    /// Effect.
    pub effect: Effect<I, C>,
}

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

impl<I, C> Step<I, C> {
    /// Creates a step.
    #[must_use]
    pub fn new(scoped: Scoped<I>, effect: Effect<I, C>) -> Self {
        Self { scoped, effect }
    }
}

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

impl<I, C> Tag<I, C> for Step<I, C> {
    type Target<T> = Step<I, T>;

    /// Tags the step with the given type.
    #[inline]
    fn tag<T>(self) -> Self::Target<T> {
        Step {
            scoped: self.scoped,
            effect: self.effect.tag(),
        }
    }
}