Struct zi::ComponentLink

source · [−]

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

Expand description

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

source

impl<ComponentT: Component> ComponentLink<ComponentT>

source

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

Sends a message to the component.

source

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.

source

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.

Trait Implementations

source

impl<ComponentT> Clone for ComponentLink<ComponentT>

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

impl<ComponentT> PartialEq<ComponentLink<ComponentT>> for ComponentLink<ComponentT>

source

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

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

1.0.0 · source

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

This method tests for !=.

Auto Trait Implementations

impl<ComponentT> !RefUnwindSafe for ComponentLink<ComponentT>

impl<ComponentT> Send for ComponentLink<ComponentT>

impl<ComponentT> !Sync for ComponentLink<ComponentT>

impl<ComponentT> Unpin for ComponentLink<ComponentT>

impl<ComponentT> !UnwindSafe for ComponentLink<ComponentT>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct zi::ComponentLink

Implementations

impl<ComponentT: Component> ComponentLink<ComponentT>

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

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

pub fn exit(&self)

Trait Implementations

impl<ComponentT> Clone for ComponentLink<ComponentT>

fn clone(&self) -> Self

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

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

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

impl<ComponentT> PartialEq<ComponentLink<ComponentT>> for ComponentLink<ComponentT>

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

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

Auto Trait Implementations

impl<ComponentT> !RefUnwindSafe for ComponentLink<ComponentT>

impl<ComponentT> Send for ComponentLink<ComponentT>

impl<ComponentT> !Sync for ComponentLink<ComponentT>

impl<ComponentT> Unpin for ComponentLink<ComponentT>

impl<ComponentT> !UnwindSafe for ComponentLink<ComponentT>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,