Struct tokio::time::Sleep[−][src]

#[must_use = "futures do nothing unless you `.await` or poll them"]pub struct Sleep { /* fields omitted */ }
[−]

Future returned by sleep and sleep_until.

Implementations

impl Sleep[src][−]

pub fn deadline(&self) -> Instant[src][−]

Returns the instant at which the future will complete.

pub fn is_elapsed(&self) -> bool[src][−]

Returns true if Sleep has elapsed.

A Sleep instance is elapsed when the requested duration has elapsed.

pub fn reset(&mut self, deadline: Instant)[src][−]

Resets the Sleep instance to a new deadline.

Calling this function allows changing the instant at which the Sleep future completes without having to create new associated state.

This function can be called both before and after the future has completed.

Trait Implementations

impl Debug for Sleep[src][+]

impl Future for Sleep[src][+]

type Output = ()

The type of value produced on completion.

Auto Trait Implementations

impl !RefUnwindSafe for Sleep

impl Send for Sleep

impl Sync for Sleep

impl Unpin for Sleep

impl !UnwindSafe for Sleep

Blanket Implementations

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

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

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

impl<T> From<T> for T[src][+]

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

impl<F> IntoFuture for F where
    F: Future, [src][+]

type Output = <F as Future>::Output

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

The output that the future will produce on completion.

type Future = F

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

Which kind of future are we turning this into?

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.

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.