Struct freya::prelude::MappedSignal

pub struct MappedSignal<U>where
    U: 'static + ?Sized,{ /* private fields */ }

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

Implementations

impl MappedSignal<()>

pub fn new<T, S, U>( signal: Signal<T, S>, mapping: impl Fn(&T) -> &U + 'static ) -> MappedSignal<<S as AnyStorage>::Ref<U>>where S: Storage<SignalData<T>>, U: ?Sized,

Create a new mapped signal.

impl<U> MappedSignal<U>

pub fn origin_scope(&self) -> ScopeId

Get the scope that the signal was created in.

pub fn read(&self) -> U

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

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

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

impl<U> MappedSignal<U>where U: Clone + ?Sized,

pub fn value(&self) -> U

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

Trait Implementations

impl<U> Clone for MappedSignal<U>

fn clone(&self) -> MappedSignal<U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U> Debug for MappedSignal<U>where U: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for MappedSignal<T>

type Target = dyn Fn() -> T

The resulting type after dereferencing.

fn deref(&self) -> &<MappedSignal<T> as Deref>::Target

Dereferences the value.

impl<U> Display for MappedSignal<U>where U: Display,

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

Formats the value using the given formatter.

impl<U> PartialEq for MappedSignal<U>where U: ?Sized,

fn eq(&self, other: &MappedSignal<U>) -> 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<U> Copy for MappedSignal<U>