Skip to main content

Dynamic

Struct Dynamic 

Source
pub struct Dynamic(/* private fields */);
Expand description

A dynamic view that can be updated.

Represents a view whose content can be changed dynamically at runtime.

You should avoid using this component if possible, most of components in WaterUI already provide a way to update their content reactively.

Implementations§

Source§

impl Dynamic

Source

pub fn new() -> (DynamicHandler, Self)

Creates a new Dynamic view along with its handler.

Returns a tuple of (handler, view) where the handler can be used to update the view’s content.

§Returns

A tuple containing the DynamicHandler and Dynamic view

Source

pub fn watch<T, S, V: View>(value: S, f: impl 'static + Fn(T) -> V) -> impl View
where S: Signal<Output = T> + 'static, T: 'static,

Creates a Dynamic view that watches structural reactive state.

The provided function is used to convert the value to a view. Whenever the watched value changes, the entire child subtree is replaced. State owned by the replaced subtree is discarded. Prefer signal-aware component inputs, modifiers, metadata, and reactive collections for scalar values or collection membership. Use this only when the semantic view structure itself must change.

§Arguments
  • value - The reactive value to watch
  • f - A function that converts the value to a view
§Returns

A Dynamic view that updates when the value changes

Source

pub fn connect(self, receiver: impl Fn(Context<AnyView>) + 'static)

Connects the Dynamic view to a receiver function.

For internal use only.

The receiver function is called whenever the view content is updated. If there’s a temporary view stored (set before connecting), it will be immediately passed to the receiver.

§Arguments
  • receiver - A function that receives view updates
Source

pub fn connect_with_pending_view( self, pending_view_slot: Rc<RefCell<Option<AnyView>>>, receiver: impl Fn(Context<AnyView>) + 'static, )

Connects the dynamic node while preserving a pending measurement view.

This is used by renderers that need to stage a temporary child view before the final backend receiver is attached.

Source

pub fn identity(&self) -> usize

Returns a stable identity for this dynamic node.

Source

pub fn with_unconnected_view<R>( &self, f: impl FnOnce(Option<&AnyView>) -> R, ) -> Option<R>

Reads the current pre-connection view snapshot, if this dynamic node has not been connected yet.

Returns None when the node is already connected to a backend receiver.

Source

pub fn with_unconnected_view_mut<R>( &self, f: impl FnOnce(&mut Option<AnyView>) -> R, ) -> Option<R>

Mutates the current pre-connection view snapshot before the dynamic node connects.

Returns None when the node is already connected to a backend receiver.

Source

pub fn with_measurement_view_mut<R>( &self, f: impl FnOnce(&mut Option<AnyView>) -> R, ) -> Option<R>

Mutates whichever view snapshot should be used for layout measurement.

Before connection this is the unconnected snapshot; after connection it targets the pending connected snapshot when one exists.

Source

pub fn with_connected_pending_view_mut<R>( &self, f: impl FnOnce(&mut Option<AnyView>) -> R, ) -> Option<R>

Mutates the pending connected snapshot without affecting the pre-connection snapshot.

Trait Implementations§

Source§

impl Clone for Dynamic

Source§

fn clone(&self) -> Dynamic

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Dynamic

Source§

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

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

impl NativeView for Dynamic

Source§

fn stretch_axis(&self) -> StretchAxis

Which axis (or axes) this view stretches to fill available space.
Source§

impl View for Dynamic

Source§

fn body(self, _env: &Environment) -> impl View

Build this view and return the content. Read more

Auto Trait Implementations§

Blanket Implementations§

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

Source§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> IdentifiableExt for T

Source§

fn use_id<F, Id>(self, f: F) -> UseId<Self, F>
where F: Fn(&Self) -> Id, Id: Ord + Hash,

Wraps the value in a UseId with the provided identification function.
Source§

fn self_id(self) -> SelfId<Self>

Wraps the value in a SelfId, making the value serve as its own identifier.
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<V> IntoView for V
where V: View,

Source§

type Output = V

The resulting View type after conversion.
Source§

fn into_view(self, _env: &Environment) -> <V as IntoView>::Output

Converts the implementing type into a View. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.