Struct Sender

pub struct Sender<M: 'static> { /* private fields */ }

Wraps a CanSend. This should be used to pass around an Arc<dyn CanSend>, instead of spelling out that type. Using a wrapper struct allows us to define more flexible APIs.

Implementations

impl<M> Sender<M>

pub fn send(&self, message: M)

Sends a message. It’s the responsibility of the underlying CanSend implementation to decide how to handle the message.

pub fn from_fn(send: impl Fn(M) + Send + Sync + 'static) -> Self

Creates a sender that handles messages using the given function.

pub fn break_apart(self) -> BreakApart<M>

Creates an object that implements CanSend<Inner> for any message Inner that can be converted to M.

impl<M, R: Send + 'static> Sender<MessageWithCallback<M, R>>

pub fn send_async( &self, message: M, ) -> BoxFuture<'static, Result<R, AsyncSendError>>

Same as the above, but for a concrete Sender type.

pub fn from_async_fn( send_async: impl Fn(M) -> R + Send + Sync + 'static, ) -> Self

Creates a sender that would handle send_async messages by producing a result synchronously. Note that the provided function is NOT async.

(Implementing the similar functionality with async function is possible but requires deciding who drives the async function; a FutureSpawner can be a good idea.)

Trait Implementations

impl<M> Clone for Sender<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.