Struct actix::utils::TimerFunc

#[must_use = "future do nothing unless polled"]
pub struct TimerFunc<A> where
    A: Actor,  { /* fields omitted */ }

An ActorFuture that runs a function in the actor's context after a specified amount of time.

Unless you specifically need access to the future, use Context::run_later instead.

use std::time::Duration;
use actix::prelude::*;
use actix::utils::TimerFunc;

struct MyActor;

impl MyActor {
    fn stop(&mut self, context: &mut Context<Self>) {
        System::current().stop();
    }
}

impl Actor for MyActor {
   type Context = Context<Self>;

   fn started(&mut self, context: &mut Context<Self>) {
       // spawn a delayed future into our context
       TimerFunc::new(Duration::from_millis(100), Self::stop)
           .spawn(context);
   }
}

Methods

impl<A> TimerFunc<A> where
    A: Actor, 

pub fn new<F>(timeout: Duration, f: F) -> TimerFunc<A> where
    F: FnOnce(&mut A, &mut A::Context) + 'static, 

Creates a new TimerFunc with the given duration.

Trait Implementations

impl<A> ActorFuture for TimerFunc<A> where
    A: Actor, 

type Output = ()

The type of value that this future will resolved with if it is successful.

type Actor = A

The actor within which this future runs

fn poll(
    self: Pin<&mut Self>,
    act: &mut Self::Actor,
    ctx: &mut <Self::Actor as Actor>::Context,
    task: &mut Context
) -> Poll<Self::Output>

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> U,
    Self: Sized, 

Map this future's result to a different type, returning a new future of the resulting type.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    F: FnOnce(Self::Output, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> B,
    B: IntoActorFuture<Actor = Self::Actor>,
    Self: Sized, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn timeout(self, timeout: Duration) -> Timeout<Self> where
    Self: Sized, 

Add timeout to futures chain.