Enum gooey::value::Value

source ·
pub enum Value<T> {
    Constant(T),
    Dynamic(Dynamic<T>),
}
Expand description

A value that may be either constant or dynamic.

Variants§

§

Constant(T)

A value that will not ever change externally.

§

Dynamic(Dynamic<T>)

A value that may be updated externally.

Implementations§

source§

impl<T> Value<T>

source

pub fn dynamic(value: T) -> Self

Returns a Value::Dynamic containing value.

source

pub fn map<R>(&self, map: impl FnOnce(&T) -> R) -> R

Maps the current contents to map and returns the result.

source

pub fn map_tracking_redraw<R>( &self, context: &WidgetContext<'_, '_>, map: impl FnOnce(&T) -> R ) -> R

Maps the current contents to map and returns the result.

If self is a dynamic, context will be invalidated when the value is updated.

source

pub fn map_tracking_invalidate<R>( &self, context: &WidgetContext<'_, '_>, map: impl FnOnce(&T) -> R ) -> R

Maps the current contents to map and returns the result.

If self is a dynamic, context will be invalidated when the value is updated.

source

pub fn map_mut<R>(&mut self, map: impl FnOnce(&mut T) -> R) -> R

Maps the current contents with exclusive access and returns the result.

source

pub fn map_each<R, F>(&self, map: F) -> Value<R>where T: Send + 'static, F: for<'a> FnMut(&'a T) -> R + Send + 'static, R: PartialEq + Send + 'static,

Returns a new value that is updated using U::from(T.clone()) each time self is updated.

source

pub fn get(&self) -> Twhere T: Clone,

Returns a clone of the currently stored value.

source

pub fn get_tracking_redraw(&self, context: &WidgetContext<'_, '_>) -> Twhere T: Clone,

Returns a clone of the currently stored value.

If self is a dynamic, context will be refreshed when the value is updated.

source

pub fn get_tracking_invalidate(&self, context: &WidgetContext<'_, '_>) -> Twhere T: Clone,

Returns a clone of the currently stored value.

If self is a dynamic, context will be invalidated when the value is updated.

source

pub fn generation(&self) -> Option<Generation>

Returns the current generation of the data stored, if the contained value is Dynamic.

source

pub fn redraw_when_changed(&self, context: &WidgetContext<'_, '_>)

Marks the widget for redraw when this value is updated.

This function has no effect if the value is constant.

source

pub fn invalidate_when_changed(&self, context: &WidgetContext<'_, '_>)

Marks the widget for redraw when this value is updated.

This function has no effect if the value is constant.

Trait Implementations§

source§

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

source§

fn clone(&self) -> Self

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
source§

impl<T> Debug for Value<T>where T: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Default for Value<T>where T: Default,

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<T> IntoComponentValue for Value<T>where T: Clone + Send + 'static, Component: From<T>,

source§

fn into_component_value(self) -> Value<Component>

Returns self stored in a component value.
source§

impl<T> IntoDynamic<T> for Value<T>

source§

fn into_dynamic(self) -> Dynamic<T>

Returns self as a dynamic.
source§

impl<T> IntoValue<T> for Value<T>

source§

fn into_value(self) -> Value<T>

Returns this type as a Value.
source§

impl MakeWidgetWithTag for Value<String>

source§

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Value<T>where T: RefUnwindSafe,

§

impl<T> Send for Value<T>where T: Send,

§

impl<T> Sync for Value<T>where T: Send + Sync,

§

impl<T> Unpin for Value<T>where T: Unpin,

§

impl<T> UnwindSafe for Value<T>where T: UnwindSafe,

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

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

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

fn adapt_into(self) -> D

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

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

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

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<A> Cast for A

§

fn cast<To>(self) -> Towhere To: CastFrom<A>,

Casts self to the To type. This may be a lossy operation.
§

impl<A> CastFrom<A> for A

§

fn from_cast(from: A) -> A

Returns from as Self.
§

impl<A, B> CastInto<A> for Bwhere A: CastFrom<B>,

§

fn cast_into(self) -> A

Returns self as To.
source§

impl<T> Checkable for Twhere T: IntoDynamic<CheckboxState>,

source§

fn into_checkbox(self, label: impl MakeWidget) -> Checkbox

Returns a new checkbox using self as the value and label.
source§

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

source§

fn components_from(colors: C) -> T

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

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T, Global>) -> Arc<dyn Any + Sync + Send, Global>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

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

