Struct LimitExceededError 

pub struct LimitExceededError<R, Q = u64>
where
    Q: Copy + Debug,
{
    pub resource: R,
    pub observed: Observation<Q>,
    pub maximum: Q,
}

Structured facts for a point measurement that exceeded its maximum.

Type Parameters

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

Examples

use qubit_budget::LimitExceededError;
use qubit_budget::Observation;

let error = LimitExceededError::exact("depth", 3_u64, 2);
assert_eq!(error.observation(), Observation::Exact(3));
assert_eq!(error.maximum(), 2);

Fields

resource: R

Resource associated with the failed point check.

observed: Observation<Q>

Observed point measurement or safe lower bound.

maximum: Q

Configured inclusive point maximum.

Implementations

impl<R, Q> LimitExceededError<R, Q>

where Q: Copy + Debug,

pub const fn exact(resource: R, observed: Q, maximum: Q) -> Self

Creates a failure from an exact point measurement.

Parameters

• resource - Resource associated with the failed point check.
• observed - Exact measurement that exceeded maximum.
• maximum - Configured inclusive point maximum.

Returns

A structured failure containing an Observation::Exact measurement.

pub const fn at_least(resource: R, lower_bound: Q, maximum: Q) -> Self

Creates a failure from a safe lower bound for a point measurement.

Parameters

• resource - Resource associated with the failed point check.
• lower_bound - Proven lower bound that exceeded maximum.
• maximum - Configured inclusive point maximum.

Returns

A structured failure containing an Observation::AtLeast measurement.

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 observation(&self) -> Observation<Q>

Returns the observed point measurement or safe lower bound.

Returns

Returns the observed point measurement or safe lower bound.

pub const fn exact_observed(&self) -> Option<Q>

Returns the exact point measurement when the observation is exact.

Returns

Returns the exact point measurement when the observation is exact.

None indicates that the observation is only a lower bound.

pub const fn observed_lower_bound(&self) -> Q

Returns the safe lower bound of the observed point measurement.

Returns

Returns the safe lower bound of the observed point measurement.

pub const fn maximum(&self) -> Q

Returns the configured inclusive point maximum.

Returns

Returns the configured inclusive point maximum.

Trait Implementations

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

where Q: Copy + Debug + Clone,

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

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

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

Formats the value using the given formatter.

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

where Q: Copy + Debug + Eq,

impl<R, Q> Error for LimitExceededError<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<LimitExceededError<R, Q>> for BudgetError<R, Q>

where Q: Copy + Debug,

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

Converts a precise point-limit failure into an aggregate error.

Parameters

• error - Precise point-limit failure to convert.

Returns

Converts a precise point-limit failure into an aggregate error.

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.

impl<R: PartialEq, Q> PartialEq for LimitExceededError<R, Q>

where Q: Copy + Debug + PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

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

where Q: Copy + Debug + PartialEq,