Struct ockam_core::Mailboxes

pub struct Mailboxes { /* private fields */ }

A collection of Mailboxes for a [Context]

Implementations

impl Mailboxes

pub fn new(main_mailbox: Mailbox, additional_mailboxes: Vec<Mailbox>) -> Self

Create a new collection of Mailboxes from the given Mailboxes

pub fn main(
    address: impl Into<Address>,
    incoming_access_control: Arc<dyn IncomingAccessControl>,
    outgoing_access_control: Arc<dyn OutgoingAccessControl>
) -> Self

Create a new collection of Mailboxes for the given Address with IncomingAccessControl and OutgoingAccessControl

pub fn aliases(&self) -> Vec<Address>

Return an [AddressSet] containing all addresses represented by these Mailboxes

pub fn main_address(&self) -> Address

Return the main Address for these Mailboxes

pub fn contains(&self, msg_addr: &Address) -> bool

Return true if the given Address is represented by these Mailboxes

pub fn find_mailbox(&self, msg_addr: &Address) -> Option<&Mailbox>

Return a reference to the Mailbox with the given Address

pub async fn is_incoming_authorized(
    &self,
    relay_msg: &RelayMessage
) -> Result<bool>

Return true if the given Address is authorized to post the given RelayMessage to these Mailboxes TODO docs are confusing

pub async fn is_outgoing_authorized(
    &self,
    relay_msg: &RelayMessage
) -> Result<bool>

Return true if these Mailboxes are authorized to post the given RelayMessage to the given Address TODO docs are confusing

pub fn addresses(&self) -> Vec<Address>

Return the [AddressSet] represented by these Mailboxes

pub fn main_mailbox(&self) -> &Mailbox

Return a reference to the main Mailbox for this collection of Mailboxes

pub fn additional_mailboxes(&self) -> &Vec<Mailbox>

Return a reference to the additional Mailboxes for this collection of Mailboxes

Trait Implementations

impl Clone for Mailboxes

fn clone(&self) -> Mailboxes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mailboxes

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

Formats the value using the given formatter.