MapSignal

Struct MapSignal 

Source
pub struct MapSignal<T: 'static, U: 'static> { /* private fields */ }
Expand description

A signal wrapping another signal and applying a mapping function, when the inner value is requested. The mapping function will be called every time the inner value is requested via Signal::get. This signal cannot be directly mutated. Use MapSignal::signal to get the inner signal.

Calling Signal::set, Signal::set_value, Signal::listen has no effect.

Implementations§

Source§

impl<T: 'static, U: 'static> MapSignal<T, U>

Source

pub fn new( signal: BoxedSignal<T>, map: impl Fn(Ref<'_, T>) -> Ref<'_, U> + 'static, ) -> Self

Create a new map signal using the given inner signal and mapping function.

Source

pub fn signal(&self) -> BoxedSignal<T>

Get the inner signal.

Can be used to mutate the inner value.

Source

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

Get the inner signal’s value, without applying the mapping function.

Trait Implementations§

Source§

impl<T: 'static, U: 'static> Clone for MapSignal<T, U>

Source§

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
Source§

impl<T: 'static, U: 'static> From<MapSignal<T, U>> for MaybeSignal<U>

Source§

fn from(value: MapSignal<T, U>) -> Self

Converts to this type from the input type.
Source§

impl<T: 'static, U: 'static> Signal<U> for MapSignal<T, U>

Source§

fn get(&self) -> Ref<'_, U>

Get a reference to the current value of the signal.
Source§

fn set_value(&self, _: U)

Set the value of the signal. Read more
Source§

fn listen(self, _: Box<dyn Fn(Ref<'_, U>)>) -> Self
where Self: Sized,

Add a listener to the signal, which will be called when the inner value changes and returns the signal.
Source§

fn notify(&self)

Notify listeners that the inner value has changed. May also be called manually to update listeners.
Source§

fn dyn_clone(&self) -> Box<dyn Signal<U>>

Clones the signal into a Box<dyn Signal<T>>. Read more
Source§

fn set(&self, value: T)

Set the value of the signal and notify listeners.
Source§

fn maybe(&self) -> MaybeSignal<T>
where Self: Sized,

Converts the signal into a MaybeSignal.
Source§

fn map<U: 'static>( &self, map: impl Fn(Ref<'_, T>) -> Ref<'_, U> + 'static, ) -> MapSignal<T, U>
where Self: Sized,

Converts this signal into a MapSignal and applies the given mapping function.
Source§

fn hook(self, context: &AppContext) -> Self
where Self: Sized,

Hooks the signal into the given AppContext. Read more

Auto Trait Implementations§

§

impl<T, U> Freeze for MapSignal<T, U>

§

impl<T, U> !RefUnwindSafe for MapSignal<T, U>

§

impl<T, U> !Send for MapSignal<T, U>

§

impl<T, U> !Sync for MapSignal<T, U>

§

impl<T, U> Unpin for MapSignal<T, U>

§

impl<T, U> !UnwindSafe for MapSignal<T, U>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

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

Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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