Struct dioxus_signals::ReadOnlySignal

pub struct ReadOnlySignal<T: 'static> { /* private fields */ }

A signal that can only be read from.

Implementations

impl<T: 'static> ReadOnlySignal<Vec<T>>

pub fn get(&self, index: usize) -> Option<Ref<'_, T>>

Read a value from the inner vector.

impl<T: 'static> ReadOnlySignal<Option<T>>

pub fn unwrap(&self) -> Twhere T: Clone,

Unwraps the inner value and clones it.

pub fn as_ref(&self) -> Option<Ref<'_, T>>

Attemps to read the inner value of the Option.

impl<T: 'static> ReadOnlySignal<T>

pub fn new(signal: Signal<T>) -> Self

Create a new read-only signal.

pub fn origin_scope(&self) -> ScopeId

Get the scope that the signal was created in.

pub fn read(&self) -> Ref<'_, T>

Get the current value of the signal. This will subscribe the current scope to the signal.

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

Run a closure with a reference to the signal’s value.

impl<T: Clone + 'static> ReadOnlySignal<T>

pub fn value(&self) -> T

Get the current value of the signal. This will subscribe the current scope to the signal.

Trait Implementations

impl<T> Clone for ReadOnlySignal<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Default + 'static> Default for ReadOnlySignal<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for ReadOnlySignal<T>

type Target = dyn Fn() -> Ref<'static, T>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<T: 'static> PartialEq<ReadOnlySignal<T>> for ReadOnlySignal<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for ReadOnlySignal<T>