Enum BudgetError 

pub enum BudgetError {
    Exhausted {
        resource: Resource,
        requested: u64,
        remaining: u64,
        scope: BudgetId,
        scope_name: Option<Arc<str>>,
    },
    ReservationExceeded {
        resource: Resource,
        reserved: u64,
        actual: u64,
        unaccounted: u64,
    },
    UnknownReservationResource {
        resource: Resource,
    },
    Overflow {
        resource: Resource,
    },
    DeadlineExceeded,
    Cancelled,
}

Error returned by accounting and execution operations.

Variants

Exhausted

A limit in the budget lineage rejected an operation.

Fields

resource: Resource

The exhausted resource.

requested: u64

The amount requested by the operation.

remaining: u64

Capacity remaining at the limiting node.

scope: BudgetId

Identifier of the first limiting node in root-to-leaf order.

scope_name: Option<Arc<str>>

Optional name of the limiting node.

ReservationExceeded

A reservation was reconciled with more usage than it held.

The full reservation is retained as consumed. unaccounted reports usage which could not be admitted without violating a budget limit.

Fields

resource: Resource

The resource whose actual usage exceeded its reservation.

reserved: u64

Reserved capacity converted to consumed capacity.

actual: u64

Actual usage reported by the caller.

unaccounted: u64

Actual usage beyond the reservation.

UnknownReservationResource

Actual usage named a resource absent from the reservation set.

To fail closed, all reservations in the set are converted to consumed capacity before this error is returned.

Fields

resource: Resource

The unexpected resource.

Overflow

Checked resource arithmetic overflowed.

Fields

resource: Resource

The overflowing resource.

DeadlineExceeded

The effective budget deadline elapsed before an operation began.

Cancelled

The budget was cancelled.

Trait Implementations

impl Clone for BudgetError

fn clone(&self) -> BudgetError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BudgetError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BudgetError

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

Formats the value using the given formatter.

impl Eq for BudgetError

impl Error for BudgetError

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 PartialEq for BudgetError

fn eq(&self, other: &BudgetError) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BudgetError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BudgetError