cushy::value

Struct Dynamic

source
pub struct Dynamic<T>(/* private fields */);
Expand description

An instance of a value that provides APIs to observe and react to its contents.

Implementations§

source§

impl<T> Dynamic<T>

source

pub fn new(value: T) -> Self

Creates a new instance wrapping value.

source

pub fn downgrade(&self) -> WeakDynamic<T>

Returns a weak reference to this dynamic.

This is powered by Arc/Weak and follows the same semantics for reference counting.

source

pub fn instances(&self) -> usize

Returns the number Dynamics that point to this same value.

The returned count includes self.

§Panics

This function panics if this value is already locked by the current thread.

source

pub fn readers(&self) -> usize

Returns the number of DynamicReaders for this value.

§Panics

This function panics if this value is already locked by the current thread.

source

pub fn linked<R, TIntoR, TIntoRResult, RIntoT, RIntoTResult>( &self, t_into_r: TIntoR, r_into_t: RIntoT, ) -> Dynamic<R>
where T: PartialEq + Send + 'static, R: PartialEq + Send + 'static, TIntoRResult: Into<Option<R>> + Send + 'static, RIntoTResult: Into<Option<T>> + Send + 'static, TIntoR: FnMut(&T) -> TIntoRResult + Send + 'static, RIntoT: FnMut(&R) -> RIntoTResult + Send + 'static,

Returns a new dynamic that has its contents linked with self by the pair of mapping functions provided.

When the returned dynamic is updated, r_into_t will be invoked. This function accepts &R and can return T, or Option<T>. If a value is produced, self will be updated with the new value.

When self is updated, t_into_r will be invoked. This function accepts &T and can return R or Option<R>. If a value is produced, the returned dynamic will be updated with the new value.

§Panics

This function panics if calling t_into_r with the current contents of the Dynamic produces a None value. This requirement is only for the first invocation, and it is guaranteed to occur before this function returns.

source

pub fn linked_string(&self) -> Dynamic<String>
where T: ToString + FromStr + PartialEq + Send + 'static,

Creates a linked dynamic containing a String.

When self is updated, ToString::to_string() will be called to produce a new string value to store in the returned dynamic.

When the returned dynamic is updated, str::parse is called to produce a new T. If an error is returned, self will not be updated. Otherwise, self will be updated with the produced value.

source

pub fn set_source(&self, source: CallbackHandle)

Sets the current source for this dynamic with source.

A dynamic can have multiple source callbacks.

This ensures that source stays active as long as any clones of self are alive.

source

