Module task

Available on crate feature task only.

Macros§

AbortHandle: An owned permission to abort a spawned task, without awaiting its completion.
Context: The context of an asynchronous task.
Id: An opaque ID that uniquely identifies a task relative to all other currently running tasks.
Interval: Interval returned by interval and interval_at.
JoinError: Task failed to execute to completion.
JoinHandle: An owned permission to join on a task (await its termination).
JoinSet: A collection of tasks spawned on a Tokio runtime.
RawWaker: A RawWaker allows the implementor of a task executor to create a Waker or a LocalWaker which provides customized wakeup behavior.
RawWakerVTable: A virtual function pointer table (vtable) that specifies the behavior of a RawWaker.
Sleep: Future returned by sleep and sleep_until.
Timeout: Future returned by timeout and timeout_at.
TimeoutElapsed: Errors returned by Timeout.
Waker: A Waker is a handle for waking up a task by notifying its executor that it is ready to be run.

MissedTickBehavior: Defines the behavior of an Interval when it misses a tick.
Poll: Indicates whether a value is available or if the current task has been scheduled to receive a wakeup instead.

id: Returns the Id of the currently running task.
interval: Creates new Interval that yields with interval of period. The first tick completes immediately. The default MissedTickBehavior is Burst, but this can be configured by calling set_missed_tick_behavior.
interval_at: Creates new Interval that yields with interval of period with the first tick completing at start. The default MissedTickBehavior is Burst, but this can be configured by calling set_missed_tick_behavior.
sleep: Waits until duration has elapsed.
sleep_until: Waits until deadline is reached.
spawn: Spawns a new asynchronous task, returning a JoinHandle for it.
spawn_blocking: Runs the provided closure on a thread where blocking is acceptable.
spawn_local: Spawns a !Send future on the current LocalSet or LocalRuntime.
timeout: Requires a Future to complete before the specified duration has elapsed.
timeout_at: Requires a Future to complete before the specified instant in time.
try_id: Returns the Id of the currently running task, or None if called outside of a task.
yield_now: Yields execution back to the Tokio runtime.