Struct leptos_reactive::StoredValue

pub struct StoredValue<T>where
    T: 'static,{ /* private fields */ }

A non-reactive wrapper for any value, which can be created with store_value.

If you want a reactive wrapper, use create_signal.

This allows you to create a stable reference for any value by storing it within the reactive system. Like the signal types (e.g., ReadSignal and RwSignal), it is Copy and 'static. Unlike the signal types, it is not reactive; accessing it does not cause effects to subscribe, and updating it does not notify anything else.

Implementations

impl<T> StoredValue<T>

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

👎Deprecated: Please use get_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Returns a clone of the signals current value, subscribing the effect to this signal.

Panics

Panics if you try to access a value stored in a Scope that has been disposed.

Examples

#[derive(Clone)]
pub struct MyCloneableData {
    pub value: String,
}
let data = store_value(cx, MyCloneableData { value: "a".into() });

// calling .get() clones and returns the value
assert_eq!(data.get().value, "a");
// there's a short-hand getter form
assert_eq!(data().value, "a");

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

Returns a clone of the signals current value, subscribing the effect to this signal.

Panics

Panics if you try to access a value stored in a Scope that has been disposed.

Examples

#[derive(Clone)]
pub struct MyCloneableData {
    pub value: String,
}
let data = store_value(cx, MyCloneableData { value: "a".into() });

// calling .get() clones and returns the value
assert_eq!(data.get().value, "a");
// there's a short-hand getter form
assert_eq!(data().value, "a");

pub fn try_get(&self) -> Option<T>where T: Clone,

👎Deprecated: Please use try_get_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Same as StoredValue::get but will not panic by default.

pub fn try_get_value(&self) -> Option<T>where T: Clone,

Same as StoredValue::get but will not panic by default.

pub fn with<U>(&self, f: impl FnOnce(&T) -> U) -> U

👎Deprecated: Please use with_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Applies a function to the current stored value.

Panics

Panics if you try to access a value stored in a Scope that has been disposed.

Examples

pub struct MyUncloneableData {
  pub value: String
}
let data = store_value(cx, MyUncloneableData { value: "a".into() });

// calling .with() to extract the value
assert_eq!(data.with(|data| data.value.clone()), "a");
});

pub fn with_value<U>(&self, f: impl FnOnce(&T) -> U) -> U

Applies a function to the current stored value.

Panics

Panics if you try to access a value stored in a Scope that has been disposed.

Examples

pub struct MyUncloneableData {
    pub value: String,
}
let data = store_value(cx, MyUncloneableData { value: "a".into() });

// calling .with() to extract the value
assert_eq!(data.with(|data| data.value.clone()), "a");

pub fn try_with<O>(&self, f: impl FnOnce(&T) -> O) -> Option<O>

👎Deprecated: Please use try_with_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Same as StoredValue::with but returns [Some(O)] only if the signal is still valid. None otherwise.

pub fn try_with_value<O>(&self, f: impl FnOnce(&T) -> O) -> Option<O>

Same as StoredValue::with but returns [Some(O)] only if the signal is still valid. None otherwise.

pub fn update(&self, f: impl FnOnce(&mut T))

👎Deprecated: Please use update_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Updates the stored value.

Examples

pub struct MyUncloneableData {
  pub value: String
}
let data = store_value(cx, MyUncloneableData { value: "a".into() });
data.update(|data| data.value = "b".into());
assert_eq!(data.with(|data| data.value.clone()), "b");
});

use leptos_reactive::*;

pub struct MyUncloneableData {
    pub value: String,
}

let data = store_value(cx, MyUncloneableData { value: "a".into() });
let updated = data.update_returning(|data| {
    data.value = "b".into();
    data.value.clone()
});

assert_eq!(data.with(|data| data.value.clone()), "b");
assert_eq!(updated, Some(String::from("b")));

pub fn update_value(&self, f: impl FnOnce(&mut T))

Updates the stored value.

Examples

pub struct MyUncloneableData {
  pub value: String
}
let data = store_value(cx, MyUncloneableData { value: "a".into() });
data.update(|data| data.value = "b".into());
assert_eq!(data.with(|data| data.value.clone()), "b");
});

use leptos_reactive::*;

pub struct MyUncloneableData {
    pub value: String,
}

let data = store_value(cx, MyUncloneableData { value: "a".into() });
let updated = data.update_returning(|data| {
    data.value = "b".into();
    data.value.clone()
});

assert_eq!(data.with(|data| data.value.clone()), "b");
assert_eq!(updated, Some(String::from("b")));

pub fn update_returning<U>(&self, f: impl FnOnce(&mut T) -> U) -> Option<U>

👎Deprecated: Please use try_update_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Updates the stored value.

pub fn try_update_value<O>(self, f: impl FnOnce(&mut T) -> O) -> Option<O>

Same as Self::update, but returns [Some(O)] if the signal is still valid, None otherwise.

pub fn set(&self, value: T)

👎Deprecated: Please use set_value instead, as this method does not track the stored value. This method will also be removed in a future version of leptos

Sets the stored value.

Examples

pub struct MyUncloneableData {
  pub value: String
}
let data = store_value(cx, MyUncloneableData { value: "a".into() });
data.set(MyUncloneableData { value: "b".into() });
assert_eq!(data.with(|data| data.value.clone()), "b");
});

pub fn set_value(&self, value: T)

Sets the stored value.

Examples

pub struct MyUncloneableData {
    pub value: String,
}
let data = store_value(cx, MyUncloneableData { value: "a".into() });
data.set(MyUncloneableData { value: "b".into() });
assert_eq!(data.with(|data| data.value.clone()), "b");

pub fn try_set_value(&self, value: T) -> Option<T>

Same as Self::set, but returns None if the signal is still valid, [Some(T)] otherwise.

Trait Implementations

impl<T> Clone for StoredValue<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StoredValue<T>where T: 'static + Debug,

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

Formats the value using the given formatter.

impl<T> Hash for StoredValue<T>where T: 'static + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq<StoredValue<T>> for StoredValue<T>where T: 'static + PartialEq,

fn eq(&self, other: &StoredValue<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for StoredValue<T>

impl<T> Eq for StoredValue<T>where T: 'static + Eq,

impl<T> StructuralEq for StoredValue<T>where T: 'static,

impl<T> StructuralPartialEq for StoredValue<T>where T: 'static,