pub struct Global<T, R = T> { /* private fields */ }
Expand description
A lazy value that is created once per application and can be accessed from anywhere in that application
Implementations§
Source§impl<T, R> Global<T, R>where
T: Clone + 'static + InitializeFromFunction<R>,
impl<T, R> Global<T, R>where
T: Clone + 'static + InitializeFromFunction<R>,
Sourcepub const fn with_name(
constructor: fn() -> R,
key: &'static str,
) -> Global<T, R>
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.
Sourcepub const fn with_location(
constructor: fn() -> R,
file: &'static str,
line: u32,
column: u32,
index: usize,
) -> Global<T, R>
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.
Sourcepub fn resolve(&self) -> T
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.
Sourcepub fn origin_scope(&self) -> ScopeId
pub fn origin_scope(&self) -> ScopeId
Get the scope the signal was created in.
Trait Implementations§
Source§impl<T, R> Deref for Global<T, R>
Allow calling a signal with signal() syntax
impl<T, R> Deref for Global<T, R>
Allow calling a signal with signal() syntax
Currently only limited to copy types, though could probably specialize for string/arc/rc
Source§impl<T, R> Readable for Global<T, R>
impl<T, R> Readable for Global<T, R>
Source§fn try_read_unchecked(
&self,
) -> Result<<<Global<T, R> as Readable>::Storage as AnyStorage>::Ref<'static, <Global<T, R> as Readable>::Target>, BorrowError>
fn try_read_unchecked( &self, ) -> Result<<<Global<T, R> as Readable>::Storage as AnyStorage>::Ref<'static, <Global<T, R> as Readable>::Target>, BorrowError>
Source§fn try_peek_unchecked(
&self,
) -> Result<<<Global<T, R> as Readable>::Storage as AnyStorage>::Ref<'static, <Global<T, R> as Readable>::Target>, BorrowError>
fn try_peek_unchecked( &self, ) -> Result<<<Global<T, R> as Readable>::Storage as AnyStorage>::Ref<'static, <Global<T, R> as Readable>::Target>, BorrowError>
Source§fn map<O>(
self,
f: impl Fn(&Self::Target) -> &O + 'static,
) -> MappedSignal<O, Self::Storage>
fn map<O>( self, f: impl Fn(&Self::Target) -> &O + 'static, ) -> MappedSignal<O, Self::Storage>
Source§fn read(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>
fn read(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>
Source§fn try_read(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>
fn try_read( &self, ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>
Source§fn read_unchecked(
&self,
) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>
fn read_unchecked( &self, ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>
Source§fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>
fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>
Source§fn try_peek(
&self,
) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>
fn try_peek( &self, ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>
Source§fn peek_unchecked(
&self,
) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>
fn peek_unchecked( &self, ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>
Source§fn cloned(&self) -> Self::Target
fn cloned(&self) -> Self::Target
Source§fn with<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> O
fn with<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> O
Source§impl<T, R> Writable for Global<T, R>
impl<T, R> Writable for Global<T, R>
Source§type Mut<'a, Read: 'static + ?Sized> = <T as Writable>::Mut<'a, Read>
type Mut<'a, Read: 'static + ?Sized> = <T as Writable>::Mut<'a, Read>
Source§fn map_mut<I, U, F>(
ref_: <Global<T, R> as Writable>::Mut<'_, I>,
f: F,
) -> <Global<T, R> as Writable>::Mut<'_, U>
fn map_mut<I, U, F>( ref_: <Global<T, R> as Writable>::Mut<'_, I>, f: F, ) -> <Global<T, R> as Writable>::Mut<'_, U>
Source§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>>
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>>
Source§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,
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,
Source§fn try_write_unchecked(
&self,
) -> Result<<Global<T, R> as Writable>::Mut<'static, <Global<T, R> as Readable>::Target>, BorrowMutError>
fn try_write_unchecked( &self, ) -> Result<<Global<T, R> as Writable>::Mut<'static, <Global<T, R> as Readable>::Target>, BorrowMutError>
Source§fn write(&mut self) -> Self::Mut<'_, Self::Target>
fn write(&mut self) -> Self::Mut<'_, Self::Target>
Source§fn try_write(&mut self) -> Result<Self::Mut<'_, Self::Target>, BorrowMutError>
fn try_write(&mut self) -> Result<Self::Mut<'_, Self::Target>, BorrowMutError>
Source§fn write_unchecked(&self) -> Self::Mut<'static, Self::Target>
fn write_unchecked(&self) -> Self::Mut<'static, Self::Target>
Source§fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> O
fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> O
Source§fn set(&mut self, value: Self::Target)
fn set(&mut self, value: Self::Target)
Source§fn toggle(&mut self)
fn toggle(&mut self)
Source§fn index_mut<I>(
&mut self,
index: I,
) -> Self::Mut<'_, <Self::Target as Index<I>>::Output>
fn index_mut<I>( &mut self, index: I, ) -> Self::Mut<'_, <Self::Target as Index<I>>::Output>
Auto Trait Implementations§
impl<T, R> Freeze for Global<T, R>
impl<T, R> RefUnwindSafe for Global<T, R>
impl<T, R> Send for Global<T, R>
impl<T, R> Sync for Global<T, R>
impl<T, R> Unpin for Global<T, R>
impl<T, R> UnwindSafe for Global<T, R>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> InitializeFromFunction<T> for T
impl<T> InitializeFromFunction<T> for T
Source§fn initialize_from_function(f: fn() -> T) -> T
fn initialize_from_function(f: fn() -> T) -> T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T, R> ReadableOptionExt<T> for R
impl<T, R> ReadableOptionExt<T> for R
Source§impl<T, E, R> ReadableResultExt<T, E> for R
impl<T, E, R> ReadableResultExt<T, E> for R
Source§impl<T, R> ReadableVecExt<T> for R
impl<T, R> ReadableVecExt<T> for R
Source§fn first(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>
fn first(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>
Source§fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>
fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<'_, T>>
Source§impl<Ret> SpawnIfAsync<(), Ret> for Ret
impl<Ret> SpawnIfAsync<(), Ret> for Ret
Source§impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
Source§fn super_from(input: T) -> O
fn super_from(input: T) -> O
Source§impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
Source§fn super_into(self) -> O
fn super_into(self) -> O
Source§impl<T> ToStringFallible for Twhere
T: Display,
impl<T> ToStringFallible for Twhere
T: Display,
Source§fn try_to_string(&self) -> Result<String, TryReserveError>
fn try_to_string(&self) -> Result<String, TryReserveError>
ToString::to_string
, but without panic on OOM.