Skip to main content

ComponentContext

Struct ComponentContext 

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

Capabilities available while creating or updating a component.

Messages sent through this context are queued and delivered after the current lifecycle call.

Implementations§

Source§

impl<C: Component> ComponentContext<C>

Source

pub fn open_window(&self, root: View) -> bool

Requests a new application-owned window with an independent Pump.

Source

pub fn sender(&self) -> LocalSender<C::Message>

Returns a sender bound to this component instance.

Source

pub fn spawn_background<F>(&self, work: F) -> ComponentTask
where C::Message: Send, F: FnOnce(CancellationToken) -> C::Message + Send + 'static,

Starts scope-owned work on the Windows thread pool.

Expected application failures should be represented in the returned message. A panic in work or failure to submit to the Windows thread pool is fatal.

Source

pub fn spawn_background_with_rejection<F>( &self, work: F, rejected: C::Message, ) -> ComponentTask
where C::Message: Send, F: FnOnce(CancellationToken) -> C::Message + Send + 'static,

Starts scope-owned work and dispatches rejected if bounded delivery rejects it.

Cancellation and scope retirement do not dispatch rejected. A panic in work or failure to submit to the Windows thread pool is fatal.

Source

pub fn window(&self) -> WindowRef

Returns a token-bound capability for the component’s owning window.

Auto Trait Implementations§

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.