zrx-scheduler 0.0.2

Scheduler for workflow execution
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

// Copyright (c) 2025 Zensical and contributors

// SPDX-License-Identifier: MIT
// Third-party contributions licensed under 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.

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

//! Input.

use std::fmt;

use crate::scheduler::effect::{Item, Signal};
use crate::scheduler::value::Values;

mod convert;

pub use convert::TryFromInputItem;

// ----------------------------------------------------------------------------
// Enums
// ----------------------------------------------------------------------------

/// Input.
///
/// Inputs are short-lived containers that hold an [`Item`] with references to
/// an [`Id`][] and [`Values`] or a [`Signal`], and are designed to efficiently
/// pass arguments to an [`Action`][]. Identifiers are passed by reference, so
/// that actions can decide on their own whether cloning is necessary.
///
/// Our canonical implementation [`zrx::id`][] uses an [`Arc`][] to wrap a slice
/// of bytes, which makes cloning as cheap and fast as possible. Thus, in case
/// you don't want to roll your own identifiers, it's definitely recommended
/// to use our optimized implementation.
///
/// [`Arc`]: std::sync::Arc
/// [`Action`]: crate::scheduler::action::Action
/// [`Id`]: crate::scheduler::id::Id
/// [`zrx::id`]: https://docs.rs/zrx/latest/zrx/id/
#[derive(Clone)]
pub enum Input<'a, I> {
    /// Item.
    Item(InputItem<'a, I>),
    /// Signal.
    Signal(Signal<'a, I>),
}

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

impl<I> fmt::Debug for Input<'_, I>
where
    I: fmt::Debug,
{
    /// Formats the input for debugging.
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Input::Item(item) => item.fmt(f),
            Input::Signal(signal) => signal.fmt(f),
        }
    }
}

// ----------------------------------------------------------------------------
// Type aliases
// ----------------------------------------------------------------------------

/// Input item.
pub type InputItem<'a, I> = Item<&'a I, Values<'a>>;