Struct zi::ComponentLink

pub struct ComponentLink<ComponentT> { /* fields omitted */ }

A context for sending messages to a component or the runtime.

It can be used in a multi-threaded environment (implements Sync and Send). Additionally, it can send messages to the runtime, in particular it's used to gracefully stop a running App.

Implementations

impl<ComponentT: Component> ComponentLink<ComponentT>

pub fn send(&self, message: ComponentT::Message)

Sends a message to the component.

pub fn callback<InputT>(
    &self,
    callback: impl Fn(InputT) -> ComponentT::Message + 'static
) -> Callback<InputT>

Creates a Callback which will send a message to the linked component's update method when invoked.

pub fn exit(&self)

Sends a message to the App runtime requesting it to stop executing.

This method only sends a message and returns immediately, the app will stop asynchronously and may deliver other pending messages before exiting.

pub fn run_exclusive(
    &self,
    process: impl FnOnce() -> Option<ComponentT::Message> + Send + 'static
)

Runs a closure that requires exclusive access to the backend (i.e. typically to stdin / stdout). For example spawning an external editor to collect some text.

Trait Implementations

impl<ComponentT> Clone for ComponentLink<ComponentT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ComponentT: Debug> Debug for ComponentLink<ComponentT>

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

Formats the value using the given formatter.