Struct InsufficientBudgetError 

pub struct InsufficientBudgetError<R, Q = u64>
where
    Q: Copy + Debug,
{
    pub resource: R,
    pub limit: Q,
    pub remaining: Q,
    pub requested: Q,
}

Structured facts for a cumulative request that exceeded remaining capacity.

Type Parameters

• R - Caller-defined resource value retained for diagnostics.
• Q - Copyable measurement value used by the failed constraint.

Examples

use qubit_budget::ResourceBudget;

let mut budget = ResourceBudget::new("bytes", 2_u64);
let error = budget.try_consume(3).expect_err("three bytes should not fit");
assert_eq!(error.remaining(), 2);
assert_eq!(error.requested(), 3);

Fields

resource: R

Resource associated with the failed consumption request.

limit: Q

Configured finite limit.

remaining: Q

Capacity remaining before the failed request.

requested: Q

Quantity requested by the failed operation.

Implementations

impl<R, Q> InsufficientBudgetError<R, Q>

where Q: Copy + Debug,

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

Returns the resource associated with this failure.

Returns

Returns the resource associated with this failure.

pub fn into_resource(self) -> R

Consumes this error and returns its associated resource.

Returns

Consumes this error and returns its associated resource.

pub const fn limit(&self) -> Q

Returns the configured finite limit.

Returns

Returns the configured finite limit.

pub const fn remaining(&self) -> Q

Returns the capacity remaining before the failed request.

Returns

Returns the capacity remaining before the failed request.

pub const fn requested(&self) -> Q

Returns the quantity requested by the failed operation.

Returns

Returns the quantity requested by the failed operation.

impl<R, Q> InsufficientBudgetError<R, Q>

where Q: ResourceQuantity,

pub fn used(&self) -> Q

Returns the amount already consumed before the failed request.

Returns

Returns the amount already consumed before the failed request.

Trait Implementations

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

where Q: Copy + Debug + Clone,

fn clone(&self) -> InsufficientBudgetError<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 InsufficientBudgetError<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 InsufficientBudgetError<R, Q>

where Q: Copy + Debug + Debug, R: Debug,

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

Formats the value using the given formatter.

impl<R: Eq, Q> Eq for InsufficientBudgetError<R, Q>

where Q: Copy + Debug + Eq,

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

where Q: Copy + Debug, 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<InsufficientBudgetError<R, Q>> for BudgetError<R, Q>

where Q: Copy + Debug,

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

Converts a precise cumulative-budget failure into an aggregate error.

Parameters

• error - Precise cumulative-budget failure to convert.

Returns

Converts a precise cumulative-budget failure into an aggregate error.

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: PartialEq, Q> PartialEq for InsufficientBudgetError<R, Q>

where Q: Copy + Debug + PartialEq,

fn eq(&self, other: &InsufficientBudgetError<R, Q>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<R: PartialEq, Q> StructuralPartialEq for InsufficientBudgetError<R, Q>

where Q: Copy + Debug + PartialEq,