Struct tonari_actor::timed::Timed

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

A wrapper around actors to add ability to receive delayed and recurring messages. See module documentation for a complete recipe.

Implementations

impl<M: Send + 'static, A: Actor<Context = TimedContext<M>, Message = M>> Timed<A>

pub fn new(inner: A) -> Self

Trait Implementations

impl<M: Send + 'static, A: Actor<Context = TimedContext<M>, Message = M>> Actor for Timed<A>

type Context = Context<<Timed<A> as Actor>::Message>

What kind of context this actor accepts. Usually Context<Self::Message>.

type Error = <A as Actor>::Error

The type to return on error in the handle method.

type Message = TimedMessage<M>

The expected type of a message to be received.

const DEFAULT_CAPACITY_HIGH: usize = A::DEFAULT_CAPACITY_HIGH

Default capacity of actor’s high-priority inbox unless overridden by .with_capacity().

const DEFAULT_CAPACITY_NORMAL: usize = A::DEFAULT_CAPACITY_NORMAL

Default capacity of actor’s normal-priority inbox unless overridden by .with_capacity().

fn handle( &mut self, context: &mut Self::Context, timed_message: Self::Message ) -> Result<(), Self::Error>

The primary function of this trait, allowing an actor to handle incoming messages of a certain type.

fn name() -> &'static str

The name of the Actor - used only for logging/debugging.

fn priority(message: &Self::Message) -> Priority

Determine priority of a message before it is sent to this actor. Default implementation returns Priority::Normal.

fn started(&mut self, context: &mut Self::Context)

An optional callback when the Actor has been started.

fn stopped(&mut self, context: &mut Self::Context)

An optional callback when the Actor has been stopped.

fn deadline_passed( &mut self, context: &mut Self::Context, _deadline: Instant ) -> Result<(), Self::Error>

An optional callback when a deadline has passed.

impl<A: Actor> Deref for Timed<A>

Access wrapped actor.

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.