Struct tokio::timer::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 delays. 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.

Methods

impl Error

pub fn shutdown() -> Error

Create 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

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

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Error for Error

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&Error>

The lower-level cause of this error, if any.

impl Display for Error

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

Formats the value using the given formatter.