qubit-budget 0.4.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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Private owned and borrowed decode-session storage.
// qubit-style: allow source-test-pair

use crate::json::JsonValueBudget;
use crate::resource::ResourceBudget;
use crate::resource::ResourceQuantity;

/// Mutable budgets borrowed by one decode attempt.
///
/// # Type Parameters
///
/// * `R` - Caller-defined resource identity retained by limits and errors.
/// * `Q` - Exact unsigned quantity used for measurements and accounting.
type DecodeStorageSplit<'a, R, Q> = (
    Option<&'a mut ResourceBudget<R, Q>>,
    Option<&'a mut ResourceBudget<R, Q>>,
    &'a mut JsonValueBudget<R, Q>,
);

/// Backing storage for owned and caller-borrowed decode budgets.
///
/// # Type Parameters
///
/// * `R` - Caller-defined resource identity retained by limits and errors.
/// * `Q` - Exact unsigned quantity used for measurements and accounting.
#[derive(Debug)]
pub(crate) enum DecodeStorage<'a, R, Q>
where
    Q: ResourceQuantity,
{
    /// Session-owned budget values.
    Owned {
        /// Optional raw-input budget.
        input: Option<ResourceBudget<R, Q>>,
        /// Optional normalized-input budget.
        normalized_input: Option<ResourceBudget<R, Q>>,
        /// JSON value budget.
        value: JsonValueBudget<R, Q>,
    },
    /// Caller-owned budget references.
    Borrowed {
        /// Optional raw-input budget.
        input: Option<&'a mut ResourceBudget<R, Q>>,
        /// Optional normalized-input budget.
        normalized_input: Option<&'a mut ResourceBudget<R, Q>>,
        /// JSON value budget.
        value: &'a mut JsonValueBudget<R, Q>,
    },
}

impl<R, Q> DecodeStorage<'_, R, Q>
where
    Q: ResourceQuantity,
{
    /// Splits storage into the budgets borrowed by one decode attempt.
    ///
    /// # Returns
    ///
    /// Splits storage into the budgets borrowed by one decode attempt.
    ///
    /// A `None` I/O budget indicates that the corresponding byte dimension is
    /// unconfigured.
    #[inline]
    pub(crate) fn split(&mut self) -> DecodeStorageSplit<'_, R, Q> {
        match self {
            Self::Owned {
                input,
                normalized_input,
                value,
            } => (input.as_mut(), normalized_input.as_mut(), value),
            Self::Borrowed {
                input,
                normalized_input,
                value,
            } => (input.as_deref_mut(), normalized_input.as_deref_mut(), value),
        }
    }
}