Struct JoinSet

pub struct JoinSet<T> { /* private fields */ }

A wrapper around Tokio’s JoinSet that forwards all API calls while optionally instrumenting spawned tasks and blocking closures with custom tracing behavior. If no tracer is injected via trace_utils::set_tracer, tasks and closures are executed without any instrumentation.

Implementations

impl<T> JoinSet<T>

pub fn new() -> Self

JoinSet::new - Create a new JoinSet.

pub fn len(&self) -> usize

JoinSet::len - Return the number of tasks.

pub fn is_empty(&self) -> bool

JoinSet::is_empty - Check if the JoinSet is empty.

impl<T: 'static> JoinSet<T>

pub fn spawn<F>(&mut self, task: F) -> AbortHandle

where F: Future<Output = T> + Send + 'static, T: Send,

JoinSet::spawn - Spawn a new task.

pub fn spawn_on<F>(&mut self, task: F, handle: &Handle) -> AbortHandle

where F: Future<Output = T> + Send + 'static, T: Send,

JoinSet::spawn_on - Spawn a task on a provided runtime.

pub fn spawn_local<F>(&mut self, task: F) -> AbortHandle

where F: Future<Output = T> + 'static,

JoinSet::spawn_local - Spawn a local task.

pub fn spawn_local_on<F>( &mut self, task: F, local_set: &LocalSet, ) -> AbortHandle

where F: Future<Output = T> + 'static,

JoinSet::spawn_local_on - Spawn a local task on a provided LocalSet.

pub fn spawn_blocking<F>(&mut self, f: F) -> AbortHandle

where F: FnOnce() -> T + Send + 'static, T: Send,

JoinSet::spawn_blocking - Spawn a blocking task.

pub fn spawn_blocking_on<F>(&mut self, f: F, handle: &Handle) -> AbortHandle

where F: FnOnce() -> T + Send + 'static, T: Send,

JoinSet::spawn_blocking_on - Spawn a blocking task on a provided runtime.

pub async fn join_next(&mut self) -> Option<Result<T, JoinError>>

JoinSet::join_next - Await the next completed task.

pub fn try_join_next(&mut self) -> Option<Result<T, JoinError>>

JoinSet::try_join_next - Try to join the next completed task.

pub fn abort_all(&mut self)

JoinSet::abort_all - Abort all tasks.

pub fn detach_all(&mut self)

JoinSet::detach_all - Detach all tasks.

pub fn poll_join_next( &mut self, cx: &mut Context<'_>, ) -> Poll<Option<Result<T, JoinError>>>

JoinSet::poll_join_next - Poll for the next completed task.

pub async fn join_next_with_id(&mut self) -> Option<Result<(Id, T), JoinError>>

JoinSet::join_next_with_id - Await the next completed task with its ID.

pub fn try_join_next_with_id(&mut self) -> Option<Result<(Id, T), JoinError>>

JoinSet::try_join_next_with_id - Try to join the next completed task with its ID.

pub fn poll_join_next_with_id( &mut self, cx: &mut Context<'_>, ) -> Poll<Option<Result<(Id, T), JoinError>>>

JoinSet::poll_join_next_with_id - Poll for the next completed task with its ID.

pub async fn shutdown(&mut self)

JoinSet::shutdown - Abort all tasks and wait for shutdown.

pub async fn join_all(self) -> Vec<T>

JoinSet::join_all - Await all tasks.

Trait Implementations

impl<T: Debug> Debug for JoinSet<T>

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

Formats the value using the given formatter.

impl<T> Default for JoinSet<T>

fn default() -> Self

Returns the “default value” for a type.