Struct IntervalFunc

pub struct IntervalFunc<A: Actor> { /* private fields */ }

An ActorStream that periodically runs a function in the actor’s context.

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

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

struct MyActor;

impl MyActor {
    fn tick(&mut self, context: &mut Context<Self>) {
        println!("tick");
    }
}

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

   fn started(&mut self, context: &mut Context<Self>) {
       // spawn an interval stream into our context
       IntervalFunc::new(Duration::from_millis(100), Self::tick)
           .finish()
           .spawn(context);
   }
}

Implementations

impl<A: Actor> IntervalFunc<A>

pub fn new<F>(interval: Duration, task: F) -> IntervalFunc<A>

where F: FnMut(&mut A, &mut A::Context) + 'static,

Constructs an IntervalFunc using the given interval duration and task function.

pub fn new_at<F>(start: Instant, interval: Duration, task: F) -> IntervalFunc<A>

where F: FnMut(&mut A, &mut A::Context) + 'static,

Constructs an IntervalFunc using the given start time, interval duration, and task function.

Trait Implementations

impl<A: Actor> ActorStream<A> for IntervalFunc<A>

type Item = ()

The type of item this stream will yield on success.

fn poll_next( self: Pin<&mut Self>, act: &mut A, ctx: &mut A::Context, task: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

impl<'__pin, A: Actor> Unpin for IntervalFunc<A>

where PinnedFieldsOf<__Origin<'__pin, A>>: Unpin,