pub fn with_for_each<F>(self, for_each: F) -> Self
where T: Send + 'static, F: for<'a> FnMut(&'a T) + Send + 'static,

Attaches for_each to this value so that it is invoked each time the value’s contents are updated. This function returns self.

source

pub fn with_clone<R>(&self, with_clone: impl FnOnce(Self) -> R) -> R

A helper function that invokes with_clone with a clone of self. This code may produce slightly more readable code.

use cushy::value::{Dynamic, Source};

let value = Dynamic::new(1);

// Using with_clone
value.with_clone(|value| {
    std::thread::spawn(move || {
        println!("{}", value.get());
    })
});

// Using an explicit clone
std::thread::spawn({
    let value = value.clone();
    move || {
        println!("{}", value.get());
    }
});

println!("{}", value.get());
source

pub fn create_reader(&self) -> DynamicReader<T>

Returns a new reference-based reader for this dynamic value.

§Panics

This function panics if this value is already locked by the current thread.

source

pub fn into_reader(self) -> DynamicReader<T>

Converts this Dynamic into a reader.

§Panics

This function panics if this value is already locked by the current thread.

source

pub fn lock(&self) -> DynamicGuard<'_, T>

Returns an exclusive reference to the contents of this dynamic.

This call will block until all other guards for this dynamic have been dropped.

§Panics

This function panics if this value is already locked by the current thread.

source

pub fn try_lock(&self) -> Result<DynamicGuard<'_, T>, DeadlockError>

Returns an exclusive reference to the contents of this dynamic.

This call will block until all other guards for this dynamic have been dropped.

§Errors

Returns an error if the current thread already holds a lock to this dynamic.

source

pub fn transition_to(&self, new_value: T) -> DynamicTransition<T>

Returns a pending transition for this value to new_value.

source

pub fn new_radio(&self, widget_value: T) -> Radio<T>
where Self: Clone, T: Clone + PartialEq,

Returns a new Radio that updates this dynamic to widget_value when pressed.

source

pub fn new_checkbox(&self) -> Checkbox

Returns a new checkbox that updates self when clicked.

source

pub fn new_select(&self, widget_value: T, label: impl MakeWidget) -> Select<T>
where Self: Clone, T: Clone + PartialEq,

Returns a new Select that updates this dynamic to widget_value when pressed. label is drawn next to the checkbox and is also clickable to select the widget.

source

pub fn validate_with<E, Valid>(&self, check: Valid) -> Dynamic<Validation>
where T: Send + 'static, Valid: for<'a> FnMut(&'a T) -> Result<(), E> + Send + 'static, E: Display,

Validates the contents of this dynamic using the check function, returning a dynamic that contains the validation status.

source§

impl Dynamic<WidgetInstance>

source

pub fn into_switcher(self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic.

source

pub fn to_switcher(&self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic.

source§

impl Dynamic<WidgetList>

source

pub fn into_rows(self) -> Stack

Returns self as a vertical Stack of rows.

source

pub fn to_rows(&self) -> Stack

Returns self as a vertical Stack of rows.

source

pub fn into_columns(self) -> Stack

Returns self as a horizontal Stack of columns.

source

pub fn to_columns(&self) -> Stack

Returns self as a horizontal Stack of columns.

source

pub fn into_layers(self) -> Layers

Returns self as Layers, with the widgets being stacked in the Z direction.

source

pub fn to_layers(&self) -> Layers

Returns self as Layers, with the widgets being stacked in the Z direction.

source

pub fn into_list(self) -> List

Returns self as an unordered List.

source

pub fn to_list(self) -> List

Returns self as an unordered List.

source

pub fn into_wrap(self) -> Wrap

Returns a Wrap that lays the children out horizontally, wrapping into additional rows as needed.

source

pub fn to_wrap(&self) -> Wrap

Returns a Wrap that lays the children out horizontally, wrapping into additional rows as needed.

Trait Implementations§

source§

impl<T> Clone for Dynamic<T>

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 Dynamic<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 Dynamic<T>
where T: Default,

source§

fn default() -> Self

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

impl<'de, T> Deserialize<'de> for Dynamic<T>
where T: Deserialize<'de>,

source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T> Destination<T> for Dynamic<T>

source§

fn try_map_mut<R>( &self, map: impl FnOnce(Mutable<'_, T>) -> R, ) -> Result<R, DeadlockError>

Maps the contents with exclusive access. Before returning from this function, all observers will be notified that the contents have been updated.
source§

fn map_mut<R>(&self, map: impl FnOnce(Mutable<'_, T>) -> R) -> R

Maps the contents with exclusive access. Before returning from this function, all observers will be notified that the contents have been updated. Read more
source§

impl<T> Displayable<T> for Dynamic<T>
where T: Debug + Display + Send + 'static,

source§

fn into_displayable(self) -> DynamicReader<T>

Returns this value as a displayable reader.
source§

fn into_label(self) -> Label<T>
where Self: Sized, T: Debug + Display + Send + 'static,

Returns self being Displayed in a Label widget.
source§

fn to_label(&self) -> Label<T>
where Self: Clone,

Returns self being Displayed in a Label widget.
source§

impl<T> Drop for Dynamic<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T> DynamicRead<T> for Dynamic<T>

source§

fn read(&self) -> DynamicGuard<'_, T, true>

Returns a guard that provides exclusive, read-only access to the value contained wihtin this dynamic.
source§

impl<'a, T> From<&'a Dynamic<T>> for WeakDynamic<T>

source§

fn from(value: &'a Dynamic<T>) -> Self

Converts to this type from the input type.
source§

impl From<&str> for Dynamic<String>

source§

fn from(value: &str) -> Self

Converts to this type from the input type.
source§

impl<T> From<Dynamic<T>> for DynamicReader<T>

source§

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.
source§

impl<T> From<Dynamic<T>> for ReadOnly<T>

source§

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.
source§

impl<T> From<Dynamic<T>> for Tracked<Dynamic<T>>
where T: Clone + PartialEq,

source§

fn from(source: Dynamic<T>) -> Self

Converts to this type from the input type.
source§

impl<T> From<Dynamic<T>> for Value<T>

source§

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.
source§

impl<T> From<Dynamic<T>> for WeakDynamic<T>

source§

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.
source§

impl From<String> for Dynamic<String>

source§

fn from(value: String) -> Self

Converts to this type from the input type.
source§

impl<T> IntoComponentValue for Dynamic<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 IntoDynamic<CheckboxState> for Dynamic<Option<bool>>

source§

fn into_dynamic(self) -> Dynamic<CheckboxState>

Returns self as a dynamic.
source§

impl IntoDynamic<CheckboxState> for Dynamic<bool>

source§

fn into_dynamic(self) -> Dynamic<CheckboxState>

Returns self as a dynamic.
source§

impl<T> IntoDynamic<T> for Dynamic<T>

source§

fn into_dynamic(self) -> Dynamic<T>

Returns self as a dynamic.
source§

impl<T, E> IntoDynamic<Validation> for Dynamic<Result<T, E>>
where T: Send + 'static, E: Display + Send + 'static,

source§

fn into_dynamic(self) -> Dynamic<Validation>

Returns self as a dynamic.
source§

impl<T> IntoDynamicComponentValue for Dynamic<T>
where T: ComponentDefinition + Clone + Send + Sync + 'static,

source§

fn into_dynamic_component(self) -> Value<DynamicComponent>

Returns this type converted into a dynamic component value.
source§

impl<T> IntoReadOnly<T> for Dynamic<T>

source§

fn into_read_only(self) -> ReadOnly<T>

Returns self as a ReadOnly.
source§

impl<T> IntoReader<T> for Dynamic<T>

source§

fn into_reader(self) -> DynamicReader<T>

Returns this value as a reader.
source§

impl IntoValue<ContainerShadow> for Dynamic<ContainerShadow<Lp>>

source§

fn into_value(self) -> Value<ContainerShadow>

Returns this type as a Value.
source§

impl IntoValue<ContainerShadow> for Dynamic<ContainerShadow<Px>>

source§

fn into_value(self) -> Value<ContainerShadow>

Returns this type as a Value.
source§

impl IntoValue<CowString> for Dynamic<&'static str>

source§

fn into_value(self) -> Value<CowString>

Returns this type as a Value.
source§

impl IntoValue<CowString> for Dynamic<String>

source§

fn into_value(self) -> Value<CowString>

Returns this type as a Value.
source§

impl IntoValue<MaskedString> for Dynamic<&'static str>

source§

fn into_value(self) -> Value<MaskedString>

Returns this type as a Value.
source§

impl IntoValue<MaskedString> for Dynamic<String>

source§

fn into_value(self) -> Value<MaskedString>

Returns this type as a Value.
source§

impl<T> IntoValue<T> for &Dynamic<T>

source§

fn into_value(self) -> Value<T>

Returns this type as a Value.
source§

impl<T> IntoValue<T> for Dynamic<T>

source§

fn into_value(self) -> Value<T>

Returns this type as a Value.
source§

impl IntoWidgetList for Dynamic<WidgetList>

source§

fn into_widget_list(self) -> Value<WidgetList>

Returns this list of widgets as a Value<WidgetList>.
source§

fn into_rows(self) -> Stack

Returns self as a vertical Stack of rows.
source§

fn into_columns(self) -> Stack

Returns self as a horizontal Stack of columns.
source§

fn into_layers(self) -> Layers

Returns self as Layers, with the widgets being stacked in the Z direction.
source§

fn into_wrap(self) -> Wrap

Returns a Wrap that lays the children out horizontally, wrapping into additional rows as needed.
source§

fn into_list(self) -> List

Returns self as an unordered List.
source§

impl MakeWidgetWithTag for Dynamic<&'static str>

source§

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

Returns a new WidgetInstance whose WidgetId comes from tag.
source§

impl MakeWidgetWithTag for Dynamic<Option<WidgetInstance>>

source§

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

Returns a new WidgetInstance whose WidgetId comes from tag.
source§

impl MakeWidgetWithTag for Dynamic<String>

source§

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

Returns a new WidgetInstance whose WidgetId comes from tag.
source§

impl MakeWidgetWithTag for Dynamic<WidgetInstance>

source§

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

Returns a new WidgetInstance whose WidgetId comes from tag.
source§

impl<T> PartialEq<Dynamic<T>> for WeakDynamic<T>

source§

fn eq(&self, other: &Dynamic<T>) -> 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.
source§

impl<T> PartialEq<WeakDynamic<T>> for Dynamic<T>

source§

fn eq(&self, other: &WeakDynamic<T>) -> 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.
source§

impl<T> PartialEq for Dynamic<T>

source§

fn eq(&self, other: &Self) -> 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.
source§

impl<T> Serialize for Dynamic<T>
where T: Serialize,

source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<T> Source<T> for Dynamic<T>

source§

fn try_map_generational<R>( &self, map: impl FnOnce(DynamicGuard<'_, T, true>) -> R, ) -> Result<R, DeadlockError>

Maps the contents with read-only access, providing access to the value’s Generation.
source§

fn for_each_subsequent_generational_try<F>(&self, for_each: F) -> CallbackHandle
where T: Send + 'static, F: for<'a> FnMut(DynamicGuard<'_, T, true>) -> Result<(), CallbackDisconnected> + Send + 'static,

Attaches for_each to this value so that it is invoked each time the source’s contents are updated. Read more
source§

fn for_each_generational_cloned_try<F>(&self, for_each: F) -> CallbackHandle
where T: Clone + Send + 'static, F: FnMut(GenerationalValue<T>) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes for_each with the current contents and each time this source’s contents are updated. Read more
source§

fn map_generational<R>( &self, map: impl FnOnce(DynamicGuard<'_, T, true>) -> R, ) -> R

Maps the contents with read-only access, providing access to the value’s Generation. Read more
source§

fn generation(&self) -> Generation

Returns the current generation of the value. Read more
source§

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

Maps the contents with read-only access. Read more
source§

fn try_map_ref<R>(&self, map: impl FnOnce(&T) -> R) -> Result<R, DeadlockError>

Maps the contents with read-only access.
source§

impl<T> Eq for Dynamic<T>

source§

impl<T> TrackedSource for Dynamic<T>
where T: Clone + PartialEq,

Auto Trait Implementations§

§

impl<T> Freeze for Dynamic<T>

§

impl<T> !RefUnwindSafe for Dynamic<T>

§

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

§

impl<T> Sync for Dynamic<T>
where T: Send,

§

impl<T> Unpin for Dynamic<T>

§

impl<T> !UnwindSafe for Dynamic<T>

Blanket Implementations§

source§

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>,

source§

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.
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 T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, C> ArraysFrom<C> for T
where 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 T
where 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 T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

source§

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

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

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

Converts self into C, using the provided parameters.
§

impl<A> Cast for A

§

fn cast<To>(self) -> To
where 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 B
where A: CastFrom<B>,

§

fn cast_into(self) -> A

Returns self as To.
source§

impl<T> Checkable for T

source§

fn into_checkbox(self) -> Checkbox

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

fn to_checkbox(&self) -> Checkbox
where Self: Clone,

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

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

source§

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

impl<T, C> ComponentsFrom<C> for T
where 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 T
where T: Any,

§

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

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>) -> Rc<dyn Any>

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 T
where T: Any + Send + Sync,

§

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

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

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<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<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
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 T
where 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 T
where T: IntoDynamic<Cow<'static, str>>,

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

fn to_input(&self) -> Input<Storage>
where Self: Clone,

Returns this string as a text input widget.
source§

impl<T> InputValue<CowString> for T

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

fn to_input(&self) -> Input<Storage>
where Self: Clone,

Returns this string as a text input widget.
source§

impl<T> InputValue<MaskedString> for T

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

fn to_input(&self) -> Input<Storage>
where Self: Clone,

Returns this string as a text input widget.
source§

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

source§

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.
source§

fn to_input(&self) -> Input<Storage>
where Self: Clone,

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

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

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

source§

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

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

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

Converts self into C, using the provided parameters.
source§

impl<T, U> IntoColor<U> for T
where 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 T
where 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> IntoEither for T

source§

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

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

impl<T> IntoReadOnly<T> for T

source§

fn into_read_only(self) -> ReadOnly<T>

Returns self as a ReadOnly.
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 T

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 T

source§

fn make_widget(self) -> WidgetInstance

Returns a new widget.
source§

fn into_window(self) -> Window

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

fn build_standalone_window(self) -> StandaloneWindowBuilder

Returns a builder for a standalone window. Read more
source§

fn build_recorder(self) -> VirtualRecorderBuilder<Rgb8>

Returns a builder for a VirtualRecorder
source§

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

Associates styles with this widget. Read more
source§

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

Associates a style component with self.
source§

fn with_local<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType>, ) -> Style

Associates a style component with self, ensuring that no child widgets inherit this component.
source§

fn with_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue, ) -> Style

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

fn with_local_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue, ) -> Style

Associates a style component with self, resolving its value using dynamic at runtime. This component will not be inherited to child widgets.
source§

fn with_shortcut<F>( self, key: impl Into<ShortcutKey>, modifiers: ModifiersState, callback: F, ) -> Shortcuts
where F: FnMut(KeyEvent) -> EventHandling + Send + 'static,

Invokes callback when key is pressed while modifiers are pressed. Read more
source§

fn with_repeating_shortcut<F>( self, key: impl Into<ShortcutKey>, modifiers: ModifiersState, callback: F, ) -> Shortcuts
where F: FnMut(KeyEvent) -> EventHandling + Send + 'static,

Invokes callback when key is pressed while modifiers are pressed. If the shortcut is held, the callback will be invoked on repeat events. Read more
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 hint(self) -> Style

Styles self as an informational hint message.
source§

fn with_hint(self, hint: impl MakeWidget) -> Stack

Attaches hint as an informational hint message below self. Read more
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) -> WidgetList

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

fn chain<W: MakeWidget>(self, others: impl IntoIterator<Item = W>) -> WidgetList

Chains self and others into a WidgetList.
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>) -> Resize
where 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 to_button(&self) -> Button
where Self: Clone,

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 to_checkbox(&self, value: impl IntoDynamic<CheckboxState>) -> Checkbox
where Self: Clone,

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 into_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 disclose(self) -> Disclose

Returns a new widget that allows hiding and showing contents.
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> MakeWindow for T
where T: MakeWidget,

source§

type Behavior = WidgetInstance

The behavior associated with this window.
source§

fn make_window(self) -> Window<<T as MakeWindow>::Behavior>

Returns a new window from self.
source§

fn open_centered<App>(self, app: &mut App) -> Result<WindowHandle>
where Self: Sized, App: Application + ?Sized,

Opens self in the center of the monitor the window initially appears on.
source§

fn run_centered(self) -> Result
where Self: Sized,

Runs self in the center of the monitor the window initially appears on.
source§

fn run_centered_in(self, app: PendingApp) -> Result
where Self: Sized,

Runs app after opening self in the center of the monitor the window initially appears on.
§

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

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
source§

impl<T> Open for T
where T: MakeWindow,

source§

fn open<App>(self, app: &mut App) -> Result<WindowHandle, EventLoopError>
where App: Application + ?Sized,

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

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

impl<T, U> Progressable<U> for T
where T: IntoReader<U> + Send, U: ProgressValue + Send,

source§

fn progress_bar(self) -> ProgressBar

Returns a new progress bar that displays progress from T::MIN to T::MAX.
source§

fn progress_bar_to(self, max: impl IntoReadOnly<T::Value>) -> ProgressBar
where T::Value: PartialEq + Ranged + Send + Clone,

Returns a new progress bar that displays progress from T::MIN to max. The maximum value can be either a T or an Option<T>. If None is the maximum value, an indeterminant progress bar will be displayed.
source§

fn progress_bar_between<Range>(self, range: Range) -> ProgressBar
where T::Value: Send, Range: IntoReadOnly<RangeInclusive<T::Value>>,

Returns a new progress bar that displays progress over the specified range of T. The range can be either a T..=T or an Option<T>. If None is specified as the range, an indeterminant progress bar will be displayed.
source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
source§

impl<T> Run for T
where 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 T
where 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 W
where W: IntoDynamic<T>,

source§

fn switcher<F>(self, map: F) -> Switcher
where 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) -> Switcher
where 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 T
where T: Clone,

source§

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<T> Trackable for T
where T: Trackable,

source§

fn redraw_when_changed(&self, context: &WidgetContext<'_>)
where Self: Sized,

Marks the widget for redraw when this value is updated. Read more
source§

fn invalidate_when_changed(&self, context: &WidgetContext<'_>)
where Self: Sized,

Marks the widget for redraw when this value is updated. Read more
source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

source§

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 T
where U: Into<T>,

source§

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 T
where U: TryFrom<T>,

source§

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 T
where 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 U
where 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 U
where 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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,