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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

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

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

//! Scoped value.

use std::ops::Deref;

use crate::scheduler::signal::{Id, Scope};
use crate::scheduler::step::{Result, Step, Steps};

use super::effect::Effect;

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

/// Scoped value.
#[derive(Clone, Debug)]
pub struct Scoped<I> {
    /// Scope.
    scope: Scope<I>,
    /// Frontier identifier.
    id: Option<usize>,
}

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

impl<I> Scoped<I>
where
    I: Id,
{
    /// Creates a scoped value from the given scope.
    #[must_use]
    pub fn new(scope: Scope<I>, id: usize) -> Self {
        Self { scope, id: Some(id) }
    }

    /// Marks the step as done.
    #[allow(clippy::missing_errors_doc)]
    #[inline]
    pub fn done<C>(&self) -> Result<Steps<I, C>> {
        Ok(Steps::from(Step::new(self.clone(), Effect::Done)))
    }
}

#[allow(clippy::must_use_candidate)]
impl<I> Scoped<I> {
    /// Returns the frontier identifier of the scoped value.
    #[inline]
    pub fn id(&self) -> Option<usize> {
        self.id
    }
}

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

impl<I> From<Scope<I>> for Scoped<I> {
    /// Creates a scoped value from the given scope.
    #[inline]
    fn from(scope: Scope<I>) -> Self {
        Self { scope, id: None }
    }
}

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

impl<I> Deref for Scoped<I> {
    type Target = Scope<I>;

    /// Dereferences the scoped value to its scope.
    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.scope
    }
}