Struct JoinSet 

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

Same as tokio::task::JoinSet except the number of actively polled futures is limited to a set concurrency.

Does not support spawn_blocking.

For any undocumented methods see tokio::task::JoinSet.

Implementations

impl<T> JoinSet<T>

pub const MAX_CONCURRENCY: usize = 2_305_843_009_213_693_951usize

pub fn new(concurrency: usize) -> Self

Creates a new JoinSet with a set concurrency

Panics if concurrency is larger than JoinSet::MAX_CONCURRENCY

pub fn len(&self) -> usize

Returns number of active tasks, queued tasks, and completed tasks

pub fn is_empty(&self) -> bool

pub fn num_active(&self) -> usize

number of futures actively being polled

pub fn num_queued(&self) -> usize

number of tasks which have been pushed to the join set and are waiting to begin work

pub fn num_completed(&self) -> usize

number of tasks that have already been completed but have not been removed from the join set with join_next

impl<T: 'static> JoinSet<T>

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

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

See TokioJoinSet::spawn

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

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

See TokioJoinSet::spawn_on

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

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

See TokioJoinSet::spawn_local

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

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

See TokioJoinSet::spawn_local_on

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

See TokioJoinSet::join_next

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

See TokioJoinSet::join_next_with_id

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

See TokioJoinSet::try_join_next

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

See TokioJoinSet::try_join_next_with_id

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

See TokioJoinSet::join_all

pub async fn shutdown(&mut self)

See TokioJoinSet::spawn

pub fn abort_all(&mut self)

See TokioJoinSet::abort_all

pub fn detach_all(&mut self)

See TokioJoinSet::detach_all

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

See TokioJoinSet::poll_join_next

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

See TokioJoinSet::poll_join_next_with_id

Trait Implementations

impl<T> 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

Default concurrency is 8