Struct round_based::Outgoing

pub struct Outgoing<M> {
    pub recipient: MessageDestination,
    pub msg: M,
}

Outgoing message

Fields

recipient: MessageDestination

Message destination: either one party (p2p message) or all parties (broadcast message)

msg: M

Message being sent

Implementations

impl<M> Outgoing<M>

pub fn broadcast(msg: M) -> Self

Constructs an outgoing message addressed to all parties

pub fn p2p(recipient: PartyIndex, msg: M) -> Self

Constructs an outgoing message addressed to one party

pub fn map<M2, F>(self, f: F) -> Outgoing<M2>

where F: FnOnce(M) -> M2,

Maps Outgoing<M> to Outgoing<M2> by applying a function to the message body

pub fn as_ref(&self) -> Outgoing<&M>

Converts &Outgoing<M> to Outgoing<&M>

pub fn is_broadcast(&self) -> bool

Checks whether it’s broadcast message

pub fn is_p2p(&self) -> bool

Checks whether it’s p2p message

Trait Implementations

impl<M: Clone> Clone for Outgoing<M>

fn clone(&self) -> Outgoing<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Outgoing<M>

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

Formats the value using the given formatter.

impl<M: PartialEq> PartialEq for Outgoing<M>

fn eq(&self, other: &Outgoing<M>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M> Sink<Outgoing<M>> for MockedOutgoing<M>

Available on crate feature dev only.

type Error = SendError<()>

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: Outgoing<M>) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<M> Sink<Outgoing<M>> for Outgoings<M>

Available on crate feature state-machine only.

type Error = SendErr

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: Outgoing<M>) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<M: Copy> Copy for Outgoing<M>

impl<M> StructuralPartialEq for Outgoing<M>