Struct TryJoin 

pub struct TryJoin<T, E> { /* private fields */ }

Concurrently waits for the results of multiple tasks that may return an error.

Implementations

impl<T, E> TryJoin<T, E>

where T: Send + 'static, E: From<Panic> + Send + 'static,

pub fn new() -> Self

Creates an empty join.

pub fn add(&mut self, task: impl Start<Result<T, E>>) -> Index

Adds a task to the join, returning its index.

pub fn add_as( &mut self, name: impl Into<SharedString>, task: impl Start<Result<T, E>>, ) -> Index

Adds a named task to the join, returning its index.

pub async fn next(&mut self) -> Option<StoppedTask<T, E>>

Waits for the next stopped task.

If all tasks have stopped, this function returns None.

pub async fn try_next( &mut self, ) -> Option<Result<FinishedTask<T>, FailedTask<E>>>

Waits for the next stopped task and returns its information as a Result.

If all tasks have stopped, this function returns None.

pub async fn drain(&mut self)

Waits for all tasks to stop, dropping their results.

pub async fn try_drain(&mut self) -> Result<(), FailedTask<E>>

Waits for all tasks to stop, dropping their results, until a task fails.

Methods from Deref<Target = Join<Result<T, E>>>

pub fn add(&mut self, task: impl Start<T>) -> Index

Adds a task to the join, returning its index.

pub fn add_as( &mut self, name: impl Into<SharedString>, task: impl Start<T>, ) -> Index

Adds a named task to the join, returning its index.

pub async fn next(&mut self) -> Option<StoppedTask<Result<T, Panic>>>

Waits for the next stopped task.

If all tasks have stopped, this function returns None.

pub async fn try_next(&mut self) -> Option<Result<StoppedTask<T>, PanickedTask>>

Waits for the next stopped task and returns its information as a Result.

If all tasks have stopped, this function returns None.

pub async fn drain(&mut self)

Waits for all tasks to stop, dropping their results.

pub async fn try_drain(&mut self) -> Result<(), PanickedTask>

Waits for all tasks to stop, dropping their results, until a task panics.

Trait Implementations

impl<T, E> Default for TryJoin<T, E>

where T: Send + 'static, E: From<Panic> + Send + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<T, E> Deref for TryJoin<T, E>

type Target = Join<Result<T, E>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, E> DerefMut for TryJoin<T, E>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.