Struct Sender

pub struct Sender<P: Array> { /* private fields */ }

Sender is the mechanism used to send arbitrary bytes to a set of recipients over a pre-defined channel.

Trait Implementations

impl<P: Clone + Array> Clone for Sender<P>

fn clone(&self) -> Sender<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug + Array> Debug for Sender<P>

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

Formats the value using the given formatter.

impl<P: Array> Sender for Sender<P>

async fn send( &mut self, recipients: Recipients<Self::PublicKey>, message: Bytes, priority: bool, ) -> Result<Vec<Self::PublicKey>, Error>

Sends a message to a set of recipients.

Offline Recipients

If a recipient is offline at the time a message is sent, the message will be dropped. It is up to the application to handle retries (if necessary).

Parameters

• recipients - The set of recipients to send the message to.
• message - The message to send.
• priority - Whether the message should be sent with priority (across all channels).

Returns

If the message can be compressed (if enabled) and the message is < max_size, The set of recipients that the message was sent to. Note, a successful send does not mean that the recipient will receive the message (connection may no longer be active and we may not know that yet).

type Error = Error

Error that can occur when sending a message.

type PublicKey = P

Public key type used to identify recipients.