Struct PostOffice

pub struct PostOffice<T> { /* private fields */ }

Implementations

impl<T> PostOffice<T>

where T: Send + 'static,

pub fn new(cleanup: Duration) -> Self

Creates a new post office that delivers to mailboxes, cleaning up orphaned mailboxes waiting cleanup time inbetween attempts

pub async fn make_mailbox(&self, id: Id, buffer: usize) -> Mailbox<T>

Creates a new mailbox using the given id and buffer size for maximum values that can be queued in the mailbox

pub async fn deliver(&self, id: &Id, value: T) -> bool

Delivers some value to appropriate mailbox, returning false if no mailbox is found for the specified id or if the mailbox is no longer receiving values

pub async fn assign_default_mailbox(&self, buffer: usize) -> Mailbox<T>

Creates a new default mailbox that will be used whenever no mailbox is found to deliver mail. This will replace any existing default mailbox.

pub async fn remove_default_mailbox(&self)

Removes the default mailbox such that any mail without a matching mailbox will be dropped instead of being delivered to a default mailbox.

pub async fn has_default_mailbox(&self) -> bool

Returns true if the post office is using a default mailbox for all mail that does not map to another mailbox.

pub async fn cancel(&self, id: &Id)

Cancels delivery to the mailbox with the specified id.

pub async fn cancel_many(&self, ids: impl Iterator<Item = &Id>)

Cancels delivery to the mailboxes with the specified ids.

pub async fn cancel_all(&self)

Cancels delivery to all mailboxes.

impl<T> PostOffice<Response<T>>

where T: Send + 'static,

pub async fn deliver_response(&self, res: Response<T>) -> bool

Delivers some response to appropriate mailbox, returning false if no mailbox is found for the response’s origin or if the mailbox is no longer receiving values

impl PostOffice<UntypedResponse<'static>>

pub async fn deliver_untyped_response( &self, res: UntypedResponse<'static>, ) -> bool

Delivers some response to appropriate mailbox, returning false if no mailbox is found for the response’s origin or if the mailbox is no longer receiving values

Trait Implementations

impl<T: Clone> Clone for PostOffice<T>

fn clone(&self) -> PostOffice<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PostOffice<T>

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

Formats the value using the given formatter.

impl<T> Default for PostOffice<T>

where T: Send + 'static,

fn default() -> Self

Creates a new postoffice with a cleanup interval of 60s