Struct WriteSignal

pub struct WriteSignal<T: ?Sized> { /* private fields */ }

Expand description

A boxed version of Writable that can be used to store any writable type.

Implementations§

impl<T: ?Sized + 'static> WriteSignal<T>

pub fn new( value: impl Writable<Target = T, Storage = UnsyncStorage, WriteMetadata: 'static> + 'static, ) -> Self

Create a new boxed writable value.

Trait Implementations§

impl<T: Add<Output = T> + Copy + 'static> Add<T> for WriteSignal<T>

type Output = T

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation. Read more

impl<T: Add<Output = T> + Copy + 'static> AddAssign<T> for WriteSignal<T>

fn add_assign(&mut self, rhs: T)

Performs the += operation. Read more

impl<T: ?Sized> Clone for WriteSignal<T>

fn clone(&self) -> Self

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

impl<T: Debug + 'static> Debug for WriteSignal<T>

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

Formats the value using the given formatter. Read more

impl<T: Clone + 'static> Deref for WriteSignal<T>

type Target = dyn Fn() -> T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Display + 'static> Display for WriteSignal<T>

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

Formats the value using the given formatter. Read more

impl<T: Div<Output = T> + Copy + 'static> Div<T> for WriteSignal<T>

type Output = T

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation. Read more

impl<T: Div<Output = T> + Copy + 'static> DivAssign<T> for WriteSignal<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation. Read more

impl<T: 'static> From<CopyValue<T>> for WriteSignal<T>

fn from(value: CopyValue<T>) -> Self

Converts to this type from the input type.

impl<T, R> From<Global<T, R>> for WriteSignal<R>
where T: Writable<Target = R, Storage = UnsyncStorage> + InitializeFromFunction<R> + Clone + 'static, R: 'static,

fn from(value: Global<T, R>) -> Self

Converts to this type from the input type.

impl<V, O, F, FMut> From<MappedMutSignal<O, V, F, FMut>> for WriteSignal<O>
where O: ?Sized + 'static, V: Writable<Storage = UnsyncStorage> + 'static, F: Fn(&V::Target) -> &O + 'static, FMut: Fn(&mut V::Target) -> &mut O + 'static,

fn from(value: MappedMutSignal<O, V, F, FMut>) -> Self

Converts to this type from the input type.

impl<T: 'static> From<Signal<T>> for WriteSignal<T>

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

Converts to this type from the input type.

impl<T: ?Sized + 'static> From<WriteSignal<T>> for ReadSignal<T>

fn from(value: WriteSignal<T>) -> Self

Converts to this type from the input type.

impl<T> IntoAttributeValue for WriteSignal<T>
where T: Clone + IntoAttributeValue + 'static,

fn into_value(self) -> AttributeValue

Convert into an attribute value

impl<T> IntoDynNode for WriteSignal<T>
where T: Clone + IntoDynNode + 'static,

fn into_dyn_node(self) -> DynamicNode

Consume this item and produce a DynamicNode

impl<T: Mul<Output = T> + Copy + 'static> Mul<T> for WriteSignal<T>

type Output = T

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation. Read more

impl<T: Mul<Output = T> + Copy + 'static> MulAssign<T> for WriteSignal<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation. Read more

impl<T: PartialEq + 'static> PartialEq<T> for WriteSignal<T>

fn eq(&self, other: &T) -> 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.

impl<T: ?Sized> PartialEq for WriteSignal<T>

fn eq(&self, other: &Self) -> 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.

impl<T: ?Sized> Readable for WriteSignal<T>

type Target = T

The target type of the reference.

type Storage = UnsyncStorage

The type of the storage this readable uses.

fn try_read_unchecked(&self) -> Result<ReadableRef<'static, Self>, BorrowError>
where T: 'static,

Try to get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal. Read more

fn try_peek_unchecked(&self) -> BorrowResult<ReadableRef<'static, Self>>
where T: 'static,

Try to peek the current value of the signal without subscribing to updates. If the value has been dropped, this will return an error. Read more

fn subscribers(&self) -> Subscribers
where T: 'static,

Get the underlying subscriber list for this readable. This is used to track when the value changes and notify subscribers.

impl<T: Sub<Output = T> + Copy + 'static> Sub<T> for WriteSignal<T>

type Output = T

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation. Read more

impl<T: Sub<Output = T> + Copy + 'static> SubAssign<T> for WriteSignal<T>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation. Read more

impl<T: ?Sized> Writable for WriteSignal<T>

type WriteMetadata = Box<dyn Any>

Additional data associated with the write reference.

