Struct thespis_impl::Addr

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

Reference implementation of thespis::Address<M>. It can be used to send all message types the actor implements thespis::Handler for.

When all Addr to a mailbox are dropped, the mailbox will end. There is also a WeakAddr that will not keep the actor alive.

Implementations

impl<A> Addr<A>where A: Actor,

pub fn builder(name: impl AsRef<str>) -> ActorBuilder<A>

Produces a builder for convenient creation of both Addr and Mailbox.

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

Create a new WeakAddr. This is an address that does not keep the mailbox alive.

pub fn info(&self) -> Arc<ActorInfo>

Information about the actor: id, name, typename and a span for tracing.

Trait Implementations

impl<A, M> Address<M> for Addr<A>where A: Actor + Handler<M>, M: Message,

fn call(&mut self, msg: M) -> Return<'_, ThesRes<<M as Message>::Return>>

Call an actor and receive the result of the call. This is a two-way operation. Calling with a message type that has Return=() will notify you that the message has been handled by the receiver.

fn clone_box(&self) -> BoxAddress<M, ThesErr>

Get a clone of this address as a Box<Address<M>>.

fn as_address(&self) -> &dyn Address<M, Error = Self::Error>where Self: Sized,

Upcast &self to &dyn Address.

impl<A: Actor> 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: Actor> Debug for Addr<A>

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

Formats the value using the given formatter.

impl<A: Actor> Display for Addr<A>

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

Formats the value using the given formatter.

impl<A: Actor> Drop for Addr<A>

fn drop(&mut self)

Executes the destructor for this type.

impl<A> Identify for Addr<A>where A: Actor,

fn id(&self) -> usize

Get the id of the mailbox this address sends to. There will be exactly one for each actor, so you can use this for uniquely identifying your actors.

This is an atomic usize that is incremented for every new mailbox. There currently is no overflow protection.

fn name(&self) -> Arc<str>

A human readable name of the actor.

impl<A: Actor> PartialEq<Addr<A>> for Addr<A>

Verify whether 2 Receivers will deliver to the same actor.

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<A, M> Sink<M> for Addr<A>where A: Actor + Handler<M>, M: Message,

fn poll_close( self: Pin<&mut Self>, cx: &mut TaskContext<'_> ) -> Poll<Result<(), Self::Error>>

This is a no-op. The address can only really close when dropped. Close has no meaning before that.

type Error = ThesErr

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut TaskContext<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: M) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut TaskContext<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

impl<A: Actor> Eq for Addr<A>