Enum leptos_use::core::UseRwSignal

source ·
pub enum UseRwSignal<T: 'static> {
    Separate(Signal<T>, WriteSignal<T>),
    Combined(RwSignal<T>),
}

Variants§

§

Separate(Signal<T>, WriteSignal<T>)

§

Combined(RwSignal<T>)

Trait Implementations§

source§

impl<T> Clone for UseRwSignal<T>

source§

fn clone(&self) -> Self

Returns a copy 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> Default for UseRwSignal<T>
where T: Default,

source§

fn default() -> Self

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

impl<T, RS> From<(RS, WriteSignal<T>)> for UseRwSignal<T>
where RS: Into<Signal<T>>,

source§

fn from(s: (RS, WriteSignal<T>)) -> Self

Converts to this type from the input type.
source§

impl<T> From<RwSignal<T>> for UseRwSignal<T>

source§

fn from(s: RwSignal<T>) -> Self

Converts to this type from the input type.
source§

impl<T> SignalGet for UseRwSignal<T>
where T: Clone,

§

type Value = T

The value held by the signal.
source§

fn get(&self) -> T

Clones and returns the current value of the signal, and subscribes the running effect to this signal. Read more
source§

fn try_get(&self) -> Option<T>

Clones and returns the signal value, returning Some if the signal is still alive, and None otherwise.
source§

impl<T> SignalGetUntracked for UseRwSignal<T>
where T: Clone,

§

type Value = T

The value held by the signal.
source§

fn get_untracked(&self) -> T

Gets the signal’s value without creating a dependency on the current scope. Read more
source§

fn try_get_untracked(&self) -> Option<T>

Gets the signal’s value without creating a dependency on the current scope. Returns [Some(T)] if the signal is still valid, None otherwise.
source§

impl<T> SignalSet for UseRwSignal<T>

§

type Value = T

The value held by the signal.
source§

fn set(&self, new_value: T)

Sets the signal’s value and notifies subscribers. Read more
source§

fn try_set(&self, new_value: T) -> Option<T>

Sets the signal’s value and notifies subscribers. Returns None if the signal is still valid, [Some(T)] otherwise. Read more
source§

impl<T> SignalSetUntracked<T> for UseRwSignal<T>

source§

fn set_untracked(&self, new_value: T)

Sets the signal’s value without notifying dependents.
source§

fn try_set_untracked(&self, new_value: T) -> Option<T>

Attempts to set the signal if it’s still valid. Returns None if the signal was set, [Some(T)] otherwise.
source§

impl<T> SignalUpdate for UseRwSignal<T>

§

type Value = T

The value held by the signal.
source§

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

Applies a function to the current value to mutate it in place and notifies subscribers that the signal has changed. Read more
source§

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

Applies a function to the current value to mutate it in place and notifies subscribers that the signal has changed. Returns [Some(O)] if the signal is still valid, None otherwise. Read more
source§

impl<T> SignalWith for UseRwSignal<T>

§

type Value = T

The value held by the signal.
source§

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

Applies a function to the current value of the signal, and subscribes the running effect to this signal. Read more
source§

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

Applies a function to the current value of the signal, and subscribes the running effect to this signal. Returns Some if the signal is valid and the function ran, otherwise returns None.
source§

fn track(&self)

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

impl<T> SignalWithUntracked for UseRwSignal<T>

§

type Value = T

The value held by the signal.
source§

fn with_untracked<R>(&self, f: impl FnOnce(&T) -> R) -> R

Runs the provided closure with a reference to the current value without creating a dependency on the current scope. Read more
source§

fn try_with_untracked<R>(&self, f: impl FnOnce(&T) -> R) -> Option<R>

Runs the provided closure with a reference to the current value without creating a dependency on the current scope. Returns [Some(O)] if the signal is still valid, None otherwise.
source§

impl<T> Copy for UseRwSignal<T>

Auto Trait Implementations§

§

impl<T> Freeze for UseRwSignal<T>

§

impl<T> !RefUnwindSafe for UseRwSignal<T>

§

impl<T> !Send for UseRwSignal<T>

§

impl<T> !Sync for UseRwSignal<T>

§

impl<T> Unpin for UseRwSignal<T>
where T: Unpin,

§

impl<T> !UnwindSafe for UseRwSignal<T>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more