Struct freya::prelude::GlobalSignal

pub struct GlobalSignal<T> { /* private fields */ }

A signal that can be accessed from anywhere in the application and created in a static

Implementations

impl<T> GlobalSignal<T>where T: 'static,

pub const fn new(initializer: fn() -> T) -> GlobalSignal<T>

Create a new global signal with the given initializer.

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

Get the signal that backs this global.

pub fn origin_scope(&self) -> ScopeId

Get the scope the signal was created in.

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

Run a closure with a mutable reference to the signal’s value. If the signal has been dropped, this will panic.

pub fn map<O>( &self, f: impl Fn(&T) -> &O + 'static ) -> MappedSignal<GenerationalRef<Ref<'static, O>>>

Map the signal to a new type.

pub fn id(&self) -> GenerationalBoxId

Get the generational id of the signal.

Trait Implementations

impl<T> Debug for GlobalSignal<T>where T: Debug + 'static,

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

Formats the value using the given formatter.

impl<T> Deref for GlobalSignal<T>where T: Clone + '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() -> T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> Display for GlobalSignal<T>where T: Display + 'static,

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

Formats the value using the given formatter.

impl<T> IntoAttributeValue for GlobalSignal<T>where T: 'static + Clone + IntoAttributeValue,

fn into_value(self) -> AttributeValue

Convert into an attribute value

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

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<T> PartialEq for GlobalSignal<T>where T: 'static,

fn eq(&self, other: &GlobalSignal<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<T> Readable<T> for GlobalSignal<T>where T: 'static,

type Ref<R: 'static + ?Sized> = GenerationalRef<Ref<'static, R>>

The type of the reference.

fn map_ref<I, U, F>( ref_: <GlobalSignal<T> as Readable<T>>::Ref<I>, f: F ) -> <GlobalSignal<T> as Readable<T>>::Ref<U>where F: FnOnce(&I) -> &U, U: ?Sized,

Map the reference to a new type.

fn try_map_ref<I, U, F>( ref_: <GlobalSignal<T> as Readable<T>>::Ref<I>, f: F ) -> Option<<GlobalSignal<T> as Readable<T>>::Ref<U>>where F: FnOnce(&I) -> Option<&U>, U: ?Sized,

Try to map the reference to a new type.

fn read(&self) -> <GlobalSignal<T> as Readable<T>>::Ref<T>

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) -> <GlobalSignal<T> as Readable<T>>::Ref<T>

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

fn with<O>(&self, f: impl FnOnce(&T) -> 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(&T) -> 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::Ref<<T as Index<I>>::Output>where T: 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.

impl<T> Writable<T> for GlobalSignal<T>where T: 'static,

type Mut<R: 'static + ?Sized> = Write<R>

The type of the reference.

fn map_mut<I, U, F>( ref_: <GlobalSignal<T> as Writable<T>>::Mut<I>, f: F ) -> <GlobalSignal<T> as Writable<T>>::Mut<U>where U: 'static + ?Sized, F: FnOnce(&mut I) -> &mut U,

Map the reference to a new type.

fn try_map_mut<I, U, F>( ref_: <GlobalSignal<T> as Writable<T>>::Mut<I>, f: F ) -> Option<<GlobalSignal<T> as Writable<T>>::Mut<U>>where I: 'static, U: 'static + ?Sized, F: FnOnce(&mut I) -> Option<&mut U>,

Try to map the reference to a new type.

fn try_write( &self ) -> Result<<GlobalSignal<T> as Writable<T>>::Mut<T>, BorrowMutError>

Try to get a mutable reference to the value. If the value has been dropped, this will panic.

fn write(&self) -> Self::Mut<T>

Get a mutable reference to the value. If the value has been dropped, this will panic.

fn with_mut<O>(&self, f: impl FnOnce(&mut T) -> O) -> O

Run a function with a mutable reference to the value. If the value has been dropped, this will panic.

fn set(&mut self, value: T)

Set the value of the signal. This will trigger an update on all subscribers.

fn index_mut<I>(&self, index: I) -> Self::Mut<<T as Index<I>>::Output>where T: IndexMut<I>,

Index into the inner value and return a reference to the result.

fn replace(&self, value: T) -> T

Replace the value in the Signal, returning the old value.