Struct Mailbox

Source

pub struct Mailbox { /* private fields */ }

Expand description

A mailbox coordinates message delivery to actors through typed [Port]s associated with the mailbox.

Implementations§

Source §

impl Mailbox

Source

pub fn new(actor_id: ActorId, forwarder: BoxedMailboxSender) -> Self

Create a new mailbox associated with the provided actor ID, using the provided forwarder for external destinations.

Source

pub fn new_detached(actor_id: ActorId) -> Self

Create a new detached mailbox associated with the provided actor ID.

Source

pub fn actor_id(&self) -> &ActorId

The actor id associated with this mailbox.

Source

pub fn open_port<M: Message>(&self) -> (PortHandle<M>, PortReceiver<M>)

Open a new port that accepts M-typed messages. The returned port may be freely cloned, serialized, and passed around. The returned receiver should only be retained by the actor responsible for processing the delivered messages.

Source

pub fn open_accum_port<A>( &self, accum: A, ) -> (PortHandle<A::Update>, PortReceiver<A::State>)
where A: Accumulator + Send + Sync + 'static, A::Update: Message, A::State: Message + Default + Clone,

Open a new port with an accumulator. This port accepts A::Update type messages, accumulate them into A::State with the given accumulator. The latest changed state can be received from the returned receiver as a single A::State message. If there is no new update, the receiver will not receive any message.

Source

pub fn open_once_port<M: Message>( &self, ) -> (OncePortHandle<M>, OncePortReceiver<M>)

Open a new one-shot port that accepts M-typed messages. The returned port may be used to send a single message; ditto the receiver may receive a single message.

Source

pub fn bound_return_handle( &self, ) -> Option<PortHandle<Undeliverable<MessageEnvelope>>>

Retrieve the bound undeliverable message port handle.

Trait Implementations§

Source §

impl Clone for Mailbox

Source §

fn clone(&self) -> Mailbox

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Mailbox

Source §

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

Formats the value using the given formatter. Read more

Source §

impl MailboxSender for Mailbox

Source §

fn post( &self, envelope: MessageEnvelope, return_handle: PortHandle<Undeliverable<MessageEnvelope>>, )

Deliver a serialized message to the provided port ID. This method fails if the message does not deserialize into the expected type.

Auto Trait Implementations§

§

impl !UnwindSafe for Mailbox

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> BoxableMailboxSender for T
where T: MailboxSender + Clone + 'static,

Source §

fn boxed(&self) -> BoxedMailboxSender

A boxed clone of this MailboxSender.

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

Source §

impl<A, M> Handler<IndexedErasedUnbound<M>> for A
where A: Handler<M>, M: Castable,

Source §

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, A>, msg: IndexedErasedUnbound<M>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, A: 'async_trait,

Handle the next M-typed message.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoBoxedMailboxSender for T
where T: MailboxSender + 'static,

Source §

fn into_boxed(self) -> BoxedMailboxSender

Rehome this MailboxSender into a BoxedMailboxSender.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> MailboxServer for T
where T: MailboxSender + Clone + Sync + Send + 'static,

Source §

fn serve( self, rx: impl Rx<MessageEnvelope> + Send + 'static, ) -> MailboxServerHandle ⓘ

Serve the provided port on the given channel on this sender on a background task which may be joined with the returned handle. The task fails on any send error.

§