Skip to main content

MaybeProp

impulse_ui_kit::prelude

Struct MaybeProp 

Source 
pub struct MaybeProp<T, S = SyncStorage>(/* private fields */)
where
    T: 'static,
    S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>;
Expand description

A wrapping type for an optional component prop.

This can either be a signal or a non-reactive value, and may or may not have a value. In other words, this is an Option<Signal<Option<T>>>, but automatically flattens its getters.

This creates an extremely flexible type for component libraries, etc.

§Examples

let (count, set_count) = signal(Some(2));
let double = |n| n * 2;
let double_count = MaybeProp::derive(move || count.get().map(double));
let memoized_double_count = Memo::new(move |_| count.get().map(double));
let static_value = 5;

// this function takes either a reactive or non-reactive value
fn above_3(arg: &MaybeProp<i32>) -> bool {
    // ✅ calling the signal clones and returns the value
    //    it is a shorthand for arg.get()q
    arg.get().map(|arg| arg > 3).unwrap_or(false)
}

assert_eq!(above_3(&None::<i32>.into()), false);
assert_eq!(above_3(&static_value.into()), true);
assert_eq!(above_3(&count.into()), false);
assert_eq!(above_3(&double_count), true);
assert_eq!(above_3(&memoized_double_count.into()), true);

Implementations§

Source§

impl<T> MaybeProp<T>
where T: Send + Sync,

Source

