zrx-stream 0.0.23

Stream interface
Documentation
// 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.

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

//! Workflow.

use zrx_scheduler::Schedule;

mod builder;

pub use builder::Builder;

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

/// Workflow.
#[derive(Debug)]
pub struct Workflow<I> {
    /// Schedule.
    schedule: Schedule<I>,
}

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

impl<I> From<Workflow<I>> for Schedule<I> {
    /// Creates a schedule from a workflow.
    #[inline]
    fn from(workflow: Workflow<I>) -> Self {
        workflow.schedule
    }
}

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

impl<I> Default for Workflow<I> {
    /// Creates an empty workflow.
    ///
    /// While an empty workflow is not very useful, it's sometimes practical as
    /// a placeholder in documentation, and in types implementing [`Default`].
    #[inline]
    fn default() -> Self {
        Self { schedule: Schedule::default() }
    }
}