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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Defines failures converting native measurements into resource quantities.
// qubit-style: allow source-test-pair

use crate::resource::QuantityMeasurement;

/// Error returned when a native measurement cannot fit the selected quantity.
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[error("measurement {measurement} cannot be represented by {target}")]
pub struct QuantityConversionError {
    /// Original native measurement retained without truncation.
    measurement: QuantityMeasurement,
    /// Name of the selected resource quantity type.
    target: &'static str,
}

impl QuantityConversionError {
    /// Creates one quantity representation failure.
    ///
    /// # Parameters
    ///
    /// * `measurement` - Original native measurement that did not fit.
    /// * `target` - Name of the selected resource quantity type.
    ///
    /// # Returns
    ///
    /// A failure retaining both the original measurement and target type.
    #[inline(always)]
    #[must_use]
    pub const fn new(measurement: QuantityMeasurement, target: &'static str) -> Self {
        Self { measurement, target }
    }

    /// Returns the native measurement that could not be represented.
    #[must_use]
    #[inline(always)]
    pub const fn measurement(&self) -> QuantityMeasurement {
        self.measurement
    }

    /// Returns the selected resource quantity type name.
    #[must_use]
    #[inline(always)]
    pub const fn target(&self) -> &'static str {
        self.target
    }
}