Struct dioxus::prelude::ReactiveContext

pub struct ReactiveContext { /* private fields */ }

Available on crate feature signals only.

A context for signal reads and writes to be directed to

When a signal calls .read(), it will look for the current ReactiveContext to read from. If it doesn’t find it, then it will try and insert a context into the nearest component scope via context api.

When the ReactiveContext drops, it will remove itself from the associated contexts attached to signal

Implementations

impl ReactiveContext

pub fn new() -> (ReactiveContext, UnboundedReceiver<()>)

Create a new reactive context

pub fn new_with_origin( origin: &'static Location<'static> ) -> (ReactiveContext, UnboundedReceiver<()>)

Create a new reactive context with a location for debugging purposes This is useful for reactive contexts created within closures

pub fn new_with_callback( callback: impl FnMut() + Send + Sync + 'static, scope: ScopeId, origin: &'static Location<'static> ) -> ReactiveContext

Create a new reactive context that may update a scope. When any signal that this context subscribes to changes, the callback will be run

pub fn current() -> Option<ReactiveContext>

Get the current reactive context

If this was set manually, then that value will be returned.

If there’s no current reactive context, then a new one will be created for the current scope and returned.

pub fn run_in<O>(&self, f: impl FnOnce() -> O) -> O

Run this function in the context of this reactive context

This will set the current reactive context to this context for the duration of the function. You can then get information about the current subscriptions.

pub fn mark_dirty(&self) -> bool

Marks this reactive context as dirty

If there’s a scope associated with this context, then it will be marked as dirty too

Returns true if the context was marked as dirty, or false if the context has been dropped

pub fn origin_scope(&self) -> ScopeId

Get the scope that inner CopyValue is associated with

Trait Implementations

impl Clone for ReactiveContext

fn clone(&self) -> ReactiveContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for ReactiveContext

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

Formats the value using the given formatter.

impl Hash for ReactiveContext

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 PartialEq for ReactiveContext

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

impl Eq for ReactiveContext

impl StructuralPartialEq for ReactiveContext