Struct actix::Recipient

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

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.

Implementations

impl<M> Recipient<M>

where M: Message + Send, M::Result: Send,

pub fn do_send(&self, msg: M)

Sends a message.

The message is always queued, even if the mailbox for the receiver is full. If the mailbox is closed, the message is silently dropped.

Examples found in repository

examples/weak_recipient.rs (line 29)

    fn send_tick(&mut self, _ctx: &mut Context<Self>) {
        for client in self.clients.iter() {
            if let Some(client) = client.upgrade() {
                client.do_send(TimePing(Instant::now()));
                println!("⏰ sent ping to client {:?}", client);
            } else {
                println!("⏰ client can no longer be upgraded");
            }
        }

        // gc
        self.clients = self
            .clients
            .drain(..)
            .filter(|c| c.upgrade().is_some())
            .collect();
        println!("⏰ service has {} clients", self.clients.len());
    }

examples/ring.rs (line 54)

    fn handle(&mut self, msg: Payload, _: &mut Context<Self>) {
        if msg.0 >= self.limit {
            println!(
                "Actor {} reached limit of {} (payload was {})",
                self.id, self.limit, msg.0
            );

            System::current().stop();
            return;
        }

        // Some prime in order for different actors to report progress.
        // Large enough to print about once per second in debug mode.
        if msg.0 % 498989 == 1 {
            println!(
                "Actor {} received message {} of {} ({:.2}%)",
                self.id,
                msg.0,
                self.limit,
                100.0 * msg.0 as f32 / self.limit as f32
            );
        }

        self.next.do_send(Payload(msg.0 + 1));
    }

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.

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 RecipientRequest object gets dropped, the message is cancelled.

pub fn connected(&self) -> bool

pub fn downgrade(&self) -> WeakRecipient<M>

Returns a downgraded WeakRecipient

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<A, M: Message + Send + 'static> From<Addr<A>> for Recipient<M>

where A: Handler<M> + Actor, M::Result: Send, A::Context: ToEnvelope<A, M>,

fn from(addr: Addr<A>) -> Self

Converts to this type from the input type.

impl<M> From<Recipient<M>> for WeakRecipient<M>

where M: Message + Send, M::Result: Send,

fn from(recipient: Recipient<M>) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<M> PartialEq 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 ==.

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.

impl<M> Eq for Recipient<M>

where M: Message + Send, M::Result: Send,