Skip to main content

EventRegistry

Struct EventRegistry 

Source
pub struct EventRegistry { /* private fields */ }
Expand description

Thread-safe registration and dispatch container for lifecycle callbacks.

Dispatch clones one Arc snapshot without allocating and releases the lock before invoking callbacks. A dispatch already in progress may finish with its original snapshot; registration and removal affect future dispatches. Nested dispatch observes the current snapshot at the time it starts.

Implementations§

Source§

impl EventRegistry

Source

pub fn on_event<F>(&self, handler: F) -> Result<(), EventRegistrationError>
where F: Fn(&DesktopEvent) -> EventResponse + Send + Sync + 'static,

Register a callback that remains installed until the registry closes.

§Errors

Returns EventRegistrationError when the registry reached its handler cap, has closed, or its state is unavailable after a callback panic.

Source

pub fn subscribe<F>( &self, handler: F, ) -> Result<EventSubscription, EventRegistrationError>
where F: Fn(&DesktopEvent) -> EventResponse + Send + Sync + 'static,

Register a callback removed automatically when its subscription drops.

§Errors

Returns EventRegistrationError when the registry reached its handler cap, has closed, or its state is unavailable after a callback panic.

Source

pub fn dispatch(&self, event: &DesktopEvent) -> EventResponse

Dispatch an event and report cancellation.

Every handler in the dispatch snapshot observes the event even after one cancels it, so the outcome does not depend on registration order.

Trait Implementations§

Source§

impl Clone for EventRegistry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for EventRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> 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 = !

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.