Struct actix_web::actix::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 as Actor>::Context) + 'static, 

Creates a new TimerFunc with the given duration.

Trait Implementations

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

type Item = ()

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

type Error = ()

The type of error that this future will resolve with if it fails in a normal fashion.

type Actor = A

The actor within which this future runs

fn poll(
    &mut self,
    act: &mut <TimerFunc<A> as ActorFuture>::Actor,
    ctx: &mut <<TimerFunc<A> as ActorFuture>::Actor as Actor>::Context
) -> Result<Async<<TimerFunc<A> as ActorFuture>::Item>, <TimerFunc<A> as ActorFuture>::Error>

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

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

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> E, 

Map this future's error to a different error, returning a new future.

fn drop_err(self) -> DropErr<Self>

Drop this future's error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

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

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

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoActorFuture<Error = Self::Error, Actor = Self::Actor>,
    F: FnOnce(Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> B, 

Execute another future after this one has resolved successfully.

fn timeout(self, timeout: Duration, err: Self::Error) -> Timeout<Self>

Add timeout to futures chain.