Struct messages::context::Context

pub struct Context<ACTOR> { /* private fields */ }

Context represents an environment in which actor is being executed.

It is capable of transferring incoming messages to the actor, providing actor’s address and managing it lifetime (e.g. stopping it).

Implementations

impl<ACTOR> Context<ACTOR> where
    ACTOR: 'static + Send + Actor + Unpin, 

pub fn new() -> Self

Creates a new Context object with default capacity (128 elements).

pub fn with_capacity(capacity: usize) -> Self

Creates a new Context object with custom capacity.

pub fn address(&self) -> Address<ACTOR>

Returns an address of the actor.

pub async fn run(self, actor: ACTOR)

Starts the message handling routine.

Future returned by this method should not normally be directly awaited, but rather is expected to be used in some kind of spawn function of the used runtime (e.g. tokio::spawn or async_std::task::spawn).

impl<ACTOR> Context<ACTOR> where
    ACTOR: 'static + Send + Actor + Unpin, 

pub fn spawn(self, actor: ACTOR) -> Address<ACTOR>

This is supported on crate features runtime-tokio or runtime-async-std only.

Spawns an actor and returns its address.

Trait Implementations

impl<ACTOR> Debug for Context<ACTOR>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<ACTOR> Default for Context<ACTOR> where
    ACTOR: 'static + Send + Actor + Unpin, 

fn default() -> Self

Returns the “default value” for a type.