Skip to main content

Mailbox

Struct Mailbox 

Source
pub struct Mailbox<A>
where A: Actor,
{ /* private fields */ }
Available on crate feature actor only.
Expand description

A typed reference to an actor in a cluster.

Implementations§

Source§

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

Source

pub async fn call<M, R>(&self, message: M) -> Result<R, CallError<M>>
where A: Handler<Call<M, R>>, M: Message, R: Message,

Sends a request and waits for the actor’s reply.

Source§

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

Source

pub fn name(&self) -> Option<&str>

Returns the actor’s registered name.

Source

pub fn send<M>(&self, message: M) -> Result<(), DeliverError<M>>
where A: Handler<M>, M: Message,

Enqueues a message handled by this actor without waiting.

Source

pub fn broker<M>(&self) -> Broker<M>
where A: Handler<M>, M: Message,

Creates a send-only capability for one message type.

Source

pub fn stop(&self) -> bool

Requests a graceful stop, returning whether this call requested it.

Source

pub fn is_closed(&self) -> bool

Returns whether the mailbox rejects new messages.

Source

pub fn capacity(&self) -> NonZero<usize>

Returns the fixed mailbox capacity.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Mailbox<A>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<A> Freeze for Mailbox<A>
where Arc<MailboxInner<A>>: Freeze,

§

impl<A> RefUnwindSafe for Mailbox<A>
where Arc<MailboxInner<A>>: RefUnwindSafe,

§

impl<A> Send for Mailbox<A>
where Arc<MailboxInner<A>>: Send,

§

impl<A> Sync for Mailbox<A>
where Arc<MailboxInner<A>>: Sync,

§

impl<A> Unpin for Mailbox<A>
where Arc<MailboxInner<A>>: Unpin,

§

impl<A> UnsafeUnpin for Mailbox<A>
where Arc<MailboxInner<A>>: UnsafeUnpin,

§

impl<A> UnwindSafe for Mailbox<A>
where Arc<MailboxInner<A>>: UnwindSafe,

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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<U> 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> 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> Message for T
where T: Send + 'static,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

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