zrx-scheduler 0.0.18

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

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

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

//! Queues.

use crossbeam::channel::Receiver;

mod tasks;
mod timers;

pub use tasks::Tasks;
pub use timers::Timers;

// ----------------------------------------------------------------------------
// Traits
// ----------------------------------------------------------------------------

/// Borrow as [`Receiver`].
pub trait AsReceiver<I> {
    /// Item type returned by receiver.
    type Item;

    /// Borrows as a receiver of items.
    fn as_receiver(&self) -> &Receiver<Self::Item>;
}

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

/// Token.
///
/// Tokens are positional markers, that represent a specific frontier and node
/// within that frontier. They track the execution state of the scheduler, which
/// is necessary to resolve asynchronous effects like [`Timer`][] and [`Task`][]
/// and associate them with the correct frontier and node.
///
/// [`Timer`]: crate::scheduler::step::effect::Timer
/// [`Task`]: crate::scheduler::step::effect::Task
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct Token {
    /// Module identifier.
    pub module: usize,
    /// Node identifier.
    pub node: usize,
}

/// Token with frontier information.
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct TokenFull {
    /// Module identifier.
    pub module: usize,
    /// Node identifier.
    pub node: usize,
    /// Frontier identifier.
    pub frontier: usize,
}