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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Builds UTF-8 byte limits for one string value.

use super::StringLimits;
use crate::resource::ResourceLimit;
use crate::resource::ResourceQuantity;

/// Builder for [`StringLimits`].
///
/// # Type Parameters
///
/// * `R` - Caller-defined resource identity retained by limits and errors.
/// * `Q` - Exact unsigned quantity used for measurements and accounting.
///
/// # Examples
///
/// ```
/// use qubit_budget::ResourceLimit;
/// use qubit_budget::StringLimitsBuilder;
///
/// let limits = StringLimitsBuilder::new()
///     .utf8_bytes_limit(ResourceLimit::new("string bytes", 4_u64))
///     .build();
/// assert_eq!(limits.utf8_bytes_limit().unwrap().maximum(), 4);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct StringLimitsBuilder<R, Q = u64>
where
    Q: ResourceQuantity,
{
    /// Limit configuration accumulated by chained builder calls.
    limits: StringLimits<R, Q>,
}

impl<R, Q> Default for StringLimitsBuilder<R, Q>
where
    Q: ResourceQuantity,
{
    /// Creates an empty builder through the standard [`Default`] interface.
    ///
    /// # Returns
    ///
    /// Creates an empty builder through the standard [`Default`] interface.
    fn default() -> Self {
        Self::new()
    }
}

impl<R, Q> StringLimitsBuilder<R, Q>
where
    Q: ResourceQuantity,
{
    /// Creates an empty string-limits builder.
    ///
    /// # Returns
    ///
    /// Creates an empty string-limits builder.
    #[inline]
    #[must_use]
    pub const fn new() -> Self {
        Self {
            limits: StringLimits::new(),
        }
    }

    /// Creates a builder retaining an existing limit configuration.
    ///
    /// # Parameters
    ///
    /// * `limits` - Existing string limits whose configuration is copied into
    ///   this builder.
    ///
    /// # Returns
    ///
    /// Creates a builder retaining an existing limit configuration.
    #[inline]
    #[must_use]
    pub(crate) const fn from_limits(limits: StringLimits<R, Q>) -> Self {
        Self { limits }
    }

    /// Sets the inclusive UTF-8 byte limit.
    ///
    /// # Parameters
    ///
    /// * `limit` - Resource-bound UTF-8 byte limit to install.
    ///
    /// # Returns
    ///
    /// The builder with the described setting applied.
    #[inline]
    #[must_use]
    pub fn utf8_bytes_limit(mut self, limit: ResourceLimit<R, Q>) -> Self {
        self.limits.set_utf8_bytes_limit(limit);
        self
    }

    /// Builds the configured string limits.
    ///
    /// # Returns
    ///
    /// Builds the configured string limits.
    #[inline]
    #[must_use]
    pub fn build(self) -> StringLimits<R, Q> {
        self.limits
    }
}