# [−] [src] 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` [src]

#### `pub fn shutdown() -> Error` [src]

Creates 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]

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

#### `pub fn invalid() -> Error` [src]

Create an error representing a misconfigured timer.

#### `pub fn is_invalid(&self) -> bool` [src]

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

## Trait Implementations

### `impl Clone for Error` [src]

#### `fn clone(&self) -> Error` [src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Copy for Error` [src]

### `impl Debug for Error` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Display for Error` [src]

#### `fn fmt(&self, fmt: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Error for Error` [src]

#### `fn source(&self) -> Option<&(dyn Error + 'static)>`1.30.0 [src]

The lower-level source of this error, if any. Read more

#### `fn backtrace(&self) -> Option<&Backtrace>` [src]

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

Returns a stack backtrace, if available, of where this error occurred. Read more

#### `fn description(&self) -> &str` 1.0.0 [src]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

Read more

#### `fn cause(&self) -> Option<&dyn Error>`1.0.0 [src]

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

## Auto Trait Implementations

### `impl RefUnwindSafe for Error`

### `impl Send for Error`

### `impl Sync for Error`

### `impl Unpin for Error`

### `impl UnwindSafe for Error`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String` [src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.