budget-context 0.1.1

Hierarchical resource budgets for concurrent Rust task trees
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

use std::sync::Arc;
use std::time::Duration;

use crate::{BudgetId, Resource};

/// Effective remaining capacity for a resource.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Remaining {
    /// No node in the lineage limits the resource.
    Unlimited,
    /// The minimum remaining capacity across limited lineage nodes.
    Limited(u64),
}

/// A consistent read-only view of one resource at a budget node.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ResourceSnapshot {
    /// The resource category.
    pub resource: Resource,
    /// The limit configured directly on the observed node.
    pub local_limit: Option<u64>,
    /// Consumed usage for the complete subtree rooted at the observed node.
    pub consumed: u64,
    /// Reserved usage for the complete subtree rooted at the observed node.
    pub reserved: u64,
    /// Effective capacity after applying every ancestor limit.
    pub effective_remaining: Remaining,
}

/// A consistent read-only view of a budget node.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BudgetSnapshot {
    /// Process-local node identifier.
    pub id: BudgetId,
    /// Optional diagnostic name.
    pub name: Option<Arc<str>>,
    /// Resources limited in the lineage or observed in this subtree.
    pub resources: Vec<ResourceSnapshot>,
    /// Saturating duration until the effective deadline.
    pub deadline_remaining: Option<Duration>,
    /// Whether cancellation has been requested for this node.
    #[cfg(feature = "tokio")]
    pub cancelled: bool,
}