Struct tonari_actor::Context

pub struct Context<M> {
    pub system_handle: SystemHandle,
    pub myself: Recipient<M>,
    // some fields omitted
}

An execution context for a specific actor. Specifically, this is useful for managing the lifecycle of itself (through the myself field) and other actors via the SystemHandle provided. A time-based deadline for receiving a message can be set using Self::set_deadline() and friends.

Fields

system_handle: SystemHandle

myself: Recipient<M>

Implementations

impl<M> Context<M>

pub fn deadline(&self) -> &Option<Instant>

Get the deadline previously set using Self::set_deadline() or Self::set_timeout(). The deadline is cleared just before Actor::deadline_passed() is called.

pub fn set_deadline(&mut self, deadline: Option<Instant>)

Schedule a future one-shot call to Actor::deadline_passed(), or cancel the schedule. A deadline in the past is considered to expire right in the next iteration (possibly after receiving new messages).

pub fn set_timeout(&mut self, timeout: Option<Duration>)

Schedule or cancel a call to Actor::deadline_passed() after timeout from now. Convenience variant of Self::set_deadline().