Struct actix::clock::Sleep [−][src]
Future returned by sleep
and sleep_until
.
This type does not implement the Unpin
trait, which means that if you
use it with select!
or by calling poll
, you have to pin it first.
If you use it with .await
, this does not apply.
Examples
Wait 100ms and print “100 ms have elapsed”.
use tokio::time::{sleep, Duration}; #[tokio::main] async fn main() { sleep(Duration::from_millis(100)).await; println!("100 ms have elapsed"); }
Use with select!
. Pinning the Sleep
with tokio::pin!
is
necessary when the same Sleep
is selected on multiple times.
use tokio::time::{self, Duration, Instant}; #[tokio::main] async fn main() { let sleep = time::sleep(Duration::from_millis(10)); tokio::pin!(sleep); loop { tokio::select! { () = &mut sleep => { println!("timer elapsed"); sleep.as_mut().reset(Instant::now() + Duration::from_millis(50)); }, } } }
Use in a struct with boxing. By pinning the Sleep
with a Box
, the
HasSleep
struct implements Unpin
, even though Sleep
does not.
use std::future::Future; use std::pin::Pin; use std::task::{Context, Poll}; use tokio::time::Sleep; struct HasSleep { sleep: Pin<Box<Sleep>>, } impl Future for HasSleep { type Output = (); fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> { self.sleep.as_mut().poll(cx) } }
Use in a struct with pin projection. This method avoids the Box
, but
the HasSleep
struct will not be Unpin
as a consequence.
use std::future::Future; use std::pin::Pin; use std::task::{Context, Poll}; use tokio::time::Sleep; use pin_project_lite::pin_project; pin_project! { struct HasSleep { #[pin] sleep: Sleep, } } impl Future for HasSleep { type Output = (); fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> { self.project().sleep.poll(cx) } }
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(self: Pin<&mut Sleep>, 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.
To call this method, you will usually combine the call with
Pin::as_mut
, which lets you call the method with consuming the
Sleep
itself.
Example
use tokio::time::{Duration, Instant}; let sleep = tokio::time::sleep(Duration::from_millis(10)); tokio::pin!(sleep); sleep.as_mut().reset(Instant::now() + Duration::from_millis(20));
Trait Implementations
impl Debug for Sleep
[src]
impl Future for Sleep
[src]
type Output = ()
The type of value produced on completion.
pub fn poll(
self: Pin<&mut Sleep>,
cx: &mut Context<'_>
) -> Poll<<Sleep as Future>::Output>
[src]
self: Pin<&mut Sleep>,
cx: &mut Context<'_>
) -> Poll<<Sleep as Future>::Output>
impl<'__pin> Unpin for Sleep where
__Origin<'__pin>: Unpin,
[src]
__Origin<'__pin>: Unpin,
Auto Trait Implementations
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T> FutureExt for T where
T: Future + ?Sized,
[src]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘ where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U>ⓘ where
Self::Output: Into<U>,
[src]
Self::Output: Into<U>,
pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>ⓘ where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
[src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
pub fn left_future<B>(self) -> Either<Self, B>ⓘ where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self>ⓘ where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>
[src]
pub fn flatten(self) -> Flatten<Self>ⓘ where
Self::Output: Future,
[src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>ⓘ
[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘ where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
pub fn unit_error(self) -> UnitError<Self>ⓘ
[src]
pub fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut>
impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;
[src]
Notable traits for NeverError<Fut>
impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,
pub fn now_or_never(self) -> Option<Self::Output>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
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]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
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]
impl<F, A> WrapFuture<A> for F where
F: Future,
A: Actor,
[src]
F: Future,
A: Actor,
type Future = FutureWrap<F, A>
The future that this type can be converted into.
type Output = <F as Future>::Output
The item that the future may resolve with.