Struct quickwit_actors::Mailbox

source · [−]

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

Expand description

A mailbox is the object that makes it possible to send a message to an actor.

It is lightweight to clone.

The actor holds its Inbox counterpart.

The mailbox can accept:

Regular messages wrapped in envelopes. Their type depend on the actor and is defined when implementing the actor trait. (See [Envelope])
Commands (See Command). Commands have a higher priority than messages: whenever a command is available, it is guaranteed to be processed as soon as possible regardless of the presence of pending regular messages.

If all mailboxes are dropped, the actor will process all of the pending messages and gracefully exit with crate::actor::ActorExitStatus::Success.

Implementations

impl<A: Actor> Mailbox<A>

pub fn id(&self) -> &str

impl<A: Actor> Mailbox<A>

pub fn actor_instance_id(&self) -> &str

pub async fn send_message<M>(
    &self,
    message: M
) -> Result<Receiver<A::Reply>, SendError> where
    A: Handler<M>,
    M: 'static + Send + Sync + Debug,

Sends a message to the actor owning the associated inbox.

From an actor context, use the ActorContext::send_message method instead.

SendError is returned if the actor has already exited.

pub async fn send_command(&self, command: Command) -> Result<(), SendError>

pub async fn ask<M, T>(&self, message: M) -> Result<T, AskError<Infallible>> where
A: Handler<M, Reply = T>,
M: 'static + Send + Sync + Debug,

Similar to send_message, except this method waits asynchronously for the actor reply.

From an actor context, use the ActorContext::ask method instead.

pub async fn ask_for_res<M, T, E: Debug>(
    &self,
    message: M
) -> Result<T, AskError<E>> where
    A: Handler<M, Reply = Result<T, E>>,
    M: 'static + Send + Sync + Debug,

Similar to send_message, except this method waits asynchronously for the actor reply.

From an actor context, use the ActorContext::ask method instead.

Trait Implementations

impl<A: Actor> Clone for Mailbox<A>

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<A: Actor> Debug for Mailbox<A>

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

Formats the value using the given formatter. Read more

impl<A: Actor> Hash for Mailbox<A>

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

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

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

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

Auto Trait Implementations

impl<A> RefUnwindSafe for Mailbox<A>

impl<A> Send for Mailbox<A>

impl<A> Sync for Mailbox<A>

impl<A> Unpin for Mailbox<A>

impl<A> UnwindSafe for Mailbox<A>

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more