Struct asynchronix::simulation::Mailbox

pub struct Mailbox<M: Model>(_);

A model mailbox.

A mailbox is an entity associated to a model instance that collects all messages sent to that model. The size of its internal buffer can be optionally specified at construction time using with_capacity.

Implementations

impl<M: Model> Mailbox<M>

pub const DEFAULT_CAPACITY: usize = 16usize

Default capacity when created with new or Default::default.

pub fn new() -> Self

Creates a new mailbox with capacity Self::DEFAULT_CAPACITY.

pub fn with_capacity(capacity: usize) -> Self

Creates a new mailbox with the specified capacity.

Panic

The constructor will panic if the requested capacity is 0 or is greater than usize::MAX/2 + 1.

pub fn address(&self) -> Address<M>

Returns a handle to this mailbox.

Trait Implementations

impl<M: Model> Debug for Mailbox<M>

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

Formats the value using the given formatter.

impl<M: Model> Default for Mailbox<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: Model> From<&Mailbox<M>> for Address<M>

fn from(s: &Mailbox<M>) -> Address<M>

Converts a Mailbox reference into an Address.

This calls Mailbox::address() on the mailbox and returns the address.