fn try_write_unchecked( &self, ) -> Result<WritableRef<'static, Self>, BorrowMutError>
where T: 'static,

Try to get a mutable reference to the value without checking the lifetime. This will update any subscribers. Read more

impl<T: ?Sized> Copy for WriteSignal<T>

Auto Trait Implementations§

impl<T> Freeze for WriteSignal<T>
where T: ?Sized,

impl<T> !RefUnwindSafe for WriteSignal<T>

impl<T> !Send for WriteSignal<T>

impl<T> !Sync for WriteSignal<T>

impl<T> Unpin for WriteSignal<T>
where T: ?Sized,

impl<T> !UnwindSafe for WriteSignal<T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> InitializeFromFunction<T> for T

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<R> ReadableBoxExt for R
where R: Readable<Storage = UnsyncStorage> + ?Sized,

fn boxed(self) -> ReadSignal<Self::Target>
where Self: Sized + 'static,

Box the readable value into a trait object. This is useful for passing around readable values without knowing their concrete type.

impl<R> ReadableExt for R
where R: Readable + ?Sized,

fn read(&self) -> ReadableRef<'_, Self>
where Self::Target: 'static,

Get the current value of the state. If this is a signal, this will subscribe the current scope to the signal. If the value has been dropped, this will panic. Calling this on a Signal is the same as using the signal() syntax to read and subscribe to its value

fn try_read(&self) -> Result<ReadableRef<'_, Self>, BorrowError>
where Self::Target: 'static,

Try to get the current value of the state. If this is a signal, this will subscribe the current scope to the signal.

fn read_unchecked(&self) -> ReadableRef<'static, Self>
where Self::Target: 'static,

Get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal. Read more

fn peek(&self) -> ReadableRef<'_, Self>
where Self::Target: 'static,

Get the current value of the state without subscribing to updates. If the value has been dropped, this will panic. Read more

fn try_peek(&self) -> Result<ReadableRef<'_, Self>, BorrowError>
where Self::Target: 'static,

Try to peek the current value of the signal without subscribing to updates. If the value has been dropped, this will return an error.

fn peek_unchecked(&self) -> ReadableRef<'static, Self>
where Self::Target: 'static,

Get the current value of the signal without checking the lifetime. Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update. Read more

fn map<F, O>(self, f: F) -> MappedSignal<O, Self, F>
where Self: Clone + Sized, F: Fn(&Self::Target) -> &O,

Map the references of the readable value to a new type. This lets you provide a view into the readable value without creating a new signal or cloning the value. Read more

fn cloned(&self) -> Self::Target
where Self::Target: Clone + 'static,

Clone the inner value and return it. If the value has been dropped, this will panic.

fn with<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> O
where Self::Target: 'static,

Run a function with a reference to the value. If the value has been dropped, this will panic.

fn with_peek<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> O
where Self::Target: 'static,

Run a function with a reference to the value. If the value has been dropped, this will panic.

fn index<I>( &self, index: I, ) -> ReadableRef<'_, Self, <Self::Target as Index<I>>::Output>
where Self::Target: Index<I> + 'static,

Index into the inner value and return a reference to the result. If the value has been dropped or the index is invalid, this will panic.

impl<T, R> ReadableOptionExt<T> for R
where R: Readable<Target = Option<T>>,

fn unwrap(&self) -> T
where T: Clone + 'static,

Unwraps the inner value and clones it.

fn as_ref(&self) -> Option<ReadableRef<'_, Self, T>>
where T: 'static,

Attempts to read the inner value of the Option.

impl<T, E, R> ReadableResultExt<T, E> for R
where R: Readable<Target = Result<T, E>>,

fn unwrap(&self) -> T
where T: Clone + 'static, E: 'static,

Unwraps the inner value and clones it.

fn as_ref(&self) -> Result<ReadableRef<'_, Self, T>, ReadableRef<'_, Self, E>>
where T: 'static, E: 'static,

Attempts to read the inner value of the Option.

impl<T, R> ReadableVecExt<T> for R
where R: Readable<Target = Vec<T>>,

fn len(&self) -> usize
where T: 'static,

Returns the length of the inner vector.

fn is_empty(&self) -> bool
where T: 'static,

Returns true if the inner vector is empty.

fn first(&self) -> Option<ReadableRef<'_, Self, T>>
where T: 'static,

Get the first element of the inner vector.

fn last(&self) -> Option<ReadableRef<'_, Self, T>>
where T: 'static,

Get the last element of the inner vector.

fn get(&self, index: usize) -> Option<ReadableRef<'_, Self, T>>
where T: 'static,

Get the element at the given index of the inner vector.

