Enum rat_event::Outcome

pub enum Outcome {
    Continue,
    Unchanged,
    Changed,
}

The baseline outcome for an event-handler.

A widget can define its own type, if it has more things to report. It would be nice if those types are convertible to/from Outcome.

Variants

Continue

The given event has not been used at all.

Unchanged

The event has been recognized, but nothing noticeable has changed. Further processing for this event may stop. Rendering the ui is not necessary.

Changed

The event has been recognized and there is some change due to it. Further processing for this event may stop. Rendering the ui is advised.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConsumedEvent for Outcome

fn is_consumed(&self) -> bool

Is this the ‘consumed’ result.

fn or_else<F>(self, f: F) -> Self

where F: FnOnce() -> Self, Self: Sized,

Or-Else chaining with is_consumed() as the split.

fn or_else_try<F, E1>(self, f: F) -> Result<Self, E1>

where Self: Sized, F: FnOnce() -> Result<Self, E1>,

Or-Else chaining with is_consumed() as the split.

fn and<F>(self, f: F) -> Self

where Self: Sized + Ord, F: FnOnce() -> Self,

Then-chaining. Returns max(self, f()).

fn and_try<F, E1>(self, f: F) -> Result<Self, E1>

where Self: Sized + Ord, F: FnOnce() -> Result<Self, E1>,

Then-chaining. Returns max(self, f()).

impl Debug for Outcome

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

Formats the value using the given formatter.

impl From<bool> for Outcome

Widgets often define functions that return bool to indicate a changed state. This converts true / false to Outcome::Changed / Outcome::Unchanged.

fn from(value: bool) -> Self

Converts to this type from the input type.

impl<E, Q> HandleEvent<E, Q, Outcome> for ()

Catch all event-handler for the null state ().

fn handle(&mut self, _event: &E, _qualifier: Q) -> Outcome

Handle an event.

impl Ord for Outcome

fn cmp(&self, other: &Outcome) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Outcome

fn eq(&self, other: &Outcome) -> 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 PartialOrd for Outcome

fn partial_cmp(&self, other: &Outcome) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Outcome

impl Eq for Outcome

impl StructuralPartialEq for Outcome