Module runtime 

Builder API to configure and create a runtime.

Modules

cancel

Cancellation APIs for tasks built on top of the global task tree. Provides APIs for programmatic task cancellation.

runtime

Builder API to configure and create a runtime.

spawn

Utilities to spawn new tasks. Provides functions and types for spawning new tasks onto the runtime.

Structs

Builder

Runtime Builder API.

Runtime

A ringolo runtime instance.

TaskMetadata

A set of string tags used to identify a task.

TaskOpts

Configuration options for a new task.

Enums

AddMode

Instructs the scheduler if a task should be added at front or back of the run queue.

OnCleanupError

Defines the runtime’s policy for handling I/O cleanup failures.

OrphanPolicy

Defines the runtime’s structured concurrency policy.

Functions

block_on

We block_on on a special future that we refer to as the root_future. It is guaranteed to be polled on the current thread, and is central in deciding how and when the runtime returns. This is why it has looser bounds (!Send and !Sync).

recursive_cancel_all

Recursively cancels all child tasks of the current task.

recursive_cancel_all_leaves

Recursively cancels all leaf tasks within the current task’s hierarchy.

recursive_cancel_all_metadata

Recursively cancels tasks in the hierarchy that match all metadata tags.

recursive_cancel_all_orphans

Cancels all tasks that have been “orphaned.”

recursive_cancel_any_metadata

Recursively cancels tasks in the hierarchy that match any metadata tag.

spawn

Spawns a new asynchronous task with default options.

spawn_builder

Creates a new SpawnBuilder for configuring and spawning a task.