Skip to main content

Sleep

Struct Sleep 

Source
pub struct Sleep { /* private fields */ }
Expand description

A future that completes at its deadline. Made by sleep and sleep_until.

Polled on one of nuclei’s shards, it arms a timer in that shard’s wheel; polled anywhere else (another runtime’s thread), it asks a shard of the current runtime (or the default one) to fire it. Dropping it cancels the timer.

Implementations§

Source§

impl Sleep

Source

pub fn deadline(&self) -> Instant

The deadline.

Source

pub fn is_elapsed(&self) -> bool

Whether the deadline has passed.

Source

pub fn reset(self: Pin<&mut Self>, deadline: impl Into<Instant>)

Moves the deadline; the sleep is pending again until it.

Trait Implementations§

Source§

impl Debug for Sleep

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Future for Sleep

Source§

type Output = ()

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Sleep

§

impl !UnwindSafe for Sleep

§

impl Freeze for Sleep

§

impl Send for Sleep

§

impl Sync for Sleep

§

impl Unpin for Sleep

§

impl UnsafeUnpin for Sleep

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
§

impl<T> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.