Struct Global

pub struct Global<T, R = T> { /* private fields */ }

A lazy value that is created once per application and can be accessed from anywhere in that application

Implementations

impl<T> Global<Memo<T>, T>

where T: PartialEq + 'static,

pub fn id(&self) -> GenerationalBoxId

Get the generational id of the signal.

pub fn memo(&self) -> Memo<T>

Resolve the global memo. This will try to get the existing value from the current virtual dom, and if it doesn’t exist, it will create a new one.

impl<T> Global<Signal<T>, T>

where T: 'static,

pub fn id(&self) -> GenerationalBoxId

Get the generational id of the signal.

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

Resolve the global signal. This will try to get the existing value from the current virtual dom, and if it doesn’t exist, it will create a new one.

impl<T, R> Global<T, R>

where T: Clone + 'static + Writable<Target = R> + InitializeFromFunction<R>, R: 'static,

pub fn write(&self) -> <T as Writable>::Mut<'static, R>

Write this value

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

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

impl<T, R> Global<T, R>

where T: Clone + 'static + InitializeFromFunction<R>,

pub const fn new(constructor: fn() -> R) -> Global<T, R>

Create a new global value

pub const fn with_name( constructor: fn() -> R, key: &'static str, ) -> Global<T, R>

Create this global signal with a specific key. This is useful for ensuring that the signal is unique across the application and accessible from outside the application too.

pub const fn with_location( constructor: fn() -> R, file: &'static str, line: u32, column: u32, index: usize, ) -> Global<T, R>

Create this global signal with a specific key. This is useful for ensuring that the signal is unique across the application and accessible from outside the application too.

pub fn key(&self) -> GlobalKey<'static>

Get the key for this global

pub fn resolve(&self) -> T

Resolve the global value. This will try to get the existing value from the current virtual dom, and if it doesn’t exist, it will create a new one.

pub fn origin_scope(&self) -> ScopeId

Get the scope the signal was created in.

Trait Implementations

impl<T> Debug for Global<Memo<T>, T>

where T: Debug + 'static + PartialEq,

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

Formats the value using the given formatter.

impl<T> Debug for Global<Signal<T>, T>

where T: Debug + 'static,

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

Formats the value using the given formatter.

impl<T, R> Deref for Global<T, R>

where T: Clone + 'static + Readable<Target = R> + InitializeFromFunction<R>, R: 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() -> R

The resulting type after dereferencing.

fn deref(&self) -> &<Global<T, R> as Deref>::Target

Dereferences the value.

impl<T> Display for Global<Memo<T>, T>

where T: Display + 'static + PartialEq,

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

Formats the value using the given formatter.

impl<T> Display for Global<Signal<T>, T>

where T: Display + 'static,

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

Formats the value using the given formatter.

impl<T> PartialEq<T> for Global<Memo<T>, T>

where T: PartialEq + 'static,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq<T> for Global<Signal<T>, T>

where T: PartialEq + 'static,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, R> Readable for Global<T, R>

where T: Clone + 'static + Readable<Target = R> + InitializeFromFunction<R>, R: 'static,

type Target = R

The target type of the reference.

type Storage = <T as Readable>::Storage

The type of the storage this readable uses.

fn try_read_unchecked( &self, ) -> Result<<<Global<T, R> as Readable>::Storage as AnyStorage>::Ref<'static, <Global<T, R> as Readable>::Target>, BorrowError>

Try to get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal.

fn try_peek_unchecked( &self, ) -> Result<<<Global<T, R> as Readable>::Storage as AnyStorage>::Ref<'static, <Global<T, R> as Readable>::Target>, BorrowError>

Try to peek the current value of the signal without subscribing to updates. If the value has been dropped, this will return an error.

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

where Self: Sized + Clone + 'static,

Map the readable type to a new type. This lets you provide a view into a readable type without needing to clone the inner value.

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. Calling this on a Signal is the same as using the signal() syntax to read and subscribe to its value

fn try_read( &self, ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::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.

fn read_unchecked( &self, ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>

Get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal.

fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>

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

fn try_peek( &self, ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>

Try to peek the current value of the signal without subscribing to updates. If the value has been dropped, this will return an error.

fn peek_unchecked( &self, ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>

Get the current value of the signal without checking the lifetime. Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.

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

where Self::Target: Clone,

Clone the inner value and return it. 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.

impl<T, R> Writable for Global<T, R>

where T: Clone + 'static + Writable<Target = R> + InitializeFromFunction<R>, R: 'static,

type Mut<'a, Read: 'static + ?Sized> = <T as Writable>::Mut<'a, Read>

The type of the reference.

fn map_mut<I, U, F>( ref_: <Global<T, R> as Writable>::Mut<'_, I>, f: F, ) -> <Global<T, R> as Writable>::Mut<'_, U>

where U: 'static + ?Sized, F: FnOnce(&mut I) -> &mut U, I: ?Sized,

Map the reference to a new type.

fn try_map_mut<I, U, F>( ref_: <Global<T, R> as Writable>::Mut<'_, I>, f: F, ) -> Option<<Global<T, R> as Writable>::Mut<'_, U>>

where I: 'static + ?Sized, U: 'static + ?Sized, F: FnOnce(&mut I) -> Option<&mut U>,

Try to map the reference to a new type.

fn downcast_lifetime_mut<'a, 'b, Read>( mut_: <Global<T, R> as Writable>::Mut<'a, Read>, ) -> <Global<T, R> as Writable>::Mut<'b, Read>

where 'a: 'b, Read: 'static + ?Sized,

Downcast a mutable reference in a RefMut to a more specific lifetime

fn try_write_unchecked( &self, ) -> Result<<Global<T, R> as Writable>::Mut<'static, <Global<T, R> as Readable>::Target>, BorrowMutError>

Try to get a mutable reference to the value without checking the lifetime. This will update any subscribers.

fn write(&mut self) -> Self::Mut<'_, Self::Target>

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

fn try_write(&mut self) -> Result<Self::Mut<'_, Self::Target>, BorrowMutError>

Try to get a mutable reference to the value.

fn write_unchecked(&self) -> Self::Mut<'static, Self::Target>

Get a mutable reference to the value without checking the lifetime. This will update any subscribers.

fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> 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: Self::Target)

where Self::Target: Sized,

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

fn toggle(&mut self)

where Self::Target: Not<Output = Self::Target> + Clone,

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

fn index_mut<I>( &mut self, index: I, ) -> Self::Mut<'_, <Self::Target as Index<I>>::Output>

where Self::Target: IndexMut<I>,

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

fn take(&mut self) -> Self::Target

where Self::Target: Default,

Takes the value out of the Signal, leaving a Default in its place.

fn replace(&mut self, value: Self::Target) -> Self::Target

where Self::Target: Sized,

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