Struct Address 

pub struct Address<C = dyn AnyChannel>
where
    C: DynChannel + ?Sized,
{ /* private fields */ }

An address is a reference to the actor, used to send messages.

Addresses can be of two forms:

• Address<Channel<M>>: This is the default form, which can be used to send messages of type M. It can be transformed into an Address using Address::into_dyn.
• Address: This form is a dynamic address, which can do everything a normal address can do, except for sending messages. It can be transformed back into an Address<Channel<M>> using Address::downcast::.

An address can be awaited which returns once the actor exits.

Implementations

impl<C> Address<C>

where C: DynChannel + ?Sized,

pub fn downcast<M: Send + 'static>(self) -> Result<Address<Channel<M>>, Self>

where C: AnyChannel,

Attempt to the downcast the Address into an Address<Channel<M>>.

pub fn close(&self) -> bool

Close the Channel.

pub fn halt(&self)

Halt the actor.

This also closes the Inbox.

pub fn halt_some(&self, n: u32)

Halt n processes.

pub fn process_count(&self) -> usize

Get the amount of processes.

pub fn msg_count(&self) -> usize

Get the amount of messages in the Channel.

pub fn address_count(&self) -> usize

Get the amount of Addresses of the Channel.

pub fn is_closed(&self) -> bool

Whether the Channel is closed.

pub fn is_bounded(&self) -> bool

pub fn capacity(&self) -> &Capacity

Get the Capacity of the Channel.

pub fn has_exited(&self) -> bool

Whether all processes have exited.

pub fn actor_id(&self) -> u64

Get the actor’s id.

impl<M> Address<Channel<M>>

pub fn into_dyn(self) -> Address

where M: Send + 'static,

Convert the Address<Channel<M>> into an Address.

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

Attempt to send a message to the actor.

• In the case of an unbounded Channel, when BackPressure returns a timeout this fails.
• In the case of a bounded Channel, when it is full this fails.

For bounded channels, this method is the same as send_now.

pub fn send_now(&self, msg: M) -> Result<(), TrySendError<M>>

Attempt to send a message to the actor.

• In the case of an unbounded Channel, any BackPressure is ignored.
• In the case of a bounded Channel, when it is full this fails.

For bounded channels, this method is the same as try_send.

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

Attempt to send a message to the actor.

• In the case of an unbounded Channel, when BackPressure returns a timeout this waits untill the timeout is over.
• In the case of a bounded Channel, when it is full this waits untill space is available.

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

Same as send but it blocking the OS-thread.

Trait Implementations

impl<C: DynChannel + ?Sized> Clone for Address<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Address<C>

where C: DynChannel + ?Sized + Debug,

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

Formats the value using the given formatter.

impl<C: DynChannel + ?Sized> Drop for Address<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: DynChannel + ?Sized> Future for Address<C>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<C: DynChannel + ?Sized> Unpin for Address<C>