Struct tokio::time::error::Error [−][src]
pub struct Error(_);
time
only.Expand description
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 sleep instances. 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.
Implementations
impl Error
[src]
impl Error
[src]pub fn is_shutdown(&self) -> bool
[src]
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]
pub fn at_capacity() -> Error
[src]Creates an error representing a timer at capacity.
pub fn is_at_capacity(&self) -> bool
[src]
pub fn is_at_capacity(&self) -> bool
[src]Returns true
if the error was caused by the timer being at capacity.
pub fn is_invalid(&self) -> bool
[src]
pub fn is_invalid(&self) -> bool
[src]Returns true
if the error was caused by the timer being misconfigured.
Trait Implementations
impl Error for Error
[src]
impl Error for Error
[src]fn source(&self) -> Option<&(dyn Error + 'static)>
1.30.0[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]
fn backtrace(&self) -> Option<&Backtrace>
[src]backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
fn description(&self) -> &str
1.0.0[src]
fn description(&self) -> &str
1.0.0[src]use the Display impl or to_string()
impl Copy for Error
[src]
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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
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]
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