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

//! Hierarchical, process-local resource budgets for concurrent Rust task trees.
//!
//! A [`Budget`] accounts for arbitrary integer-valued [`Resource`]s. Child
//! budgets may add tighter limits, while every successful operation is also
//! recorded against every ancestor. [`Reservation`] and [`ReservationSet`]
//! provide cancellation-safe capacity claims which release on drop.
//!
//! The crate is cooperative: code must receive and consult a budget for it to
//! be constrained. It is not a security sandbox, rate limiter, billing ledger,
//! or distributed quota service.

mod budget;
mod error;
mod reservation;
mod resource;
mod snapshot;

#[cfg(feature = "tokio")]
mod tokio_runtime;

pub use budget::{Budget, BudgetBuilder};
pub use error::{BudgetBuildError, BudgetError, ResourceError};
pub use reservation::{Reservation, ReservationSet};
pub use resource::{BudgetId, Resource};
pub use snapshot::{BudgetSnapshot, Remaining, ResourceSnapshot};

// Keep the README's Rust examples compiled without duplicating it in the
// published API documentation. The README's Tokio example requires all
// features, which is how the documentation test job invokes rustdoc.
#[cfg(all(doctest, feature = "tokio"))]
#[doc = include_str!("../README.md")]
pub struct ReadmeDoctests;