pub fn derive( derived_signal: impl Fn() -> Option<T> + Send + Sync + 'static, ) -> MaybeProp<T>

Wraps a derived signal, i.e., any computation that accesses one or more reactive signals.

Source§

impl<T> MaybeProp<T, LocalStorage>

Source

pub fn derive_local( derived_signal: impl Fn() -> Option<T> + 'static, ) -> MaybeProp<T, LocalStorage>

Wraps a derived signal, i.e., any computation that accesses one or more reactive signals.

Trait Implementations§

Source§

impl<T, S> Clone for MaybeProp<T, S>
where S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

fn clone(&self) -> MaybeProp<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 MaybeProp<T, S>
where T: Debug + 'static, S: Debug + Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

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

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

impl<T, S> Default for MaybeProp<T, S>
where S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

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

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

impl<T, S> DefinedAt for MaybeProp<T, S>
where S: Storage<Option<T>> + Storage<SignalTypes<Option<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 From<&str> for MaybeProp<String>

Source§

fn from(value: &str) -> MaybeProp<String>

Converts to this type from the input type.
Source§

impl From<&str> for MaybeProp<String, LocalStorage>

Source§

fn from(value: &str) -> MaybeProp<String, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<MaybeProp<T>> for Option<Signal<Option<T>>>
where T: Send + Sync + 'static,

Source§

fn from(value: MaybeProp<T>) -> Option<Signal<Option<T>>>

Converts to this type from the input type.
Source§

impl<T> From<MaybeProp<T, LocalStorage>> for Option<Signal<Option<T>, LocalStorage>>
where T: Send + Sync + 'static,

Source§

fn from( value: MaybeProp<T, LocalStorage>, ) -> Option<Signal<Option<T>, LocalStorage>>

Converts to this type from the input type.
Source§

impl<T> From<MaybeSignal<Option<T>>> for MaybeProp<T>
where T: Send + Sync, SyncStorage: Storage<Option<T>>,

Source§

fn from(value: MaybeSignal<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<MaybeSignal<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync,

Source§

fn from( value: MaybeSignal<Option<T>, LocalStorage>, ) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<Memo<Option<T>>> for MaybeProp<T>
where T: Send + Sync,

Source§

fn from(value: Memo<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<Memo<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync,

Source§

fn from(value: Memo<Option<T>, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<Memo<T>> for MaybeProp<T>
where T: Send + Sync + Clone,

Source§

fn from(value: Memo<T>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<Memo<T, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync + Clone,

Source§

fn from(value: Memo<T, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<Option<MaybeSignal<Option<T>>>> for MaybeProp<T>
where T: Send + Sync, SyncStorage: Storage<Option<T>>,

Source§

fn from(value: Option<MaybeSignal<Option<T>>>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<Option<MaybeSignal<Option<T>, LocalStorage>>> for MaybeProp<T, LocalStorage>
where T: Send + Sync,

Source§

fn from( value: Option<MaybeSignal<Option<T>, LocalStorage>>, ) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<Option<T>> for MaybeProp<T>
where T: Send + Sync, SyncStorage: Storage<Option<T>>,

Source§

fn from(value: Option<T>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<ReadSignal<Option<T>>> for MaybeProp<T>
where T: Send + Sync,

Source§

fn from(value: ReadSignal<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<ReadSignal<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync,

Source§

fn from( value: ReadSignal<Option<T>, LocalStorage>, ) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<ReadSignal<T>> for MaybeProp<T>
where T: Send + Sync + Clone,

Source§

fn from(value: ReadSignal<T>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<ReadSignal<T, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync + Clone,

Source§

fn from(value: ReadSignal<T, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<RwSignal<Option<T>>> for MaybeProp<T>
where T: Send + Sync,

Source§

fn from(value: RwSignal<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<RwSignal<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync,

Source§

fn from(value: RwSignal<Option<T>, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<RwSignal<T>> for MaybeProp<T>
where T: Send + Sync + Clone,

Source§

fn from(value: RwSignal<T>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<RwSignal<T, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync + Clone,

Source§

fn from(value: RwSignal<T, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<Signal<Option<T>>> for MaybeProp<T>
where T: Send + Sync, SyncStorage: Storage<Option<T>>,

Source§

fn from(value: Signal<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<Signal<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>

Source§

fn from(value: Signal<Option<T>, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<Signal<T>> for MaybeProp<T>
where T: Send + Sync + Clone,

Source§

fn from(value: Signal<T>) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> From<Signal<T, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync + Clone,

Source§

fn from(value: Signal<T, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
Source§

impl<T> From<T> for MaybeProp<T>
where T: Send + Sync, SyncStorage: Storage<Option<T>>,

Source§

fn from(value: T) -> MaybeProp<T>

Converts to this type from the input type.
Source§

impl<T> FromLocal<Option<T>> for MaybeProp<T, LocalStorage>

Source§

fn from_local(value: Option<T>) -> MaybeProp<T, LocalStorage>

Converts between the types.
Source§

impl<T> FromLocal<T> for MaybeProp<T, LocalStorage>

Source§

fn from_local(value: T) -> MaybeProp<T, LocalStorage>

Converts between the types.
Source§

impl<T, S> PartialEq for MaybeProp<T, S>
where T: PartialEq + 'static, S: PartialEq + Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

fn eq(&self, other: &MaybeProp<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> ReadUntracked for MaybeProp<T, S>
where S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

type Value = ReadGuard<Option<T>, SignalReadGuard<Option<T>, S>>

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

fn try_read_untracked( &self, ) -> Option<<MaybeProp<T, S> as ReadUntracked>::Value>

Returns the guard, or None if the signal has already been disposed.
Source§

fn custom_try_read( &self, ) -> Option<Option<<MaybeProp<T, S> as ReadUntracked>::Value>>

This is a backdoor to allow overriding the Read::try_read implementation despite it being auto implemented. Read more
Source§

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

Returns the guard. Read more
Source§

impl<T, St> Serialize for MaybeProp<T, St>
where T: Send + Sync + Serialize, St: Storage<SignalTypes<Option<T>, St>> + Storage<Option<T>>,

Source§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T, S> Track for MaybeProp<T, S>
where S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

fn track(&self)

Subscribes to this signal in the current reactive scope without doing anything with its value.
Source§

impl<T, S> Copy for MaybeProp<T, S>
where S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

impl<T, S> Eq for MaybeProp<T, S>
where T: Eq + 'static, S: Eq + Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Source§

impl<T, S> StructuralPartialEq for MaybeProp<T, S>
where T: 'static, S: Storage<Option<T>> + Storage<SignalTypes<Option<T>, S>>,

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<T, S> UnwindSafe for MaybeProp<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<!> for T

Source§

fn from(t: !) -> T

Converts to this type from the input type.
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<S, T> FromStream<T> for S
where S: From<ArcReadSignal<Option<T>>> + Send + Sync, T: Send + Sync + 'static,

Source§

fn from_stream(stream: impl Stream<Item = T> + Send + 'static) -> S

Creates a signal that contains the latest value of the stream.
Source§

fn from_stream_unsync(stream: impl Stream<Item = T> + 'static) -> S

Creates a signal that contains the latest value of the stream.
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<T, S> IntoOptionGetter<T, SignalMarker> for S
where S: Get<Value = Option<T>> + Clone + Send + Sync + 'static,

Source§

fn into_option_getter(self) -> OptionGetter<T>

Converts the given value into an OptionGetter.
Source§

impl<E, T, Request> IntoReq<DeleteUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, 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, Request> IntoReq<GetUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, 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<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, Request> IntoReq<PatchUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, 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, Request> IntoReq<PostUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, 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, T, Request> IntoReq<PutUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, 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> Read for T
where T: Track + ReadUntracked,

Source§

type Value = <T as ReadUntracked>::Value

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

fn try_read(&self) -> Option<<T as Read>::Value>

Subscribes to the signal, and returns the guard, or None if the signal has already been disposed.
Source§

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

Subscribes to the signal, and returns the guard. Read more
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
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> With for T
where T: Read,

Source§

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

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

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

Subscribes to the signal, applies the closure to the value, and returns the result, or None if the signal has already been disposed.
Source§

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

Subscribes to the signal, applies the closure to the value, and returns the result. Read more
Source§

impl<T> WithUntracked for T
where T: DefinedAt + ReadUntracked,

Source§

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

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

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

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

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

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