Outcome

rat_widget::event

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

impl Default for Outcome

fn default() -> Outcome

Returns the “default value” for a type. 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<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. Read more

impl HandleEvent<Event, Dialog, Outcome> for MsgDialogState

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

Handle an event. Read more

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. 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 LineNumberState

fn handle(&mut self, _event: &Event, _qualifier: 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<NoSelection>

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 StatusLineState

fn handle(&mut self, _event: &Event, _qualifier: 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<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. 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 LineNumberState

fn handle(&mut self, _event: &Event, _qualifier: 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<NoSelection>

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 StatusLineState

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

Handle an event. Read more

impl HandleEvent<Event, Regular, Outcome> for ViewState

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

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<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.

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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.

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

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromAngle<T> for T

fn from_angle(angle: T) -> T

Performs a conversion from angle.

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.

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, U> IntoAngle<U> for T
where U: FromAngle<T>,

fn into_angle(self) -> U

Performs a conversion into T.

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

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> IntoStimulus<T> for T

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.

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, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. 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.

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.