Enum ResourceReleaseError 

#[non_exhaustive]
pub enum ResourceReleaseError<R, Q = u64>
where
    Q: Copy + Debug,
{
    InvalidRelease {
        resource: R,
        limit: Q,
        in_use: Q,
        requested: Q,
    },
}

Structured facts describing a pool release that exceeds current usage.

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

let mut pool = ResourcePool::new("workers", 2_u64);
pool.try_acquire(1).expect("one worker should fit");
let error = pool.release(2).expect_err("only one worker is in use");
assert_eq!(error.in_use(), 1);
assert_eq!(error.requested(), 2);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidRelease

A release request exceeded the amount currently in use.

Fields

resource: R

Resource associated with the failed release request.

limit: Q

Configured finite limit.

in_use: Q

Quantity in use before the failed release.

requested: Q

Quantity requested by the failed operation.

Implementations

impl<R, Q> ResourceReleaseError<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 finite pool limit.

Returns

Returns the finite pool limit.

pub const fn in_use(&self) -> Q

Returns the amount in use before the invalid release.

Returns

Returns the amount in use before the invalid release.

pub const fn requested(&self) -> Q

Returns the requested release amount.

Returns

Returns the requested release amount.

Trait Implementations

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

where Q: Copy + Debug + Clone,

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

where Q: Copy + Debug + Eq,

impl<R, Q> Error for ResourceReleaseError<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: PartialEq, Q> PartialEq for ResourceReleaseError<R, Q>

where Q: Copy + Debug + PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

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

where Q: Copy + Debug + PartialEq,