Struct vgtk::Scope

pub struct Scope<C: Component> { /* fields omitted */ }

A channel for sending messages to a Component.

Methods

impl<C: 'static + Component> Scope<C>

pub fn try_send(
    &self,
    message: C::Message
) -> Result<(), TrySendError<C::Message>>

Attempt to send a message to the component this Scope belongs to.

This should always succeed if the component is running.

If you receive an error, this generally means the component has unmounted and the scope has become invalid.

If the message is sent successfully, it will show up at your component's Component::update() method presently.

Never call this from inside a signal handler. It's important that you follow the usual pattern of returning messages from signal handler closures, or you risk unexpected side effects and potential infinite loops.

pub fn name(&self) -> &'static str

Get the name of the component this Scope belongs to.

Trait Implementations

impl<C: Component> Clone for Scope<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Component> Debug for Scope<C>

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

Formats the value using the given formatter.

impl<C: Component> Eq for Scope<C>

impl<C: Component> Hash for Scope<C>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<C: Component> PartialEq<Scope<C>> for Scope<C>

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

Test whether two Scopes are equal.

Two scopes are considered equal if they belong to the same component instance, in other words if they send their messages to the same destination.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.