Enum EventResult 

pub enum EventResult {
    Consumed,
    ConsumedQuiet,
    Ignored,
}

What a widget returns from crate::widget::Widget::on_event.

Automatic invalidation

The framework’s event dispatcher (see [crate::widget::tree]) treats a Consumed result as “this widget changed something visible” and schedules a repaint via crate::animation::request_draw on the widget’s behalf. This makes the correct default automatic: the most common framework bug is a new widget that mutates paint-affecting state on an event but forgets to request a draw, so parts of it don’t repaint. With auto-invalidation a plain Consumed is always safe.

A widget that consumes a high-frequency event (typically MouseMove) without any visual change — for example, a hover affordance that only updates the OS cursor — should return ConsumedQuiet so it doesn’t schedule a wasteful repaint on every event. ConsumedQuiet still stops propagation exactly like Consumed; it only suppresses the automatic draw request.

Variants

Consumed

The widget handled the event and may have changed its appearance; stop propagation and schedule a repaint automatically.

ConsumedQuiet

The widget handled the event (stop propagation) but produced no visual change, so the dispatcher must NOT schedule a repaint. Use this only for genuinely quiet consumption of high-frequency events.

Ignored

The widget did not handle the event; continue bubbling up.

Implementations

impl EventResult

pub const fn is_consumed(self) -> bool

true for both Consumed and ConsumedQuiet.

Propagation, capture, and focus logic should branch on this rather than comparing against Consumed directly, so a quietly-consuming widget still stops the event exactly like a loud one.

pub const fn requests_redraw(self) -> bool

true only for Consumed — i.e. the dispatcher should call crate::animation::request_draw for this result. ConsumedQuiet and Ignored return false.

Trait Implementations

impl Clone for EventResult

fn clone(&self) -> EventResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EventResult

impl Debug for EventResult

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

Formats the value using the given formatter.

impl Eq for EventResult

impl PartialEq for EventResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EventResult