Enum MeasuredBudgetError 

pub enum MeasuredBudgetError<R, Q = u64>
where
    Q: Copy + Debug,
{
    Quantity {
        resource: R,
        source: QuantityConversionError,
    },
    Budget(BudgetError<R, Q>),
}

Error returned when native measurement or budget validation rejects a value.

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::MeasuredBudgetError;
use qubit_budget::QuantityConversionError;
use qubit_budget::QuantityMeasurement;

let source = QuantityConversionError::new(QuantityMeasurement::Usize(256), "u8");
let error = MeasuredBudgetError::<_, u8>::quantity("bytes", source);
assert!(error.quantity_error().is_some());

Variants

Quantity

A native measurement could not fit the configured quantity type.

Fields

resource: R

Resource associated with the rejected measurement.

source: QuantityConversionError

Native quantity conversion failure.

Budget(BudgetError<R, Q>)

A representable measurement exceeded its configured resource budget.

Tuple Fields

0: BudgetError<R, Q>

Exact point-limit or cumulative-budget failure.

Implementations

impl<R, Q> MeasuredBudgetError<R, Q>

where Q: Copy + Debug,

pub const fn quantity(resource: R, source: QuantityConversionError) -> Self

Creates a failure for a native measurement that did not fit Q.

Parameters

• resource - Resource being measured.
• source - Exact native quantity conversion failure.

Returns

A quantity representation failure retaining its resource identity.

pub const fn budget_error(&self) -> Option<&BudgetError<R, Q>>

Returns the contained budget failure when the measurement fit Q.

Returns

Some for Self::Budget, or None for Self::Quantity.

pub const fn quantity_error(&self) -> Option<&QuantityConversionError>

Returns the native quantity conversion failure, when present.

Returns

Some for Self::Quantity, or None for Self::Budget.

pub const fn resource(&self) -> &R

Returns the resource associated with this failure.

The resource is present for both budget validation and quantity conversion failures, so callers do not need to match the error variant merely to attach resource context.

Returns

Returns the resource associated with this failure.

pub fn into_resource(self) -> R

Consumes this failure and returns its associated resource.

Returns

Consumes this failure and returns its associated resource.

Trait Implementations

impl<R: Clone, Q> Clone for MeasuredBudgetError<R, Q>

where Q: Copy + Debug + Clone,

fn clone(&self) -> MeasuredBudgetError<R, Q>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug, Q> Debug for MeasuredBudgetError<R, Q>

where Q: Copy + Debug + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R, Q> Display for MeasuredBudgetError<R, Q>

where Q: Copy + Debug, R: Debug, BudgetError<R, Q>: Display,

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R, Q> Error for MeasuredBudgetError<R, Q>

where Q: Copy + Debug, BudgetError<R, Q>: Error, Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<R, Q> From<BudgetError<R, Q>> for MeasuredBudgetError<R, Q>

where Q: Copy + Debug,

fn from(source: BudgetError<R, Q>) -> Self

Converts to this type from the input type.

impl<R, Q> From<InsufficientBudgetError<R, Q>> for MeasuredBudgetError<R, Q>

where Q: Copy + Debug,

fn from(error: InsufficientBudgetError<R, Q>) -> Self

Wraps a cumulative-budget failure in a measured-budget failure.

Parameters

• error - Precise cumulative-budget failure to wrap.

Returns

Wraps a cumulative-budget failure in a measured-budget failure.

impl<R, Q> From<LimitExceededError<R, Q>> for MeasuredBudgetError<R, Q>

where Q: Copy + Debug,

fn from(error: LimitExceededError<R, Q>) -> Self

Wraps a point-limit failure in a measured-budget failure.

Parameters

• error - Precise point-limit failure to wrap.

Returns

Wraps a point-limit failure in a measured-budget failure.