Skip to main content

Mailbox

Struct Mailbox 

Source
pub struct Mailbox { /* private fields */ }
Expand description

MPSC mailbox for an actor.

Uses lock-free bounded queues internally. Backpressure is coordinated via a semaphore; async wakeup via Notify.

Implementations§

Source§

impl Mailbox

Source

pub fn new(actor_id: ActorId, config: MailboxConfig) -> Self

Create a new mailbox.

Source

pub fn try_send(&self, message: Message) -> Result<(), (Message, Error)>

Try to send a message to the mailbox (non-blocking).

Source

pub async fn send(&self, message: Message) -> Result<()>

Send a message to the mailbox (async, waits if full).

Source

pub fn try_recv(&self) -> Option<Message>

Receive a message from the mailbox (non-blocking).

Source

pub async fn recv(&self) -> Message

Receive a message from the mailbox (async, waits if empty).

Uses tokio::sync::Notify for efficient wakeup instead of busy-polling. The Notified future is created and enabled before the emptiness check, so a notify_waiters racing with this call cannot be missed (lost-wakeup).

Source

pub fn len(&self) -> usize

Get the current queue size.

Source

pub fn is_empty(&self) -> bool

Check if the mailbox is empty.

Source

pub fn is_backpressured(&self) -> bool

Check if the mailbox is in backpressure state.

Source

pub fn capacity(&self) -> usize

Get the mailbox capacity.

Source

pub fn remaining_capacity(&self) -> usize

Get remaining capacity.

Source

pub fn clear(&self)

Clear all messages from the mailbox.

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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