Struct freya::prelude::MappedSignal

pub struct MappedSignal<O, S = UnsyncStorage>
where
    O: 'static + ?Sized,
    S: AnyStorage,
{ /* private fields */ }

A read only signal that has been mapped to a new type.

Trait Implementations

impl<O, S> Clone for MappedSignal<O, S>

where S: AnyStorage, O: ?Sized,

fn clone(&self) -> MappedSignal<O, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S> Debug for MappedSignal<T, S>

where T: Debug + 'static, S: AnyStorage,

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

Formats the value using the given formatter.

impl<O, S> Deref for MappedSignal<O, S>

where O: Clone, S: AnyStorage + 'static,

Allow calling a signal with signal() syntax

Currently only limited to copy types, though could probably specialize for string/arc/rc

type Target = dyn Fn() -> O

The resulting type after dereferencing.

fn deref(&self) -> &<MappedSignal<O, S> as Deref>::Target

Dereferences the value.

impl<T, S> Display for MappedSignal<T, S>

where T: Display + 'static, S: AnyStorage,

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

Formats the value using the given formatter.

impl<O, S> IntoAttributeValue for MappedSignal<O, S>

where O: Clone + IntoAttributeValue, S: AnyStorage,

fn into_value(self) -> AttributeValue

Convert into an attribute value

impl<T, S> PartialEq<T> for MappedSignal<T, S>

where T: PartialEq + 'static, S: AnyStorage,

fn eq(&self, other: &T) -> 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<O, S> PartialEq for MappedSignal<O, S>

where S: AnyStorage, O: ?Sized,

fn eq(&self, other: &MappedSignal<O, S>) -> 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<O, S> Readable for MappedSignal<O, S>

where S: AnyStorage, O: ?Sized,

type Target = O

The target type of the reference.

type Storage = S

The type of the storage this readable uses.

fn try_read( &self ) -> Result<<<MappedSignal<O, S> as Readable>::Storage as AnyStorage>::Ref<<MappedSignal<O, S> as Readable>::Target>, BorrowError>

Try to 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.

fn peek( &self ) -> <<MappedSignal<O, S> as Readable>::Storage as AnyStorage>::Ref<<MappedSignal<O, S> as Readable>::Target>

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

fn map<O>( self, f: impl Fn(&Self::Target) -> &O + 'static ) -> MappedSignal<O, Self::Storage>

where Self: Clone + Sized + 'static,

Map the readable type to a new type.

fn read(&self) -> <Self::Storage as AnyStorage>::Ref<Self::Target>

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.

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

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

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

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.