Struct freya::prelude::Runtime

pub struct Runtime { /* private fields */ }

A global runtime that is shared across all scopes that provides the async runtime and context API

Implementations

impl Runtime

pub fn current() -> Option<Rc<Runtime>>

Get the current runtime

pub fn on_scope<O>(&self, id: ScopeId, f: impl FnOnce() -> O) -> O

Call this function with the current scope set to the given scope

Useful in a limited number of scenarios

impl Runtime

pub fn spawn( &self, scope: ScopeId, task: impl Future<Output = ()> + 'static ) -> Task

Start a new future on the same thread as the rest of the VirtualDom.

This future will not contribute to suspense resolving, so you should primarily use this for reacting to changes and long running tasks.

Whenever the component that owns this future is dropped, the future will be dropped as well.

Spawning a future onto the root scope will cause it to be dropped when the root component is dropped - which will only occur when the VirtualDom itself has been dropped.

pub fn current_task(&self) -> Option<Task>

Get the currently running task

pub fn parent_task(&self, task: Task) -> Option<Task>

Get the parent task of the given task, if it exists