Struct BudgetGroupError 

pub struct BudgetGroupError<R, Q = u64>
where
    Q: Copy + Debug,
{ /* private fields */ }

Failure returned by an atomic grouped budget consumption.

The index identifies the first budget, in caller-provided order, that rejected the request. No member of the group is charged when this error is returned.

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::ResourceBudget;

let mut first = ResourceBudget::new("first", 2_u64);
let mut second = ResourceBudget::new("second", 1_u64);
let error = ResourceBudget::try_consume_group(&mut [&mut first, &mut second], 2)
    .expect_err("the second budget should reject the charge");
assert_eq!(error.index(), 1);
assert_eq!(first.remaining(), 2);

Implementations

impl<R, Q> BudgetGroupError<R, Q>

where Q: Copy + Debug,

pub const fn index(&self) -> usize

Returns the zero-based index of the first rejecting budget.

Returns

Returns the zero-based index of the first rejecting budget.

pub const fn source_error(&self) -> &InsufficientBudgetError<R, Q>

Returns the structured failure from the rejecting budget.

Returns

Returns the structured failure from the rejecting budget.

pub fn into_source_error(self) -> InsufficientBudgetError<R, Q>

Consumes this error and returns the rejecting budget’s failure.

Returns

Consumes this error and returns the rejecting budget’s failure.

Trait Implementations

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

where Q: Copy + Debug + Clone,

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

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

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

Formats the value using the given formatter.

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

where Q: Copy + Debug + Eq,

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

where Q: Copy + Debug, InsufficientBudgetError<R, Q>: Error + 'static, 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: PartialEq, Q> PartialEq for BudgetGroupError<R, Q>

where Q: Copy + Debug + PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

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

where Q: Copy + Debug + PartialEq,