Enum rat_widget::event::Outcome

pub enum Outcome {
    Continue,
    Unchanged,
    Changed,
}

Expand description

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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

Formats the value using the given formatter. Read more

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

fn from(value: MenuOutcome) -> Self

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

fn from(value: ScrollOutcome) -> Outcome

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<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. Read more

impl HandleEvent<Event, Dialog, Outcome> for MsgDialogState

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

Handle an event. Read more

impl HandleEvent<Event, MouseOnly, Outcome> for Focus

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

impl HandleEvent<Event, MouseOnly, Outcome> for ParagraphState

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

Handle an event. Read more

impl HandleEvent<Event, MouseOnly, Outcome> for SplitState

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

Handle an event. Read more

impl HandleEvent<Event, MouseOnly, Outcome> for TableState<CellSelection>

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

impl HandleEvent<Event, MouseOnly, Outcome> for ViewState

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

Handle an event. Read more

impl HandleEvent<Event, Regular, Outcome> for Focus

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

impl HandleEvent<Event, Regular, Outcome> for ParagraphState

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

Handle an event. Read more

impl HandleEvent<Event, Regular, Outcome> for SplitState

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

Handle an event. Read more

impl HandleEvent<Event, Regular, Outcome> for TableState<CellSelection>

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

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

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

Handle an event. Read more

impl Ord for Outcome

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

This method returns an Ordering between self and other. Read more

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

impl PartialEq for Outcome

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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. Read more

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

impl Copy for Outcome

impl Eq for Outcome

impl StructuralPartialEq for Outcome

Auto Trait Implementations§

impl Freeze for Outcome

impl RefUnwindSafe for Outcome

impl Send for Outcome

impl Sync for Outcome

impl Unpin for Outcome

impl UnwindSafe for Outcome

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.