Join

Struct Join 

Source
pub struct Join<T> { /* private fields */ }
Expand description

Concurrently waits for the results of multiple tasks.

Implementations§

Source§

impl<T> Join<T>
where T: Send + 'static,

Source

pub fn new() -> Self

Creates an empty join.

Source

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

Adds a task to the join, returning its index.

Source

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.

Source

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.

Source

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.

Source

pub async fn drain(&mut self)

Waits for all tasks to stop, dropping their results.

Source

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

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

Trait Implementations§

Source§

impl<T> Default for Join<T>
where T: Send + 'static,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Join<T>

§

impl<T> RefUnwindSafe for Join<T>

§

impl<T> Send for Join<T>
where T: Send,

§

impl<T> Sync for Join<T>
where T: Send,

§

impl<T> Unpin for Join<T>

§

impl<T> UnwindSafe for Join<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V