Struct hannibal::Addr

pub struct Addr<A> { /* private fields */ }

The address of an actor.

When all references to Addr<A> are dropped, the actor ends. You can use the Clone trait to create multiple copies of Addr<A>.

Implementations

impl<A> Addr<A>

pub fn downgrade(&self) -> WeakAddr<A>

Turns an Addr<A> into a WeakAddr<A>

impl<A: Actor> Addr<A>

pub fn actor_id(&self) -> ActorId

Returns the id of the actor.

pub fn stop(&mut self, err: Option<Error>) -> Result<()>

Stop the actor.

pub fn stop_supervisor(&mut self, err: Option<Error>) -> Result<()>

Stop the supervisor.

this is ignored by normal actors

pub fn stopped(&self) -> bool

pub async fn call<T: Message>(&self, msg: T) -> Result<T::Result>

where A: Handler<T>,

Send a message msg to the actor and wait for the return value.

pub fn send<T: Message<Result = ()>>(&self, msg: T) -> Result<()>

where A: Handler<T>,

Send a message msg to the actor without waiting for the return value.

pub fn caller<T: Message>(&self) -> Caller<T>

where A: Handler<T>,

Create a Caller<T> for a specific message type

pub fn sender<T: Message<Result = ()>>(&self) -> Sender<T>

where A: Handler<T>,

Create a Sender<T> for a specific message type

pub async fn wait_for_stop(self)

Wait for an actor to finish, and if the actor has finished, the function returns immediately.

impl<T: Message<Result = ()> + Clone> Addr<Broker<T>>

pub fn publish(&mut self, msg: T) -> Result<()>

Publishes a message of the specified type.

Trait Implementations

impl<A> Clone for Addr<A>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A> Debug for Addr<A>

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

Formats the value using the given formatter.

impl<A> Hash for Addr<A>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A> PartialEq for Addr<A>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.