Struct heph_rt::timer::Timer

pub struct Timer<RT: Access> { /* private fields */ }

A Future that represents a timer.

If this future returns Poll::Ready(DeadlinePassed) it means that the deadline has passed. If it returns Poll::Pending it’s not yet passed.

Examples

use std::time::Duration;

use heph::actor;
use heph_rt::ThreadLocal;
use heph_rt::timer::Timer;

async fn actor(mut ctx: actor::Context<!, ThreadLocal>) {
    // Create a timer, this will be ready once the timeout has passed.
    let timeout = Timer::after(&mut ctx, Duration::from_millis(200));

    // Wait for the timer to pass.
    timeout.await;
    println!("200 milliseconds have passed!");
}

Implementations

impl<RT: Access> Timer<RT>

pub fn at<M>(ctx: &mut Context<M, RT>, deadline: Instant) -> Timer<RT>where
    RT: Clone,

Create a new Timer.

pub fn after<M>(ctx: &mut Context<M, RT>, timeout: Duration) -> Timer<RT>where
    RT: Clone,

Create a new timer, based on a timeout.

Same as calling Timer::at(&mut ctx, Instant::now() + timeout).

pub const fn deadline(&self) -> Instant

Returns the deadline set for this Timer.

pub fn has_passed(&self) -> bool

Returns true if the deadline has passed.

pub fn wrap<Fut>(self, future: Fut) -> Deadline<Fut, RT>

Wrap a future creating a new Deadline.

Trait Implementations

impl<RT: Access> Bound<RT> for Timer<RT>

type Error = Error

Error type used in bind_to.

fn bind_to<M>(&mut self, ctx: &mut Context<M, RT>) -> Result<()>

Bind a type to the Actor that owns the ctx.

impl<RT: Debug + Access> Debug for Timer<RT>

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

Formats the value using the given formatter.

impl<RT: Access> Drop for Timer<RT>

fn drop(&mut self)

Executes the destructor for this type.

impl<RT: Access> Future for Timer<RT>

type Output = DeadlinePassed

The type of value produced on completion.

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

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

impl<RT: Access> Unpin for Timer<RT>