Struct GroupJoinHandle

pub struct GroupJoinHandle<E> { /* private fields */ }

A JoinHandle is used to manage a collection of tasks. There are two things you can do with it:

• JoinHandle impls Future, so you can poll or await on it. It will be Ready when all tasks return Ok(()) and the associated TaskGroup is dropped (so no more tasks can be created), or when any task panicks or returns an Err(E).
• When a JoinHandle is dropped, all tasks it contains are canceled (terminated). So, if you use a combinator like tokio::time::timeout(duration, task_manager).await, all tasks will be terminated if the timeout occurs.

Trait Implementations

impl<E: Debug> Debug for GroupJoinHandle<E>

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

Formats the value using the given formatter.

impl<E> Future for GroupJoinHandle<E>

type Output = Result<(), E>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.