Struct actix::Recipient

pub struct Recipient<M: Message> where
    M: Message + Send,
    M::Result: Send,  { /* fields omitted */ }

The Recipient type allows to send one specific message to an actor.

You can get a recipient using the Addr::recipient() method. It is possible to use the Clone::clone() method to get a cloned recipient.

Methods

impl<M> Recipient<M> where
    M: Message + Send,
    M::Result: Send, 

pub fn do_send(&self, msg: M) -> Result<(), SendError<M>>

Sends a message.

Deliver the message even if the recipient's mailbox is full.

pub fn try_send(&self, msg: M) -> Result<(), SendError<M>>

Attempts to send a message.

This method fails if the actor's mailbox is full or closed. This method registers the current task in the receivers queue.

Important traits for RecipientRequest<M>

impl<M> Future for RecipientRequest<M> where
    M: Message + Send + 'static,
    M::Result: Send,  type Output = Result<M::Result, MailboxError>;

pub fn send(&self, msg: M) -> RecipientRequest<M>

Sends a message and asynchronously wait for a response.

The communication channel to the actor is bounded. If the returned Request object gets dropped, the message is cancelled.

pub fn connected(&self) -> bool

Trait Implementations

impl<M> Clone for Recipient<M> where
    M: Message + Send,
    M::Result: Send, 

fn clone(&self) -> Recipient<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Recipient<M> where
    M: Message + Send,
    M::Result: Send, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<M> Eq for Recipient<M> where
    M: Message + Send,
    M::Result: Send, 

impl<M> Hash for Recipient<M> where
    M: Message + Send,
    M::Result: Send, 

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, 

Feeds a slice of this type into the given [Hasher].

impl<A: Actor, M: Message + Send + 'static> Into<Recipient<M>> for Addr<A> where
    A: Handler<M>,
    M::Result: Send,
    A::Context: ToEnvelope<A, M>, 

fn into(self) -> Recipient<M>

Performs the conversion.

impl<M> PartialEq<Recipient<M>> for Recipient<M> where
    M: Message + Send,
    M::Result: Send, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.