ReadSignal

dioxus_native::prelude

Struct ReadSignal

pub struct ReadSignal<T, S = UnsyncStorage>where
    S: BoxedSignalStorage<T>,
    T: ?Sized,
{ /* private fields */ }

Available on crate feature prelude only.

Expand description

A boxed version of Readable that can be used to store any readable type.

Implementations§

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

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

Create a new boxed readable value.

impl<T, S> ReadSignal<T, S>
where T: 'static + ?Sized, S: BoxedSignalStorage<T>,

pub fn new_maybe_sync<R>(value: R) -> ReadSignal<T, S>
where S: CreateBoxedSignalStorage<R>, R: Readable<Target = T>,

Create a new boxed readable value which may be sync

pub fn point_to(&self, other: ReadSignal<T, S>) -> Result<(), BorrowError>

Point to another ReadSignal. This will subscribe the other ReadSignal to all subscribers of this ReadSignal.

Trait Implementations§

impl<T, S> Clone for ReadSignal<T, S>
where S: BoxedSignalStorage<T>, T: ?Sized,

fn clone(&self) -> ReadSignal<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

impl<T, S> Debug for ReadSignal<T, S>
where T: Debug + 'static, S: BoxedSignalStorage<T>,

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

Formats the value using the given formatter. Read more

impl<T, S> Default for ReadSignal<T, S>
where T: Default + 'static, S: CreateBoxedSignalStorage<Signal<T, S>> + BoxedSignalStorage<T> + Storage<SignalData<T>>,

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

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

impl<T, S> Deref for ReadSignal<T, S>
where T: Clone + 'static, S: BoxedSignalStorage<T>,

type Target = dyn Fn() -> T

The resulting type after dereferencing.

fn deref(&self) -> &<ReadSignal<T, S> as Deref>::Target

Dereferences the value.

impl<T, S> Display for ReadSignal<T, S>
where T: Display + 'static, S: BoxedSignalStorage<T>,

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

Formats the value using the given formatter. Read more

impl<T, S> From<CopyValue<T, S>> for ReadSignal<T, S>
where T: 'static, S: CreateBoxedSignalStorage<CopyValue<T, S>> + BoxedSignalStorage<T> + Storage<T>,

fn from(value: CopyValue<T, S>) -> ReadSignal<T, S>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<V, O, F, FMut, S> From<MappedMutSignal<O, V, F, FMut>> for ReadSignal<O, S>
where O: 'static + ?Sized, V: Readable<Storage = S> + 'static, F: Fn(&<V as Readable>::Target) -> &O + 'static, FMut: 'static, S: BoxedSignalStorage<O> + CreateBoxedSignalStorage<MappedMutSignal<O, V, F, FMut>>,

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

Converts to this type from the input type.

impl<V, O, F, S> From<MappedSignal<O, V, F>> for ReadSignal<O, S>
where O: 'static + ?Sized, V: Readable<Storage = S> + 'static, F: Fn(&<V as Readable>::Target) -> &O + 'static, S: BoxedSignalStorage<O> + CreateBoxedSignalStorage<MappedSignal<O, V, F>>,

fn from(value: MappedSignal<O, V, F>) -> ReadSignal<O, S>

Converts to this type from the input type.

impl<T> From<Memo<T>> for ReadSignal<T>
where T: PartialEq + 'static,

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

Converts to this type from the input type.

impl<T> From<Resource<T>> for ReadSignal<Option<T>>

fn from(val: Resource<T>) -> ReadSignal<Option<T>>

Converts to this type from the input type.

impl<T, S> From<Signal<T, S>> for ReadSignal<T, S>
where T: 'static, S: CreateBoxedSignalStorage<Signal<T, S>> + BoxedSignalStorage<T> + Storage<SignalData<T>>,

fn from(value: Signal<T, S>) -> ReadSignal<T, S>

Converts to this type from the input type.

impl From<UseFuture> for ReadSignal<UseFutureState>

fn from(val: UseFuture) -> ReadSignal<UseFutureState>

Converts to this type from the input type.

impl<T, S> From<WriteSignal<T, S>> for ReadSignal<T, S>
where T: 'static + ?Sized, S: BoxedSignalStorage<T> + CreateBoxedSignalStorage<WriteSignal<T, S>>,

fn from(value: WriteSignal<T, S>) -> ReadSignal<T, S>

Converts to this type from the input type.

impl<T, S> IntoAttributeValue for ReadSignal<T, S>
where S: BoxedSignalStorage<T>, T: Clone + IntoAttributeValue + 'static,

fn into_value(self) -> AttributeValue

Convert into an attribute value

impl<T, S> IntoDynNode for ReadSignal<T, S>
where T: Clone + IntoDynNode + 'static, S: BoxedSignalStorage<T>,

fn into_dyn_node(self) -> DynamicNode

Consume this item and produce a DynamicNode

