Struct MessagePort

pub struct MessagePort<Intent, Effect> { /* private fields */ }

Domain-specific wrapper around a MessageSender

Implementations

impl<Intent, Effect> MessagePort<Intent, Effect>

pub fn new(message_tx: MessageSender<Intent, Effect>) -> Self

Create a new instance

pub fn into_inner(self) -> MessageSender<Intent, Effect>

Obtain the inner MessageSender for the channel

impl<Intent, Effect> MessagePort<Intent, Effect>

where Intent: Debug, Effect: Debug,

pub fn submit_message(&mut self, message: impl Into<Message<Intent, Effect>>)

Enqueue a message into the channel

A utility function that detects and logs unexpected send failures that the submitter should not be bothered with.

Submitting a message is a fire-and-forget operation that must always succeed. The framework is responsible for dealing with unexpected failures.

pub fn submit_intent(&mut self, intent: impl Into<Intent>)

Submit an intent

See also: Self::submit_message

pub fn submit_effect(&mut self, effect: impl Into<Effect>)

Submit an effect

See also: Self::submit_message

Trait Implementations

impl<Intent, Effect> Clone for MessagePort<Intent, Effect>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Intent: Debug, Effect: Debug> Debug for MessagePort<Intent, Effect>

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

Formats the value using the given formatter.