Struct tokio::timer::Error
[−]
[src]
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 theshutdown
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, andat_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
[src]
pub fn shutdown() -> Error
[src]
Create an error representing a shutdown timer.
pub fn is_shutdown(&self) -> bool
[src]
Returns true
if the error was caused by the timer being shutdown.
pub fn at_capacity() -> Error
[src]
Create an error representing a timer at capacity.
pub fn is_at_capacity(&self) -> bool
[src]
Returns true
if the error was caused by the timer being at capacity.
Trait Implementations
impl Debug for Error
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more
impl Error for Error
[src]
fn description(&self) -> &str
[src]
A short description of the error. Read more
fn cause(&self) -> Option<&Error>
1.0.0[src]
The lower-level cause of this error, if any. Read more