zrx_stream/stream/
workflow.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//! Workflow.
27
28use zrx_scheduler::Schedule;
29
30mod builder;
31
32pub use builder::Builder;
33
34// ----------------------------------------------------------------------------
35// Structs
36// ----------------------------------------------------------------------------
37
38/// Workflow.
39#[derive(Debug)]
40pub struct Workflow<I> {
41    /// Schedule.
42    schedule: Schedule<I>,
43}
44
45// ----------------------------------------------------------------------------
46// Trait implementations
47// ----------------------------------------------------------------------------
48
49impl<I> From<Workflow<I>> for Schedule<I> {
50    /// Creates a schedule from a workflow.
51    #[inline]
52    fn from(workflow: Workflow<I>) -> Self {
53        workflow.schedule
54    }
55}
56
57// ----------------------------------------------------------------------------
58
59impl<I> Default for Workflow<I> {
60    /// Creates an empty workflow.
61    ///
62    /// While an empty workflow is not very useful, it's sometimes practical as
63    /// a placeholder in documentation, and in types implementing [`Default`].
64    #[inline]
65    fn default() -> Self {
66        Self { schedule: Schedule::default() }
67    }
68}
zrx_stream/stream/workflow.rs

zrx_stream/stream/
workflow.rs
