rs-budget

Dependency-light resource limit and budget accounting primitives for Qubit Rust crates.

Intended Users

Rust library authors who need to enforce bounded input, output, depth, node, or item work while keeping domain-specific policies and diagnostics in their own crates.

Installation

Add the published crate to your Cargo.toml:

[dependencies]
qubit-budget = "0.1"

Quick Start

use qubit_budget::ResourceLimit;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum ResourceKind {
    Nodes,
}

let mut budget = ResourceLimit::new(100).budget();
budget.consume(ResourceKind::Nodes, 40).expect("within the budget");
assert_eq!(budget.remaining(), 60);

Capabilities

immutable single-dimension limits through ResourceLimit;
mutable per-operation accounting through ResourceBudget;
typed LimitExceeded<K> facts for domain-owned resource categories;
saturating usage arithmetic and failure-atomic consumption.

Limitations

The crate intentionally does not define JSON, Serde, I/O, redaction, parser, default-limit, or domain-error policy. Consuming crates should retain their own public limit types and translate LimitExceeded<K> into their established errors.

Testing

# Run tests with the default feature set
cargo test

# Run tests with all declared features
cargo test --all-features

# Project CI checks
./ci-check.sh

# Check code coverage
./coverage.sh

License

Licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Contributing

Contributions are welcome. Please follow the Rust API guidelines, keep public API documentation and tests current, and run ./align-ci.sh to format code and ./ci-check.sh to satisfy CI requirements before submitting a pull request.

Author

Haixing Hu - Qubit Co. Ltd.

Repository: https://github.com/qubit-ltd/rs-budget

qubit-budget 0.1.0