Struct ComponentEvent 

pub struct ComponentEvent<'d, C: 'static, D> { /* private fields */ }

A helper type that contains the event target and the event detail.

It implements Deref<ComponentRc<C>> so that any associated function in ComponentRc<C> can be visited.

Implementations

impl<'d, C: 'static, D> ComponentEvent<'d, C, D>

pub fn new(rc: ComponentRc<C>, detail: &'d mut D) -> Self

Create with event target and detail.

pub fn rc(&self) -> ComponentRc<C>

Get the target component.

pub fn clone_detail(&self) -> D

where D: Clone,

Clone the event detail.

pub fn detail(&self) -> &D

Get the event detail.

pub fn detail_mut(&mut self) -> &mut D

Get the mutable reference of the event detail.

Methods from Deref<Target = ComponentRc<C>>

pub fn task<R: 'static>(&self, f: impl 'static + FnOnce(&mut C) -> R)

Schedule an update in another task, getting the component mutable reference.

The f will be called asynchronously. The template is always updated after f being called. Panics if any error occurred during update.

pub fn task_with<R: 'static>( &self, f: impl 'static + FnOnce(&mut C, &mut ComponentMutCtx) -> R, )

Schedule an update in another task, getting the component mutable reference.

The f will be called asynchronously. If the template is needed to be updated, ComponentMutCtx::need_update should be called during f execution. Panics if any error occurred during update.

pub async fn update<R: 'static>( &self, f: impl 'static + FnOnce(&mut C) -> R, ) -> Result<R, Error>

Schedule an update, getting the component mutable reference.

The f will be called asynchronously. The template is always updated after f being called.

pub async fn update_with<R: 'static>( &self, f: impl 'static + FnOnce(&mut C, &mut ComponentMutCtx) -> R, ) -> Result<R, Error>

Schedule a visiting task, getting the component mutable reference.

The f will be called asynchronously. If the template is needed to be updated, ComponentMutCtx::need_update should be called during f execution.

pub async fn get<R: 'static>(&self, f: impl 'static + FnOnce(&C) -> R) -> R

Schedule a visiting task, getting the component reference.

The f will be called asynchronously.

Trait Implementations

impl<'d, C: 'static, D> Deref for ComponentEvent<'d, C, D>

type Target = ComponentRc<C>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.