qubit-budget 0.2.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
79
80
81
82
83
84
85
86
87
88
89

# rs-budget

[![Rust CI](https://github.com/qubit-ltd/rs-budget/actions/workflows/ci.yml/badge.svg)](https://github.com/qubit-ltd/rs-budget/actions/workflows/ci.yml)
[![Coverage](https://img.shields.io/endpoint?url=https://qubit-ltd.github.io/rs-budget/coverage-badge.json)](https://qubit-ltd.github.io/rs-budget/coverage/)
[![Crates.io](https://img.shields.io/crates/v/qubit-budget.svg?color=blue)](https://crates.io/crates/qubit-budget)
[![Rust](https://img.shields.io/badge/rust-1.94+-blue.svg?logo=rust)](https://www.rust-lang.org)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![中文文档](https://img.shields.io/badge/文档-中文版-blue.svg)](README.zh_CN.md)

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`:

```toml
[dependencies]
qubit-budget = "0.2"
```

## Quick Start

```rust
use qubit_budget::ResourceLimit;

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

let mut budget = ResourceLimit::new(100).budget();
budget.try_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;
- failure-atomic, fail-closed, partial, and releasable consumption operations.

## 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

```bash
# 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

Copyright (c) 2025 - 2026. Haixing Hu. All rights reserved.

Licensed under the Apache License, Version 2.0. See [LICENSE](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](https://github.com/qubit-ltd/rs-budget)