Struct dioxus_shareables::shared::Shared

pub struct Shared<T: 'static, B: 'static> {
    pub id: Option<usize>,
    /* private fields */
}

A hook to a shared_value.

This is generally created by calling use_rw or use_w on a shareable!, or by calling ListEntry::use_rw or ListEntry::use_w.

Fields

id: Option<usize>

Implementations

impl<T: 'static, B: 'static + Flag> Shared<T, B>

pub fn init<P, F: FnOnce() -> T>(
    cx: &Scope<'_, P>,
    opt: &mut Shareable<T>,
    f: F,
    _: B
) -> Self

Initialize the hook in scope cx.

The shared value will be initialized with f() if it hasn’t been created yet.

NOTE: this method should generally not be used directly; instead, shared values are usually created with shareable!.

pub fn write(&self) -> RefMut<'_, T>

Obtain a write pointer to the shared value and register the change.

This will mark all components which hold a RW link to the value as needing update.

pub fn write_silent(&self) -> RefMut<'_, T>

Obtain a write pointer to the shared value but do not register the change.

This will not notify consumers of the change to the value.

pub fn needs_update(&self)

Mark the components which hold a RW link to the value as needing update.

pub fn set(&self, t: T)where
    T: PartialEq,

Set the shared value.

This marks compoments which hold a RW link to the value as needing update if and only if the value has changed.

pub fn set_with<F: Fn(&T) -> T>(&self, f: F)where
    T: PartialEq,

Set the shared value to f(&x) where x is the current value.

This marks components which hold a RW link to the value as needing update if and only if the value has changed.

pub fn read(&self) -> Ref<'_, T>

Get the value of the shared data.

pub fn listeners<'a>(&'a self) -> String

Trait Implementations

impl<T: 'static, B: 'static> Clone for Shared<T, B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: 'static, B: 'static> Drop for Shared<T, B>

fn drop(&mut self)

Executes the destructor for this type.