Enum rat_event::Outcome

pub enum Outcome {
    NotUsed,
    Unchanged,
    Changed,
}

A baseline Outcome for event-handling.

A widget can define its own, if it has more things to report. It would be nice of the widget though, if its outcome would be convertible to this baseline.

Variants

NotUsed

The given event has not been used at all.

Unchanged

The event has been recognized, but the result was nil. Further processing for this event may stop.

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 BitOr for Outcome

fn bitor(self, rhs: Self) -> Self::Output

Returns max(left, right).

That means Outcome::NotUsed | Outcome::Changed == Outcome::Changed, which should be the expected result.

type Output = Outcome

The resulting type after applying the | operator.

impl BitOrAssign for Outcome

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

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

impl Debug for Outcome

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

Formats the value using the given formatter.

impl From<bool> for Outcome

Event functions in widgets often return bool to indicate a meaningful change occured. This converts true / false to Outcome::Changed / Outcome::Unchanged.

fn from(value: bool) -> Self

Converts to this type from the input type.

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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