impl<T, S> PartialEq<T> for ReadSignal<T, S>
where T: PartialEq + 'static, S: BoxedSignalStorage<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, S> PartialEq for ReadSignal<T, S>
where S: BoxedSignalStorage<T>, T: ?Sized,

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

impl<T, S> Readable for ReadSignal<T, S>
where S: BoxedSignalStorage<T>, T: ?Sized,

type Target = T

The target type of the reference.

type Storage = S

The type of the storage this readable uses.

fn try_read_unchecked( &self, ) -> Result<<<ReadSignal<T, S> as Readable>::Storage as AnyStorage>::Ref<'static, <ReadSignal<T, S> as Readable>::Target>, 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, ) -> Result<<<ReadSignal<T, S> as Readable>::Storage as AnyStorage>::Ref<'static, <ReadSignal<T, S> as Readable>::Target>, BorrowError>
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, S> Copy for ReadSignal<T, S>
where S: BoxedSignalStorage<T>, T: ?Sized,

Auto Trait Implementations§

impl<T, S> Freeze for ReadSignal<T, S>
where T: ?Sized,

impl<T, S> RefUnwindSafe for ReadSignal<T, S>
where S: RefUnwindSafe, <S as BoxedSignalStorage<T>>::DynReadable<SealedToken>: RefUnwindSafe, T: ?Sized,

impl<T, S> Send for ReadSignal<T, S>
where S: Sync, <S as BoxedSignalStorage<T>>::DynReadable<SealedToken>: Send, T: ?Sized,

impl<T, S> Sync for ReadSignal<T, S>
where S: Sync, <S as BoxedSignalStorage<T>>::DynReadable<SealedToken>: Sync, T: ?Sized,

impl<T, S> Unpin for ReadSignal<T, S>
where T: ?Sized,

impl<T, S> UnwindSafe for ReadSignal<T, S>
where S: RefUnwindSafe, <S as BoxedSignalStorage<T>>::DynReadable<SealedToken>: UnwindSafe, T: ?Sized,

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

fn downcast(&self) -> &T

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

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

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

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

impl<T> MaybeBoxed<Box<T>> for T

fn maybe_boxed(self) -> Box<T>

Convert

impl<T> MaybeBoxed<T> for T

fn maybe_boxed(self) -> T

Convert

impl<T> NoneValue for T
where T: Default,

type NoneType = T

fn null_value() -> T

The none-equivalent value.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>
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<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, 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, ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>
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) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>
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<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, 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, ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>
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: Sized + Clone, 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, ) -> <Self::Storage as AnyStorage>::Ref<'_, <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<K, V, H, R> ReadableHashMapExt<K, V, H> for R
where K: 'static, V: 'static, H: 'static, R: Readable<Target = HashMap<K, V, H>>,

fn is_empty(&self) -> bool

Check if the hashmap is empty.

fn len(&self) -> usize

Get the length of the hashmap.

fn capacity(&self) -> usize

Get the capacity of the hashmap.

fn get(&self, key: &K) -> Option<<Self::Storage as AnyStorage>::Ref<'_, V>>
where K: Hash + Eq, H: BuildHasher,

Get the value for the given key.

fn contains_key(&self, key: &K) -> bool
where K: Hash + Eq, H: BuildHasher,

Check if the hashmap contains the given key.

impl<V, H, R> ReadableHashSetExt<V, H> for R
where V: 'static, H: 'static, R: Readable<Target = HashSet<V, H>>,

fn is_empty(&self) -> bool

Check if the hashset is empty.

fn len(&self) -> usize

Get the length of the hashset.

fn capacity(&self) -> usize

Get the capacity of the hashset.

fn contains(&self, value: &V) -> bool
where V: Hash + Eq, H: BuildHasher,

Check if the hashset contains the given value.

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<<Self::Storage as AnyStorage>::Ref<'_, 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<<Self::Storage as AnyStorage>::Ref<'_, T>, <Self::Storage as AnyStorage>::Ref<'_, E>>
where T: 'static, E: 'static,

Attempts to read the inner value of the Option.

impl<W> ReadableStringExt for W
where W: Readable<Target = String>,

fn capacity(&self) -> usize

Check the capacity of the string.

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<<Self::Storage as AnyStorage>::Ref<'_, T>>
where T: 'static,

Get the first element of the inner vector.

fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>
where T: 'static,

Get the last element of the inner vector.

fn get(&self, index: usize) -> Option<<Self::Storage as AnyStorage>::Ref<'_, 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<T> Same for T

type Output = T

Should always be Self

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> ToSmolStr for T
where T: Display + ?Sized,

fn to_smolstr(&self) -> SmolStr

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> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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> Brush for T
where T: Clone + PartialEq + Default + Debug,

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSync for T
where T: Sync,

impl<T> WasmNotSync for T
where T: Sync,