qubit-budget 0.5.0

Dependency-light resource limit and budget accounting primitives for Qubit Rust crates
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
#![cfg_attr(docsrs, feature(doc_cfg))]
//! Dependency-light finite resource limits, budgets and pools.
//!
//! A budget object always represents a configured finite constraint. When a
//! dimension is unconfigured, callers use `Option::None` and do not create a
//! no-op or unlimited budget object. Resource quantities use an exact unsigned
//! integer type. High-level limits remain generic so callers can preserve their
//! native measurements; conversions from machine-sized measurements are checked
//! and reported as resource-accounting errors.
//!
//! A failed single-budget operation is non-mutating, and
//! [`ResourceBudget::try_consume_group`] checks every member before charging
//! any member. Higher-level sessions may deliberately retain charges for work
//! already attempted. Generic [`StructureBudget`] measurements are consumed
//! immediately, while JSON value measurements are staged and commit only after
//! the complete value succeeds. JSON raw and normalized input bytes, plus
//! accepted output prefixes, are charged immediately. These are separate
//! guarantees; an I/O failure does not itself poison a JSON value transaction,
//! and output transactionality does not imply whole-operation rollback.

mod resource;
pub mod string;
pub mod structure;
pub mod time;
mod value;

#[cfg(feature = "json")]
#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
pub mod json;
pub use resource::BudgetError;
pub use resource::BudgetGroupError;
pub use resource::InsufficientBudgetError;
pub use resource::LimitExceededError;
pub use resource::ManagedResourcePermit;
pub use resource::ManagedResourcePool;
pub use resource::MeasuredBudgetError;
pub use resource::Observation;
pub use resource::QuantityConversionError;
pub use resource::QuantityMeasurement;
pub use resource::ResourceBudget;
pub use resource::ResourceLimit;
pub use resource::ResourcePool;
pub use resource::ResourceQuantity;
pub use resource::ResourceReleaseError;
pub use string::BudgetedStringError;
pub use string::BudgetedStringWriter;
pub use structure::StructureBudget;
pub use structure::StructureLimits;
pub use structure::StructureLimitsBuilder;
pub use structure::StructureResource;
pub use time::DurationBudget;
#[cfg(feature = "time")]
#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
pub use time::TimeBudget;
#[cfg(feature = "time")]
#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
pub use time::TimeBudgetError;
#[cfg(feature = "big-decimal")]
#[cfg_attr(docsrs, doc(cfg(feature = "big-decimal")))]
pub use value::BigDecimalLimits;
#[cfg(feature = "big-decimal")]
#[cfg_attr(docsrs, doc(cfg(feature = "big-decimal")))]
pub use value::BigDecimalLimitsBuilder;
#[cfg(feature = "big-integer")]
#[cfg_attr(docsrs, doc(cfg(feature = "big-integer")))]
pub use value::BigIntegerLimits;
#[cfg(feature = "big-integer")]
#[cfg_attr(docsrs, doc(cfg(feature = "big-integer")))]
pub use value::BigIntegerLimitsBuilder;
pub use value::StringLimits;
pub use value::StringLimitsBuilder;