Enum TimeBudgetError 

pub enum TimeBudgetError<R> {
    Clock {
        resource: R,
        source: TimeError,
    },
    Expired {
        resource: R,
        deadline: MonotonicInstant,
        now: MonotonicInstant,
    },
    WouldExpire {
        resource: R,
        deadline: MonotonicInstant,
        now: MonotonicInstant,
        requested: Duration,
    },
}

Available on crate feature time only.

Failure facts for a continuous deadline check.

Type Parameters

• R - Caller-defined resource value retained for diagnostics.

Examples

use std::time::Duration;
use qubit_budget::TimeBudget;
use qubit_budget::TimeBudgetError;
use qubit_clock::ManualMonotonicClock;

let clock = ManualMonotonicClock::new_shared();
let budget = TimeBudget::for_duration("request", clock.clone(), Duration::from_secs(1))
    .expect("the deadline should be representable");
clock.advance(Duration::from_secs(1)).expect("the clock should advance");
assert!(matches!(budget.check(), Err(TimeBudgetError::Expired { .. })));

Variants

Clock

The clock rejected a domain or instant operation.

Fields

resource: R

Resource value associated with the deadline.

source: TimeError

Underlying clock failure.

Expired

The fixed deadline has already been reached.

Fields

resource: R

Resource value associated with the deadline.

deadline: MonotonicInstant

Fixed deadline.

now: MonotonicInstant

Current sampled instant.

WouldExpire

A prospective operation would reach or pass the deadline.

Fields

resource: R

Resource value associated with the deadline.

deadline: MonotonicInstant

Fixed deadline.

now: MonotonicInstant

Current sampled instant.

requested: Duration

Prospective operation duration.

Implementations

impl<R> TimeBudgetError<R>

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

Returns the resource by reference.

Returns

Returns the resource by reference.

pub fn into_resource(self) -> R

Consumes the error and returns its resource.

Returns

Consumes the error and returns its resource.

pub const fn clock_error(&self) -> Option<&TimeError>

Returns the underlying clock error, when present.

Returns

Some contains the underlying clock error for Self::Clock; None is returned for Self::Expired and Self::WouldExpire.

pub const fn deadline(&self) -> Option<MonotonicInstant>

Returns the deadline for deadline-related errors.

Returns

Some contains the fixed deadline for Self::Expired and Self::WouldExpire; None is returned for Self::Clock.

pub const fn now(&self) -> Option<MonotonicInstant>

Returns the sampled instant for deadline-related errors.

Returns

Some contains the sampled instant for Self::Expired and Self::WouldExpire; None is returned for Self::Clock.

pub const fn requested(&self) -> Option<Duration>

Returns the prospective duration for a would-expire error.

Returns

Some contains the requested duration for Self::WouldExpire; None is returned for Self::Clock and Self::Expired.

Trait Implementations

impl<R: Debug> Debug for TimeBudgetError<R>

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

Formats the value using the given formatter.

impl<R> Display for TimeBudgetError<R>

where R: Debug,

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

Formats the value using the given formatter.

impl<R> Error for TimeBudgetError<R>

where 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.