Struct actix::utils::TimerFunc

source ·
pub struct TimerFunc<A: Actor> { /* private fields */ }
Expand description

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);
   }
}

Implementations§

source§

impl<A: Actor> TimerFunc<A>

source

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§

source§

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

§

type Output = ()

The type of value produced on completion.
source§

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

source§

impl<'__pin, A: Actor> Unpin for TimerFunc<A>
where __Origin<'__pin, A>: Unpin,

Auto Trait Implementations§

§

impl<A> !RefUnwindSafe for TimerFunc<A>

§

impl<A> !Send for TimerFunc<A>

§

impl<A> !Sync for TimerFunc<A>

§

impl<A> !UnwindSafe for TimerFunc<A>

Blanket Implementations§

source§

impl<F, A> ActorFutureExt<A> for F
where F: ActorFuture<A>, A: Actor,

source§

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

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

fn then<F, Fut>(self, f: F) -> Then<Self, Fut, F>
where F: FnOnce(Self::Output, &mut A, &mut A::Context) -> Fut, Fut: ActorFuture<A>, Self: Sized,

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

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

Add timeout to futures chain. Read more
source§

fn boxed_local(self) -> LocalBoxActorFuture<A, Self::Output>
where Self: Sized + 'static,

Wrap the future in a Box, pinning it. Read more
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more