Struct StoredValue

pub struct StoredValue<T, S = SyncStorage> {
    value: ArenaItem<ArcStoredValue<T>, S>,
}

A non-reactive, Copy handle for any value.

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.

Fields

value: ArenaItem<ArcStoredValue<T>, S>

Implementations

impl<T, S> StoredValue<T, S>

where T: 'static, S: Storage<ArcStoredValue<T>>,

pub fn new_with_storage(value: T) -> StoredValue<T, S>

Stores the given value in the arena allocator.

impl<T> StoredValue<T>

where T: Send + Sync + 'static,

pub fn new(value: T) -> StoredValue<T>

Stores the given value in the arena allocator.

impl<T> StoredValue<T, LocalStorage>

where T: 'static,

pub fn new_local(value: T) -> StoredValue<T, LocalStorage>

Stores the given value in the arena allocator.

Trait Implementations

impl<T, S> Clone for StoredValue<T, S>

fn clone(&self) -> StoredValue<T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, S> Debug for StoredValue<T, S>

where S: Debug,

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

Formats the value using the given formatter.

impl<T, S> Default for StoredValue<T, S>

where T: Default + 'static, S: Storage<ArcStoredValue<T>>,

fn default() -> StoredValue<T, S>

Returns the “default value” for a type.

impl<T, S> DefinedAt for StoredValue<T, S>

fn defined_at(&self) -> Option<&'static Location<'static>>

Returns the location at which the signal was defined. This is usually simply None in release mode.

impl<T, S> Dispose for StoredValue<T, S>

fn dispose(self)

Disposes of the signal. This:

impl<T> From<ArcStoredValue<T>> for StoredValue<T>

where T: Send + Sync + 'static,

fn from(value: ArcStoredValue<T>) -> StoredValue<T>

Converts to this type from the input type.

impl<T, S> From<StoredValue<T, S>> for ArcStoredValue<T>

where S: Storage<ArcStoredValue<T>>,

fn from(value: StoredValue<T, S>) -> ArcStoredValue<T>

Converts to this type from the input type.

impl<T, S> Hash for StoredValue<T, S>

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

where H: Hasher,

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, S> IntoInner for StoredValue<T, S>

where T: 'static, S: Storage<ArcStoredValue<T>>,

type Value = T

The type of the value contained in the signal.

fn into_inner(self) -> Option<<StoredValue<T, S> as IntoInner>::Value>

Returns the inner value if this is the only reference to the signal. Otherwise, returns None and drops this reference.

impl<T, S> IsDisposed for StoredValue<T, S>

fn is_disposed(&self) -> bool

If true, the signal cannot be accessed without a panic.

impl<T, S> PartialEq for StoredValue<T, S>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, S> ReadValue for StoredValue<T, S>

where T: 'static, S: Storage<ArcStoredValue<T>>,

type Value = ReadGuard<T, Plain<T>>

The guard type that will be returned, which can be dereferenced to the value.

fn try_read_value(&self) -> Option<ReadGuard<T, Plain<T>>>

Returns the non-reactive guard, or None if the value has already been disposed.

fn read_value(&self) -> Self::Value

Returns the non-reactive guard.

impl<T, S> WriteValue for StoredValue<T, S>

where T: 'static, S: Storage<ArcStoredValue<T>>,

type Value = T

The type of the value’s value.

fn try_write_value(&self) -> Option<UntrackedWriteGuard<T>>

Returns a non-reactive write guard, or None if the value has already been disposed.

fn write_value(&self) -> UntrackedWriteGuard<Self::Value>

Returns a non-reactive write guard.

impl<T, S> Copy for StoredValue<T, S>

impl<T, S> Eq for StoredValue<T, S>