Skip to main content

StoredValue

impulse_ui_kit::prelude

Struct StoredValue 

Source 
pub struct StoredValue<T, S = SyncStorage> { /* private fields */ }
Expand description

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.

Implementations§

Source§

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

Source

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

Stores the given value in the arena allocator.

Source§

impl<T> StoredValue<T>
where T: Send + Sync + 'static,

Source

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

Stores the given value in the arena allocator.

Source§

impl<T> StoredValue<T, LocalStorage>
where T: 'static,

Source

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

Stores the given value in the arena allocator.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate 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, S> Debug for StoredValue<T, S>
where S: Debug,

Source§

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

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

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

Source§

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

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

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

Source§

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

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

Source§

fn dispose(self)

Disposes of the signal. This: Read more
Source§

impl<T> From<ArcStoredValue<T>> for StoredValue<T>
where T: Send + Sync + 'static,

Source§

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

Converts to this type from the input type.
Source§

impl<T, S> From<StoredValue<T, S>> for ArcStoredValue<T>
where S: Storage<ArcStoredValue<T>>,

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T, S> IntoInner for StoredValue<T, S>
where T: 'static, S: Storage<ArcStoredValue<T>>,

Source§

type Value = T

The type of the value contained in the signal.
Source§

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. Read more
Source§

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

Source§

fn is_disposed(&self) -> bool

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

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

Source§

fn eq(&self, other: &StoredValue<T, S>) -> 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, S> ReadValue for StoredValue<T, S>
where T: 'static, S: Storage<ArcStoredValue<T>>,

Source§

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

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

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

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

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

Returns the non-reactive guard. Read more
Source§

impl<T, S> WriteValue for StoredValue<T, S>
where T: 'static, S: Storage<ArcStoredValue<T>>,

Source§

type Value = T

The type of the value’s value.
Source§

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

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

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

Returns a non-reactive write guard. Read more
Source§

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

Source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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> 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<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> SetValue for T
where T: WriteValue,

Source§

type Value = <T as WriteValue>::Value

The type of the value contained in the value.
Source§

fn try_set_value( &self, value: <T as SetValue>::Value, ) -> Option<<T as SetValue>::Value>

Updates the value by replacing it, non-reactively. Read more
Source§

fn set_value(&self, value: Self::Value)

Updates the value by replacing it, non-reactively.
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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 = 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> UpdateValue for T
where T: WriteValue,

Source§

type Value = <T as WriteValue>::Value

The type of the value contained in the value.
Source§

fn try_update_value<U>( &self, fun: impl FnOnce(&mut <T as UpdateValue>::Value) -> U, ) -> Option<U>

Updates the value, returning the value that is returned by the update function, or None if the value has already been disposed.
Source§

fn update_value(&self, fun: impl FnOnce(&mut Self::Value))

Updates the value.
Source§

impl<T> WithValue for T
where T: DefinedAt + ReadValue,

Source§

type Value = <<T as ReadValue>::Value as Deref>::Target

The type of the value contained in the value.
Source§

fn try_with_value<U>( &self, fun: impl FnOnce(&<T as WithValue>::Value) -> U, ) -> Option<U>

Applies the closure to the value, non-reactively, and returns the result, or None if the value has already been disposed.
Source§

fn with_value<U>(&self, fun: impl FnOnce(&Self::Value) -> U) -> U

Applies the closure to the value, non-reactively, and returns the result. Read more