Struct rustcn_ui::GlobalSignal

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 write(&self) -> Write<T>

Write this value

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 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. Read more

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. Read more

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 ==.

1.0.0 · source§

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 ==.

1.0.0 · source§

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

type Target = T

The target type of the reference.

type Storage = UnsyncStorage

The type of the storage this readable uses.

fn try_read( &self ) -> Result<<<GlobalSignal<T> as Readable>::Storage as AnyStorage>::Ref<<GlobalSignal<T> as Readable>::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. If the value has been dropped, this will panic.

fn peek( &self ) -> <<GlobalSignal<T> as Readable>::Storage as AnyStorage>::Ref<<GlobalSignal<T> as Readable>::Target>

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

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.

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( &self, index: I ) -> <Self::Storage as AnyStorage>::Ref<<Self::Target as Index>::Output>
where Self::Target: Index,

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 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>::Mut, f: F ) -> <GlobalSignal<T> as Writable>::Mut
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_: <GlobalSignal<T> as Writable>::Mut, f: F ) -> Option<<GlobalSignal<T> as Writable>::Mut>
where I: 'static + ?Sized, 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>::Mut<T>, BorrowMutError>

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

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 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 index_mut( &mut self, index: I ) -> Self::Mut<<Self::Target as Index>::Output>
where Self::Target: IndexMut,

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

Auto Trait Implementations§

impl<T> UnwindSafe for GlobalSignal<T>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T, R> ReadableOptionExt<T> for R
where T: 'static, R: Readable<Target = Option<T>>,

fn unwrap(&self) -> T
where T: Clone,

Unwraps the inner value and clones it.

fn as_ref(&self) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Attempts to read the inner value of the Option.

impl<T, R> ReadableVecExt<T> for R
where T: 'static, R: Readable<Target = Vec<T>>,

fn len(&self) -> usize

Returns the length of the inner vector.

fn is_empty(&self) -> bool

Returns true if the inner vector is empty.

fn first(&self) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Get the first element of the inner vector.

fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Get the last element of the inner vector.

fn get(&self, index: usize) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Get the element at the given index of the inner vector.

fn iter(&self) -> ReadableValueIterator<'_, Self> ⓘ
where Self: Sized,

Get an iterator over the values of the inner vector.

impl<T, O> SuperFrom<T> for O
where O: From<T>,

fn super_from(input: T) -> O

Convert from a type to another type.

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

fn super_into(self) -> O

Convert from a type to another type.

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

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T, W> WritableOptionExt<T> for W
where T: 'static, W: Writable<Target = Option<T>>,

fn get_or_insert(&mut self, default: T) -> Self::Mut<T>

Gets the value out of the Option, or inserts the given value if the Option is empty.

fn get_or_insert_with(&mut self, default: impl FnOnce() -> T) -> Self::Mut<T>

Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty.

fn as_mut(&mut self) -> Option<Self::Mut<T>>

Attempts to write the inner value of the Option.

impl<T, W> WritableVecExt<T> for W
where T: 'static, W: Writable<Target = Vec<T>>,

fn push(&mut self, value: T)

Pushes a new value to the end of the vector.

fn pop(&mut self) -> Option<T>

Pops the last value from the vector.

fn insert(&mut self, index: usize, value: T)

Inserts a new value at the given index.

fn remove(&mut self, index: usize) -> T

Removes the value at the given index.

fn clear(&mut self)

Clears the vector, removing all values.

fn extend(&mut self, iter: impl IntoIterator<Item = T>)

Extends the vector with the given iterator.

fn truncate(&mut self, len: usize)

Truncates the vector to the given length.

fn swap_remove(&mut self, index: usize) -> T

Swaps two values in the vector.

fn retain(&mut self, f: impl FnMut(&T) -> bool)

Retains only the values that match the given predicate.

fn split_off(&mut self, at: usize) -> Vec<T>

Splits the vector into two at the given index.

fn get_mut(&mut self, index: usize) -> Option<Self::Mut<T>>

Try to mutably get an element from the vector.