Skip to main content

AppRuntime

Struct AppRuntime 

pub struct AppRuntime { /* private fields */ }
Expand description

The process-wide app runtime: a current-thread tokio runtime driven by a dedicated thread.

One thread is enough for an app: its async work is network and IPC waiting, not computation. CPU-bound work goes to crate::cpu() and blocking calls to AppRuntime::spawn_blocking, so neither stalls the other tasks.

The runtime starts on first use and lives as long as the process.

Implementations§

§

impl AppRuntime

pub const fn handle(&self) -> &Handle

The runtime’s handle, for APIs that take one or need a runtime context (handle().enter()) to construct I/O resources.

pub const fn thread_id(&self) -> ThreadId

The thread that drives this runtime.

pub fn is_runtime_thread(&self) -> bool

Whether the calling thread is the one driving this runtime.

pub fn spawn<F>(&self, future: F) -> JoinHandle<<F as Future>::Output> ⓘ
where F: Future + Send + 'static, <F as Future>::Output: Send + 'static,

Run future on the runtime thread. Returns immediately; the caller never polls it.

pub fn spawn_then<F, D>(&self, future: F, deliver: D) -> JoinHandle<()> ⓘ
where F: Future + Send + 'static, <F as Future>::Output: Send + 'static, D: FnOnce(<F as Future>::Output) + Send + 'static,

Run future on the runtime thread, then hand its output to deliver there. deliver should only publish — complete a LatestRequest, send on a channel — so the runtime thread is free for the next task. This is the UI handoff: the UI thread spawns, and deliver wakes the event loop with the result.

pub fn spawn_pinned<M, F>(&self, make: M) -> JoinHandle<<F as Future>::Output> ⓘ
where M: FnOnce() -> F + Send + 'static, F: Future + 'static, <F as Future>::Output: Send + 'static,

Run the future make builds, where the future may hold values that stay on one thread (a browser page’s storage handles, where that is the target): natively it is built and driven on one thread of the blocking pool, with the runtime’s drivers.

pub fn spawn_blocking<F, R>(&self, call: F) -> JoinHandle<R> ⓘ
where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Run a blocking call on the runtime’s bounded blocking pool.

pub fn block_on<F>(&self, future: F) -> Result<<F as Future>::Output, Error>
where F: Future,

Wait on future from a synchronous thread.

For threads that own a blocking API (a git transport callback, a decoder loop, a synchronous library entry point) and need one async result. The caller polls future itself — so it may borrow — while the runtime thread drives its sockets and timers and runs anything it spawns. No runtime is built per call.

§Errors

Error::UiThread on a UI thread, Error::InsideRuntime from a runtime context, where waiting would stall the tasks that thread is meant to run.

Trait Implementations§

§

impl Debug for AppRuntime

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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

§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T

§

impl<T> WasmNotSync for T
where T: Sync,