source§

fn from_stimulus(other: U) -> T

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

impl<T> InputValue<Cow<'static, str>> for Twhere T: IntoDynamic<Cow<'static, str>>,

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

impl<T> InputValue<CowString> for Twhere T: IntoDynamic<CowString>,

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

impl<T> InputValue<MaskedString> for Twhere T: IntoDynamic<MaskedString>,

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

impl<T> InputValue<String> for Twhere T: IntoDynamic<String>,

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T, U> IntoAngle<U> for Twhere U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

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

source§

fn into_color(self) -> U

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

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

source§

fn into_color_unclamped(self) -> U

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

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

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

impl<T> IntoStoredComponent for Twhere T: IntoComponentValue,

source§

fn into_stored_component(self) -> StoredComponent

Returns this value as a stored component.
source§

impl<T> IntoValue<Option<T>> for T

source§

fn into_value(self) -> Value<Option<T>>

Returns this type as a Value.
source§

impl<T> IntoValue<T> for T

source§

fn into_value(self) -> Value<T>

Returns this type as a Value.
source§

impl<T> MakeWidget for Twhere T: MakeWidgetWithTag,

source§

fn make_widget(self) -> WidgetInstance

Returns a new widget.
source§

fn into_window(self) -> Window<WidgetInstance>

Returns a new window containing self as the root widget.
source§

fn with_styles(self, styles: impl IntoValue<Styles>) -> Stylewhere Self: Sized,

Associates styles with this widget. Read more
source§

fn with<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType> ) -> Stylewhere Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self.
source§

fn with_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue ) -> Stylewhere Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self, resolving its value using dynamic at runtime.
source§

fn h1(self) -> Style

Styles self with the largest of 6 heading styles.
source§

fn h2(self) -> Style

Styles self with the second largest of 6 heading styles.
source§

fn h3(self) -> Style

Styles self with the third largest of 6 heading styles.
source§

fn h4(self) -> Style

Styles self with the third smallest of 6 heading styles.
source§

fn h5(self) -> Style

Styles self with the second smallest of 6 heading styles.
source§

fn h6(self) -> Style

Styles self with the smallest of 6 heading styles.
source§

fn xxxx_large(self) -> Style

Styles self with the largest text size.
source§

fn xxx_large(self) -> Style

Styles self with the second largest text size.
source§

fn xx_large(self) -> Style

Styles self with the third largest text size.
source§

fn x_large(self) -> Style

Styles self with the fourth largest text size.
source§

fn large(self) -> Style

Styles self with the fifth largest text size.
source§

fn default_size(self) -> Style

Styles self with the third smallest text size.
source§

fn small(self) -> Style

Styles self with the second smallest text size.
source§

fn x_small(self) -> Style

Styles self with the smallest text size.
source§

fn with_next_focus( self, next_focus: impl IntoValue<Option<WidgetId>> ) -> WidgetInstance

Sets the widget that should be focused next. Read more
source§

fn with_enabled(self, enabled: impl IntoValue<bool>) -> WidgetInstance

Sets this widget to be enabled/disabled based on enabled and returns self. Read more
source§

fn into_default(self) -> WidgetInstance

Sets this widget as a “default” widget. Read more
source§

fn into_escape(self) -> WidgetInstance

Sets this widget as an “escape” widget. Read more
source§

fn and(self, other: impl MakeWidget) -> Children

Returns a collection of widgets using self and other.
source§

fn expand(self) -> Expand

Expands self to grow to fill its parent.
source§

fn expand_weighted(self, weight: u8) -> Expand

Expands self to grow to fill its parent proportionally with other weighted siblings.
source§

fn expand_horizontally(self) -> Expand

Expands self to grow to fill its parent horizontally.
source§

fn expand_vertically(self) -> Expand

Expands self to grow to fill its parent vertically.
source§

fn size<T>(self, size: Size<T>) -> Resizewhere T: Into<DimensionRange>,

Resizes self to size.
source§

fn width(self, width: impl Into<DimensionRange>) -> Resize

Resizes self to width. Read more
source§

fn height(self, height: impl Into<DimensionRange>) -> Resize

Resizes self to height. Read more
source§

fn into_button(self) -> Button

Returns this widget as the contents of a clickable button.
source§

