Struct Runtime 

pub struct Runtime { /* private fields */ }

The async runtime for ntex.

This is a thread-local runtime and cannot be sent to other threads.

Implementations

impl Runtime

pub fn new(handle: Box<dyn Notify>) -> Runtime

Creates a runtime with default configuration.

pub fn builder() -> RuntimeBuilder

Creates a runtime builder.

pub fn with_current<T, F>(f: F) -> T

where F: FnOnce(&Runtime) -> T,

Runs a closure with the runtime active on the current thread.

Panics

Panics if no runtime is active on the current thread.

pub fn handle(&self) -> Handle

Returns a handle to this runtime.

pub fn spawn<F>(&self, future: F) -> JoinHandle<<F as Future>::Output>

where F: Future + 'static,

Spawns a new asynchronous task, returning a JoinHandle for it.

Spawning a task enables the task to execute concurrently to other tasks. There is no guarantee that a spawned task will execute to completion.

pub unsafe fn spawn_unchecked<F>( &self, future: F, ) -> JoinHandle<<F as Future>::Output>

where F: Future,

Spawns a new asynchronous task, returning a JoinHandle for it.

Safety

The caller should ensure the captured lifetime is long enough.

pub fn awake(&self)

Marks the runtime as awake.

Drivers call this after returning from a blocking wait, before handling events that wake tasks. Tasks scheduled from the runtime thread do not notify the driver until poll finds no more tasks to run, the driver must call poll before blocking again.

pub fn poll(&self) -> PollResult

Polls the runtime and runs scheduled tasks.

pub fn block_on<F>( &self, future: F, driver: &(dyn Driver + 'static), ) -> <F as Future>::Output

where F: Future,

Runs the provided future.

Blocks the current thread until the future completes.

Panics

Panics if the driver fails to run the provided future.

Trait Implementations

impl Debug for Runtime

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

Formats the value using the given formatter.

impl Drop for Runtime

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.