Struct af_lib::prelude::af_core::task::try_join::TryJoin

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

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

Implementations

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

pub fn new() -> TryJoin<T, E>

Creates an empty join.

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

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>>
) -> usize

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>) -> usize

Adds a task to the join, returning its index.

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

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
    E: From<Panic> + Send + 'static,
    T: Send + 'static, 

pub fn default() -> TryJoin<T, E>

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.

pub fn deref(&self) -> &<TryJoin<T, E> as Deref>::Target

Dereferences the value.

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

pub fn deref_mut(&mut self) -> &mut <TryJoin<T, E> as Deref>::Target

Mutably dereferences the value.