fn iter(&self) -> ReadableValueIterator<'_, Self> ⓘ
where Self: Sized,

Get an iterator over the values of the inner vector.

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<Ret> SpawnIfAsync<(), Ret> for Ret

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block

impl<T, O> SuperFrom<T> for O
where O: From<T>,

fn super_from(input: T) -> O

Convert from a type to another type.

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

fn super_into(self) -> O

Convert from a type to another type.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> WritableBoxedExt for T
where T: Writable<Storage = UnsyncStorage> + 'static,

fn boxed_mut(self) -> WriteSignal<<T as Readable>::Target>

Box the writable value into a trait object. This is useful for passing around writable values without knowing their concrete type.

impl<W> WritableExt for W
where W: Writable + ?Sized,

fn write(&mut self) -> WritableRef<'_, Self>
where Self::Target: 'static,

Get a mutable reference to the value. If the value has been dropped, this will panic.

fn try_write(&mut self) -> Result<WritableRef<'_, Self>, BorrowMutError>
where Self::Target: 'static,

Try to get a mutable reference to the value.

fn write_unchecked(&self) -> WritableRef<'static, Self>
where Self::Target: 'static,

Get a mutable reference to the value without checking the lifetime. This will update any subscribers. Read more

fn map_mut<O, F, FMut>( self, f: F, f_mut: FMut, ) -> MappedMutSignal<O, Self, F, FMut>
where Self: Sized, O: ?Sized, F: Fn(&Self::Target) -> &O, FMut: Fn(&mut Self::Target) -> &mut O,

Map the references and mutable references of the writable value to a new type. This lets you provide a view into the writable value without creating a new signal or cloning the value. Read more

fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> O
where Self::Target: 'static,

Run a function with a mutable reference to the value. If the value has been dropped, this will panic.

fn set(&mut self, value: Self::Target)
where Self::Target: Sized + 'static,

Set the value of the signal. This will trigger an update on all subscribers.

fn toggle(&mut self)
where Self::Target: Not<Output = Self::Target> + Clone + 'static,

Invert the boolean value of the signal. This will trigger an update on all subscribers.

fn index_mut<I>( &mut self, index: I, ) -> WritableRef<'_, Self, <Self::Target as Index<I>>::Output>
where Self::Target: IndexMut<I> + 'static,

Index into the inner value and return a reference to the result.

fn take(&mut self) -> Self::Target
where Self::Target: Default + 'static,

Takes the value out of the Signal, leaving a Default in its place.

fn replace(&mut self, value: Self::Target) -> Self::Target
where Self::Target: Sized + 'static,

Replace the value in the Signal, returning the old value.

impl<T, W> WritableOptionExt<T> for W
where W: Writable<Target = Option<T>>,

fn get_or_insert(&mut self, default: T) -> WritableRef<'_, Self, T>
where T: 'static,

Gets the value out of the Option, or inserts the given value if the Option is empty.

fn get_or_insert_with( &mut self, default: impl FnOnce() -> T, ) -> WritableRef<'_, Self, T>
where T: 'static,

Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty.

fn as_mut(&mut self) -> Option<WritableRef<'_, Self, T>>
where T: 'static,

Attempts to write the inner value of the Option.

impl<T, W> WritableVecExt<T> for W
where W: Writable<Target = Vec<T>>,

fn push(&mut self, value: T)
where T: 'static,

Pushes a new value to the end of the vector.

fn pop(&mut self) -> Option<T>
where T: 'static,

Pops the last value from the vector.

fn insert(&mut self, index: usize, value: T)
where T: 'static,

Inserts a new value at the given index.

fn remove(&mut self, index: usize) -> T
where T: 'static,

Removes the value at the given index.

fn clear(&mut self)
where T: 'static,

Clears the vector, removing all values.

fn extend(&mut self, iter: impl IntoIterator<Item = T>)
where T: 'static,

Extends the vector with the given iterator.

fn truncate(&mut self, len: usize)
where T: 'static,

Truncates the vector to the given length.

fn swap_remove(&mut self, index: usize) -> T
where T: 'static,

Swaps two values in the vector.

fn retain(&mut self, f: impl FnMut(&T) -> bool)
where T: 'static,

Retains only the values that match the given predicate.

fn split_off(&mut self, at: usize) -> Vec<T>
where T: 'static,

Splits the vector into two at the given index.

fn get_mut(&mut self, index: usize) -> Option<WritableRef<'_, Self, T>>
where T: 'static,

Try to mutably get an element from the vector.

fn iter_mut(&mut self) -> WritableValueIterator<'_, Self> ⓘ
where Self: Sized + Clone,

Gets an iterator over the values of the vector.