fn into_checkbox(self, value: impl IntoDynamic<CheckboxState>) -> Checkbox

Returns this widget as the label of a Checkbox.
source§

fn centered(self) -> Align

Aligns self to the center vertically and horizontally.
source§

fn align_left(self) -> Align

Aligns self to the left.
source§

fn align_right(self) -> Align

Aligns self to the right.
source§

fn align_top(self) -> Align

Aligns self to the top.
source§

fn align_bottom(self) -> Align

Aligns self to the bottom.
source§

fn fit_horizontally(self) -> Align

Fits self horizontally within its parent.
source§

fn fit_vertically(self) -> Align

Fits self vertically within its parent.
source§

fn scroll(self) -> Scroll

Allows scrolling self both vertically and horizontally.
source§

fn vertical_scroll(self) -> Scroll

Allows scrolling self vertically.
source§

fn horizontal_scroll(self) -> Scroll

Allows scrolling self horizontally.
source§

fn widget_ref(self) -> WidgetRef

Creates a WidgetRef for use as child widget.
source§

fn contain(self) -> Container

Wraps self in a Container.
source§

fn contain_level(self, level: impl IntoValue<ContainerLevel>) -> Container

Wraps self in a Container with the specified level.
source§

fn background_color(self, color: impl IntoValue<Color>) -> Container

Returns a new widget that renders color behind self.
source§

fn pad(self) -> Container

Wraps self with the default padding.
source§

fn pad_by(self, padding: impl IntoValue<Edges<Dimension>>) -> Container

Wraps self with the specified padding.
source§

fn themed(self, theme: impl IntoValue<ThemePair>) -> Themed

Applies theme to self and its children.
source§

fn themed_mode(self, mode: impl IntoValue<ThemeMode>) -> ThemedMode

Applies mode to self and its children.
source§

fn collapse_horizontally( self, collapse_when: impl IntoDynamic<bool> ) -> Collapse

Returns a widget that collapses self horizontally based on the dynamic boolean value. Read more
source§

fn collapse_vertically(self, collapse_when: impl IntoDynamic<bool>) -> Collapse

Returns a widget that collapses self vertically based on the dynamic boolean value. Read more
source§

fn validation(self, validation: impl IntoDynamic<Validation>) -> Validated

Returns a widget that shows validation errors and/or hints.
source§

fn tooltip(self, layer: &OverlayLayer, tip: impl MakeWidget) -> Tooltipped

Returns a widget that shows tip on layer when self is hovered.
source§

impl<T> Open for Twhere T: MakeWidget,

source§

fn open<App>(self, app: &App) -> Result<Option<WindowHandle>, EventLoopError>where App: Application,

Opens the provided type as a window inside of app.
source§

fn run_in(self, app: PendingApp) -> Result<(), EventLoopError>

Runs the provided type inside of the pending app, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.
source§

impl<T> Run for Twhere T: MakeWidget,

source§

fn run(self) -> Result<(), EventLoopError>

Runs the provided type, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.
source§

impl<U, T> Slidable<U> for Twhere T: IntoDynamic<U>, U: SliderValue,

source§

fn slider(self) -> Slider<T>where T::Value: Ranged,

Returns a new slider over the full range of the type.
source§

fn slider_between( self, min: impl IntoValue<T::Value>, max: impl IntoValue<T::Value> ) -> Slider<T>

Returns a new slider using the value of self. The slider will be limited to values between min and max.
source§

impl<T, W> Switchable<T> for Wwhere W: IntoDynamic<T>,

source§

fn switcher<F>(self, map: F) -> Switcherwhere F: FnMut(&T, &Dynamic<T>) -> WidgetInstance + Send + 'static, T: Send + 'static,

Returns a new Switcher whose contents is the result of invoking map each time self is updated.
source§

fn switch_between<Collection>(self, map: Collection) -> Switcherwhere Collection: GetWidget<T> + Send + 'static, T: Send + 'static,

Returns a new Switcher whose contents switches between the values contained in map using the value in self as the key.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<'a, T, C> TryComponentsInto<C> for Twhere C: TryFromComponents<T>,

§

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

The error for when try_into_colors fails to cast.
source§

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
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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
source§

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

source§

fn uints_from(colors: C) -> U

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

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

source§

fn uints_into(self) -> C

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> WasmNotSend for Twhere T: Send,

§

impl<T> WasmNotSync for Twhere T: Sync,