Enum EventResult 

pub enum EventResult {
    Ignored,
    Consumed,
    Render,
}

Re-export of the pi-tui component contract for downstream callers. Result of dispatching a UiEvent to a component.

Variants

Ignored

Event was not handled; fall through to the next handler.

Consumed

Event was handled; no immediate repaint is required.

Render

Event was handled and the component needs a repaint on this loop turn.

Implementations

impl EventResult

pub const fn merge(self, other: EventResult) -> EventResult

Combine two results, preferring the stronger outcome.

Strength order: Render > Consumed > Ignored.

pub const fn is_handled(self) -> bool

Returns true when the event was not ignored.

pub const fn needs_render(self) -> bool

Returns true when a repaint should run on the current loop turn.

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<(), Error>

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