Enum 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 and implement ConsumedEvent as well.

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 duplicate 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, E>(self, f: F) -> Result<Self, E>

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

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

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

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

And_then-chaining based on is_consumed(). Returns max(self, f()).

fn and_then_try<F, E>(self, f: F) -> Result<Self, E>

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

And_then-chaining based on is_consumed(). Returns max(self, f()).

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

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

👎Deprecated since 1.2.2: use and_then()

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

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

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

👎Deprecated since 1.2.2: use and_then_try()

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

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Default for Outcome

fn default() -> Outcome

Returns the “default value” for a type.

impl From<ButtonOutcome> for Outcome

fn from(value: ButtonOutcome) -> Self

Converts to this type from the input type.

impl From<CalOutcome> for Outcome

fn from(value: CalOutcome) -> Self

Converts to this type from the input type.

impl From<CheckOutcome> for Outcome

fn from(value: CheckOutcome) -> Self

Converts to this type from the input type.

impl From<ChoiceOutcome> for Outcome

fn from(value: ChoiceOutcome) -> Self

Converts to this type from the input type.

impl From<ComboboxOutcome> for Outcome

fn from(value: ComboboxOutcome) -> Self

Converts to this type from the input type.

impl From<DialogOutcome> for Outcome

fn from(value: DialogOutcome) -> Self

Converts to this type from the input type.

impl From<DoubleClickOutcome> for Outcome

fn from(value: DoubleClickOutcome) -> Outcome

Converts to this type from the input type.

impl From<EditOutcome> for Outcome

fn from(value: EditOutcome) -> Outcome

Converts to this type from the input type.

impl From<FileOutcome> for Outcome

fn from(value: FileOutcome) -> Self

Converts to this type from the input type.

impl From<FormOutcome> for Outcome

fn from(value: FormOutcome) -> Self

Converts to this type from the input type.

impl From<MenuOutcome> for Outcome

fn from(value: MenuOutcome) -> Outcome

Converts to this type from the input type.

impl From<Outcome> for CalOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for ChoiceOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for ComboboxOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for DialogOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for DoubleClickOutcome

fn from(value: Outcome) -> DoubleClickOutcome

Converts to this type from the input type.

impl From<Outcome> for EditOutcome

fn from(value: Outcome) -> EditOutcome

Converts to this type from the input type.

impl From<Outcome> for FileOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for FormOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for MenuOutcome

fn from(value: Outcome) -> MenuOutcome

Converts to this type from the input type.

impl From<Outcome> for TabbedOutcome

fn from(value: Outcome) -> Self

Converts to this type from the input type.

impl From<Outcome> for TextOutcome

fn from(value: Outcome) -> TextOutcome

Converts to this type from the input type.

impl From<PopupOutcome> for Outcome

fn from(value: PopupOutcome) -> Outcome

Converts to this type from the input type.

impl From<RadioOutcome> for Outcome

fn from(value: RadioOutcome) -> Self

Converts to this type from the input type.

impl From<ScrollOutcome> for Outcome

fn from(value: ScrollOutcome) -> Outcome

Converts to this type from the input type.

impl From<SliderOutcome> for Outcome

fn from(value: SliderOutcome) -> Self

Converts to this type from the input type.

impl From<TabbedOutcome> for Outcome

fn from(value: TabbedOutcome) -> Self

Converts to this type from the input type.

impl From<TableOutcome> for Outcome

fn from(value: TableOutcome) -> Outcome

Converts to this type from the input type.

impl From<TextOutcome> for Outcome

fn from(value: TextOutcome) -> Outcome

Converts to this type from the input type.

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) -> Outcome

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 HandleEvent<Event, Dialog, Outcome> for MsgDialogState

fn handle(&mut self, event: &Event, _: Dialog) -> Outcome

Handle an event.

impl<W> HandleEvent<Event, MouseOnly, Outcome> for ClipperState<W>

where W: Eq + Clone + Hash,

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for Focus

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for LineNumberState

fn handle(&mut self, _event: &Event, _qualifier: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ListState<RowSelection>

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ListState<NoSelection>

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ListState<RowSetSelection>

fn handle(&mut self, event: &Event, _: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ParagraphState

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for SplitState

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for StatusLineState

fn handle(&mut self, _event: &Event, _qualifier: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ViewState

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> Outcome

Handle an event.

impl<W> HandleEvent<Event, Regular, Outcome> for ClipperState<W>

where W: Eq + Clone + Hash,

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for Focus

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for LineNumberState

fn handle(&mut self, _event: &Event, _qualifier: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ListState<RowSelection>

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ListState<NoSelection>

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ListState<RowSetSelection>

fn handle(&mut self, event: &Event, _: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ParagraphState

fn handle(&mut self, event: &Event, _qualifier: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for SplitState

fn handle(&mut self, event: &Event, _qualifier: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for StatusLineState

fn handle(&mut self, _event: &Event, _qualifier: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ViewState

fn handle(&mut self, event: &Event, _qualifier: Regular) -> 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,

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