Struct mogwai::component::subscriber::Subscriber

pub struct Subscriber<Msg> { /* fields omitted */ }

A subscriber allows a component to subscribe to other components' messages without having explicit access to both Transmitter and Receiver. This allows the parent component to map child component messages into its own updates without needing its own transmitter. This is good because if send is called on a component's own ModelMsg transmitter during its Component::update it triggers a lock contetion. So a subscriber allows forwarding and wiring without enabling sending.

Implementations

impl<Msg: Clone + 'static> Subscriber<Msg>

pub fn new(tx: &Transmitter<Msg>) -> Subscriber<Msg>

Create a new Subscriber from a Transmitter.

pub fn subscribe_filter_map<ChildMsg, F>(&self, rx: &Receiver<ChildMsg>, f: F) where
    F: Fn(&ChildMsg) -> Option<Msg> + 'static, 

Subscribe to a receiver by forwarding messages from it using a filter map function.

pub fn subscribe_map<ChildMsg, F>(&self, rx: &Receiver<ChildMsg>, f: F) where
    F: Fn(&ChildMsg) -> Msg + 'static, 

Subscribe to a receiver by forwarding messages from it using a map function.

pub fn subscribe(&self, rx: &Receiver<Msg>)

Subscribe to a receiver by forwarding messages from it.

pub fn send_async<F>(&self, f: F) where
    F: Future<Output = Msg> + 'static, 

Send a one-time asynchronous message.

NOTE

This is only available in the browser, being compiled for wasm32. On other targets this is a noop.

Trait Implementations

impl<Msg: Clone> Clone for Subscriber<Msg>

pub fn clone(&self) -> Subscriber<Msg>

Returns a copy of the value.

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

Performs copy-assignment from source.