Struct Scope

Source
pub struct Scope<C: Component> { /* private fields */ }
Expand description

A channel for sending messages to a Component.

Implementations§

Source§

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

Source

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.

Source

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

Get the name of the component this Scope belongs to.

Trait Implementations§

Source§

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

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<C: Component> Debug for Scope<C>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

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

Source§

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.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Auto Trait Implementations§

§

impl<C> Freeze for Scope<C>

§

impl<C> !RefUnwindSafe for Scope<C>

§

impl<C> Send for Scope<C>

§

impl<C> Sync for Scope<C>

§

impl<C> Unpin for Scope<C>

§

impl<C> !UnwindSafe for Scope<C>

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.