Struct zng_app::event::AnyEvent

pub struct AnyEvent { /* private fields */ }

Represents an Event without the args type.

Implementations

impl AnyEvent

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

Name of the event static item.

pub fn is<A: EventArgs>(&self, event: &Event<A>) -> bool

Returns true if self is the type erased event.

pub fn has(&self, update: &EventUpdate) -> bool

Returns true if the update is for this event.

pub fn hook( &self, hook: impl Fn(&mut EventUpdate) -> bool + Send + Sync + 'static, ) -> EventHandle

Register a callback that is called just before an event begins notifying.

pub fn subscribe(&self, widget_id: WidgetId) -> EventHandle

Register the widget to receive targeted events from this event.

Widgets only receive events if they are in the delivery list generated by the event args and are subscribers to the event. App extensions receive all events.

pub fn is_subscriber(&self, widget_id: WidgetId) -> bool

Returns true if the widget is subscribed to this event.

pub fn has_subscribers(&self) -> bool

Returns true if at least one widget is subscribed to this event.

pub fn visit_subscribers(&self, visit: impl FnMut(WidgetId))

Calls visit for each widget subscribed to this event.

Note that trying to subscribe or add hook inside visit will deadlock. Inside visit you can notify the event and generate event updates.

pub fn has_hooks(&self) -> bool

Returns true if any app level callback is registered for this event.

This includes AnyEvent::hook, Event::on_pre_event, Event::on_event and Event::receiver.

Trait Implementations

impl Clone for AnyEvent

fn clone(&self) -> AnyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnyEvent

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

Formats the value using the given formatter.

impl Hash for AnyEvent

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A: EventArgs> PartialEq<AnyEvent> for Event<A>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A: EventArgs> PartialEq<Event<A>> for AnyEvent

fn eq(&self, other: &Event<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for AnyEvent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl UpdateSubscribers for AnyEvent

fn contains(&self, widget_id: WidgetId) -> bool

Returns true if the widget is one of the subscribers.

fn to_set(&self) -> IdSet<WidgetId>

Gets all subscribers as a set.

impl Copy for AnyEvent

impl Eq for AnyEvent