Struct OutputEffect 

pub struct OutputEffect<Msg> {
    pub name: Name,
    pub msg: Msg,
    /* private fields */
}

An effect that sends a message to an output channel.

This is used to send messages to the output stage, which is used to collect the results of the simulation.

The OutputEffect is created by StageGraph::output.

Fields

name: Name

msg: Msg

Implementations

impl<Msg> OutputEffect<Msg>

pub fn new(name: Name, msg: Msg, sender: Sender<Msg>) -> Self

pub fn fake(name: Name, msg: Msg) -> (Self, Receiver<Msg>)

Create a fake output effect for testing.

Trait Implementations

impl<Msg: Clone> Clone for OutputEffect<Msg>

fn clone(&self) -> OutputEffect<Msg>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Msg: SendData> Debug for OutputEffect<Msg>

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

Formats the value using the given formatter.

impl<'de, Msg> Deserialize<'de> for OutputEffect<Msg>

where Msg: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Msg> ExternalEffect for OutputEffect<Msg>

where Msg: SendData + PartialEq + Serialize + DeserializeOwned,

fn run( self: Box<Self>, _resources: Resources, ) -> BoxFuture<'static, Box<dyn SendData>>

Run the effect in production mode.

fn wrap( f: impl Future<Output = <Self as ExternalEffectAPI>::Response> + Send + 'static, ) -> BoxFuture<'static, Box<dyn SendData>>

where Self: Sized + ExternalEffectAPI,

Helper method for implementers of ExternalEffect.

fn wrap_sync( response: <Self as ExternalEffectAPI>::Response, ) -> BoxFuture<'static, Box<dyn SendData>>

where Self: Sized + ExternalEffectAPI,

Helper method for implementers of ExternalEffect that have a synchronous response.

impl<Msg> ExternalEffectAPI for OutputEffect<Msg>

where Msg: SendData + PartialEq + Serialize + DeserializeOwned,

type Response = ()

impl<Msg: SendData + PartialEq> PartialEq for OutputEffect<Msg>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Msg> Serialize for OutputEffect<Msg>

where Msg: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.