Struct Address 

pub struct Address<A>
where
    A: Actor,
{ /* private fields */ }

The address of an actor.

It is used to send messages to an actor.

Implementations

impl<A> Address<A>

where A: Actor,

pub fn new(tx: Sender<Envelope<A>>) -> Self

Constructs a new Address from a mpsc::Sender.

Triggers Actor::type_erased_recipient_fn once (if the feature type-erased-recipient-hook is enabled) and stores the result.

pub fn index(&self) -> ActorId

Returns the index of the address.

pub fn closed(&self) -> impl Future<Output = ()> + Send

Completes when the mailbox of the actor has been closed.

pub fn is_closed(&self) -> bool

Checks if the mailbox of the actor is closed.

pub fn capacity(&self) -> usize

Returns the current capacity of the mailbox of the actor.

pub fn send<M, EP>( &self, msg: M, ) -> impl Future<Output = SendResult<M>> + Send + '_

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Sends a message, waiting until there is capacity, and returns a Receiver which can be used to receive the message response.

pub fn do_send<M, EP>( &self, msg: M, ) -> impl Future<Output = DoSendResult<M>> + Send + '_

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Sends a message, waiting until there is capacity, without expecting a response.

pub fn try_send<M, EP>(&self, msg: M) -> SendResult<M>

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Attempts to immediately send a message and returns a Receiver which can be used to receive the message response.

pub fn try_do_send<M, EP>(&self, msg: M) -> DoSendResult<M>

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Attempts to immediately send a message without expecting a response.

pub fn send_timeout<M, EP>( &self, msg: M, timeout: Duration, ) -> impl Future<Output = SendResult<M>> + Send + '_

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Sends a message, waiting until there is capacity, but only for a limited time, and returns a Receiver which can be used to receive the message response.

pub fn do_send_timeout<M, EP>( &self, msg: M, timeout: Duration, ) -> impl Future<Output = DoSendResult<M>> + Send + '_

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Sends a message, waiting until there is capacity, but only for a limited time, without expecting a response.

pub fn blocking_send<M, EP>(&self, msg: M) -> SendResult<M>

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Blocking send to call outside of asynchronous contexts.

This method is intended for use cases where you are sending from synchronous code to asynchronous code.

Panics

This function panics if called within an asynchronous execution context.

pub fn blocking_do_send<M, EP>(&self, msg: M) -> DoSendResult<M>

where A: Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

Blocking do_send to call outside of asynchronous contexts.

This method is intended for use cases where you are sending from synchronous code to asynchronous code.

Panics

This function panics if called within an asynchronous execution context.

pub fn reserve( &self, ) -> impl Future<Output = Result<SendPermit<'_, A>, SendError<()>>> + Send

Reserves channel capacity to send one message.

This method borrows the internal mpsc::Sender and returns a SendPermit.

pub fn try_reserve(&self) -> Result<SendPermit<'_, A>, SendError<()>>

Attempts to reserve channel capacity to send one message.

This method borrows the internal mpsc::Sender and returns a SendPermit.

pub fn reserve_owned( &self, ) -> impl Future<Output = Result<OwnedSendPermit<A>, SendError<()>>> + Send

Reserves channel capacity to send one message.

This method clones the internal mpsc::Sender and returns a OwnedSendPermit.

pub fn try_reserve_owned(&self) -> Result<OwnedSendPermit<A>, SendError<()>>

Attempts to reserve channel capacity to send one message.

This method clones the internal mpsc::Sender and returns a OwnedSendPermit.

pub fn type_erased_recipient(&self) -> Option<TypeErasedRecipient>

Available on crate feature type-erased-recipient-hook only.

Returns a type-erased trait object which can be downcast into a concrete Recipient<M>, where M is a specific message type chosen by the user who overrides the Actor::type_erased_recipient_fn method.

This method triggers the conversion function baked in this address at construction, and returns the resulting type-erased trait object.

Trait Implementations

impl<A> Clone for Address<A>

where A: Actor,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Debug for Address<A>

where A: Actor,

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

Formats the value using the given formatter.

impl<A, M, EP> From<Address<A>> for Recipient<M, EP>

where A: Actor + Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

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

Converts to this type from the input type.

impl<A> Hash for Address<A>

where A: Actor,

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

where H: Hasher,

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 Address<A>

where A: Actor,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A, M, EP> Sender<M, EP> for Address<A>

where A: Actor + Handler<M> + ToEnvelope<A, M, EP> + FromEnvelope<A, M, EP>, M: Message,

fn closed(&self) -> ClosedResultFuture<'_>

Completes when the receiver has been closed.

fn is_closed(&self) -> bool

Checks if the channel has been closed.

fn capacity(&self) -> usize

Returns the current capacity of the channel.

fn send(&self, msg: M) -> SendResultFuture<'_, M>

Sends a message, waiting until there is capacity, and returns a Receiver which can be used to receive the message response.

fn do_send(&self, msg: M) -> DoSendResultFuture<'_, M>

Sends a message, waiting until there is capacity, without expecting a response.

fn send_timeout(&self, msg: M, timeout: Duration) -> SendResultFuture<'_, M>

Sends a message, waiting until there is capacity, but only for a limited time, and returns a Receiver which can be used to receive the message response.

fn do_send_timeout( &self, msg: M, timeout: Duration, ) -> DoSendResultFuture<'_, M>

Sends a message, waiting until there is capacity, but only for a limited time, without expecting a response.

fn try_send(&self, msg: M) -> SendResult<M>

Attempts to immediately send a message and returns a Receiver which can be used to receive the message response.

fn try_do_send(&self, msg: M) -> DoSendResult<M>

Attempts to immediately send a message without expecting a response.

fn blocking_send(&self, msg: M) -> SendResult<M>

Blocking send to call outside of asynchronous contexts.

fn blocking_do_send(&self, msg: M) -> DoSendResult<M>

Blocking do_send to call outside of asynchronous contexts.

fn type_erased_recipient(&self) -> Option<TypeErasedRecipient>

Available on crate feature type-erased-recipient-hook only.

Returns a type-erased trait object which can be downcast into a concrete Recipient<M>, where M is a specific message type chosen by the user who overrides the Actor::type_erased_recipient_fn method.

impl<A> SenderId for Address<A>

where A: Actor,

fn index(&self) -> ActorId

Returns the index of the sender.

fn is_remote(&self) -> bool

Available on crate feature ipc only.

Returns true if this sender refers to an actor in another process.

impl<A> Eq for Address<A>

where A: Actor,