Struct relm_state::EventStream

pub struct EventStream<MSG> { /* fields omitted */ }

A stream of messages to be used for widget/signal communication and inter-widget communication.

Methods

impl<MSG> EventStream<MSG>

pub fn new() -> EventStream<MSG>

Create a new event stream.

pub fn close(&self)

Close the event stream, i.e. stop processing messages.

pub fn emit(&self, event: MSG)

Send the event message to the stream and the observers.

pub fn lock(&self) -> Lock<MSG>

Lock the stream (don't emit message) until the Lock goes out of scope.

pub fn observe<CALLBACK>(&self, callback: CALLBACK) where
    CALLBACK: 'static + Fn(&MSG), 

Add an observer to the event stream. This callback will be called every time a message is emmited.

pub fn set_callback<CALLBACK>(&self, callback: CALLBACK) where
    CALLBACK: 'static + FnMut(MSG), 

Add a callback to the event stream. This is the main callback and received a owned version of the message, in contrast to observe().

Trait Implementations

impl<MSG> Clone for EventStream<MSG>

fn clone(&self) -> EventStream<MSG>

Returns a copy of the value.

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

Performs copy-assignment from source.