Struct Runtime 

pub struct Runtime(/* private fields */);

A type-erased RuntimeTrait implementation. Think of this as an Arc<dyn RuntimeTrait>

Implementations

impl Runtime

pub fn new(runtime: impl RuntimeTrait) -> Self

Construct a new type-erased runtime object from any RuntimeTrait implementation.

pub fn spawn<Output: Send + 'static>( &self, fut: impl Future<Output = Output> + Send + 'static, ) -> DroppableFuture<Pin<Box<dyn Future<Output = Option<Output>> + Send + 'static>>>

Spawn a future on the runtime, returning a future that has detach-on-drop semantics

Spawned tasks conform to the following behavior:

• detach on drop: If the returned DroppableFuture is dropped immediately, the task will continue to execute until completion.

• unwinding: If the spawned future panics, this must not propagate to the join handle. Instead, the awaiting the join handle returns None in case of panic.

pub fn spawn_detached<Fut>(&self, fut: Fut)

where Fut: Future<Output = ()> + Send + 'static,

Spawn a future on the runtime without a join handle.

Cheaper than spawn when the caller doesn’t need the output or completion signal: no channel or join-handle allocation is made.

pub async fn delay(&self, duration: Duration)

Wake in this amount of wall time

pub fn interval(&self, period: Duration) -> impl Stream<Item = ()> + Send + '_

Returns a Stream that yields a () on the provided period

pub fn block_on<Fut>(&self, fut: Fut) -> Fut::Output

where Fut: Future,

Runtime implementation hook for blocking on a top level future.

pub async fn timeout<Fut>( &self, duration: Duration, fut: Fut, ) -> Option<Fut::Output>

where Fut: Future + Send, Fut::Output: Send + 'static,

Race a future against the provided duration, returning None in case of timeout.

Trait Implementations

impl Clone for Runtime

fn clone(&self) -> Runtime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Runtime

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

Formats the value using the given formatter.

impl<R: RuntimeTrait> From<Arc<R>> for Runtime

fn from(value: Arc<R>) -> Self

Converts to this type from the input type.

impl RuntimeTrait for Runtime

async fn delay(&self, duration: Duration)

Wake in this amount of wall time

fn interval(&self, period: Duration) -> impl Stream<Item = ()> + Send + 'static

Returns a Stream that yields a () on the provided period

fn spawn<Fut>( &self, fut: Fut, ) -> DroppableFuture<impl Future<Output = Option<Fut::Output>> + Send + 'static>

where Fut: Future + Send + 'static, Fut::Output: Send + 'static,

Spawn a future on the runtime, returning a future that has detach-on-drop semantics

fn spawn_detached<Fut>(&self, fut: Fut)

where Fut: Future<Output = ()> + Send + 'static,

Spawn a future on the runtime without a join handle.

fn block_on<Fut>(&self, fut: Fut) -> Fut::Output

where Fut: Future,

Runtime implementation hook for blocking on a top level future.

fn hook_signals( &self, signals: impl IntoIterator<Item = i32>, ) -> impl Stream<Item = i32> + Send + 'static

trap and return a Stream of signals that match the provided signals

fn timeout<'runtime, 'fut, Fut>( &'runtime self, duration: Duration, fut: Fut, ) -> impl Future<Output = Option<Fut::Output>> + Send + 'fut

where Fut: Future + Send + 'fut, Fut::Output: Send + 'static, 'runtime: 'fut,

Race a future against the provided duration, returning None in case of timeout.