Struct tokio::time::error::Error

pub struct Error(_);

Errors encountered by the timer implementation.

Currently, there are two different errors that can occur:

• shutdown occurs when a timer operation is attempted, but the timer instance has been dropped. In this case, the operation will never be able to complete and the shutdown error is returned. This is a permanent error, i.e., once this error is observed, timer operations will never succeed in the future.

• at_capacity occurs when a timer operation is attempted, but the timer instance is currently handling its maximum number of outstanding sleep instances. In this case, the operation is not able to be performed at the current moment, and at_capacity is returned. This is a transient error, i.e., at some point in the future, if the operation is attempted again, it might succeed. Callers that observe this error should attempt to shed load. One way to do this would be dropping the future that issued the timer operation.

Implementations

impl Error

pub fn shutdown() -> Error

Creates an error representing a shutdown timer.

pub fn is_shutdown(&self) -> bool

Returns true if the error was caused by the timer being shutdown.

pub fn at_capacity() -> Error

Creates an error representing a timer at capacity.

pub fn is_at_capacity(&self) -> bool

Returns true if the error was caused by the timer being at capacity.

pub fn invalid() -> Error

Creates an error representing a misconfigured timer.

pub fn is_invalid(&self) -> bool

Returns true if the error was caused by the timer being misconfigured.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

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 self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl Copy for Error