Struct GlobalSignalsRuntime 

pub struct GlobalSignalsRuntime;

A plain SignalsRuntimeRef implementation that represents a static signals runtime.

🚧 This implementation is currently not optimised. 🚧

Features

Enable the global_signals_runtime Cargo feature to implement SignalsRuntimeRef for this type.

Logic

This runtime is guaranteed to have settled whenever the across all threads last borrow of it ceases, but only regarding effects originating on the current thread. Effects from other threads won’t necessarily be visible without external synchronisation points.

(This means that in addition to transiently borrowing calls, returned Futures may cause the GlobalSignalsRuntime not to settle until they are dropped.)

Otherwise, it makes no additional guarantees over those specified in SignalsRuntimeRef’s documentation.

Panics

SignalsRuntimeRef::Symbols associated with the GlobalSignalsRuntime are ordered.
Given GSRSymbols a and b, b can depend on a only iff a < b (by creation order).

Trait Implementations

impl Clone for GlobalSignalsRuntime

fn clone(&self) -> GlobalSignalsRuntime

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GlobalSignalsRuntime

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

Formats the value using the given formatter.

impl Default for GlobalSignalsRuntime

fn default() -> GlobalSignalsRuntime

Returns the “default value” for a type.

impl Hash for GlobalSignalsRuntime

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GlobalSignalsRuntime

fn cmp(&self, other: &GlobalSignalsRuntime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GlobalSignalsRuntime

fn eq(&self, other: &GlobalSignalsRuntime) -> 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 PartialOrd for GlobalSignalsRuntime

fn partial_cmp(&self, other: &GlobalSignalsRuntime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SignalsRuntimeRef for GlobalSignalsRuntime

The feature "global_signals_runtime" is required to enable this implementation.

type Symbol = GSRSymbol

The signal instance key used by this SignalsRuntimeRef.

type CallbackTableTypes = GlobalCallbackTableTypes

Types used in callback signatures.

type UpdateEager<'f, T: 'f, F: 'f> = DetachedFuture<'f, Result<T, F>>

The type of the Future returned by update_eager.

fn next_id(&self) -> GSRSymbol

Creates a fresh unique SignalsRuntimeRef::Symbol for this instance.

fn record_dependency( &self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol, )

When run in a context that records dependencies, records id as dependency of that context.

unsafe fn start<T, D>( &self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol, f: impl FnOnce() -> T, callback_table: *const CallbackTable<D, <GlobalSignalsRuntime as SignalsRuntimeRef>::CallbackTableTypes>, callback_data: *const D, ) -> T

where D: ?Sized,

Starts managed callback processing for id.

fn stop(&self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol)

Removes callbacks associated with id.

fn update_dependency_set<T>( &self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol, f: impl FnOnce() -> T, ) -> T

Executes f while recording dependencies for id, updating the recorded dependencies for id to the new set.

fn subscribe(&self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol)

Increases the intrinsic subscription count of id.

fn unsubscribe(&self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol)

Decreases the intrinsic subscription count of id.

fn update_or_enqueue( &self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol, f: impl Send + FnOnce() -> Propagation + 'static, )

Submits f to run exclusively for id without recording dependencies.

fn update_eager<'f, T, F>( &self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol, f: F, ) -> <GlobalSignalsRuntime as SignalsRuntimeRef>::UpdateEager<'f, T, F>

where T: 'f + Send, F: 'f + Send + FnOnce() -> (Propagation, T),

Immediately submits f to run exclusively for id without recording dependencies.

fn update_blocking<T>( &self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol, f: impl FnOnce() -> (Propagation, T), ) -> T

Runs f exclusively for id without recording dependencies.

fn run_detached<T>(&self, f: impl FnOnce() -> T) -> T

Runs f exempted from any outer dependency recordings.

fn refresh(&self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol)

Safety

fn purge(&self, id: <GlobalSignalsRuntime as SignalsRuntimeRef>::Symbol)

Removes existing callbacks, dependency relations (in either direction) associated with id.

fn hint_batched_updates<T>(&self, f: impl FnOnce() -> T) -> T

Hints to the signals runtime that contained operations (usually: on the current thread) are related and that update propagation is likely to benefit from batching/deduplication.

impl Copy for GlobalSignalsRuntime

impl Eq for GlobalSignalsRuntime

impl StructuralPartialEq for GlobalSignalsRuntime