Struct tokio::task::join_set::Builder

pub struct Builder<'a, T> { /* private fields */ }

Available on tokio_unstable and crate feature tracing and crate feature rt only.

A variant of task::Builder that spawns tasks on a JoinSet rather than on the current default runtime.

Implementations

impl<'a, T: 'static> Builder<'a, T>

pub fn name(self, name: &'a str) -> Self

Assigns a name to the task which will be spawned.

pub fn spawn<F>(self, future: F) -> Result<AbortHandle>

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

Spawn the provided task with this builder’s settings and store it in the JoinSet, returning an AbortHandle that can be used to remotely cancel the task.

Returns

An AbortHandle that can be used to remotely cancel the task.

Panics

This method panics if called outside of a Tokio runtime.

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

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

Spawn the provided task on the provided runtime handle with this builder’s settings, and store it in the JoinSet.

Returns

An AbortHandle that can be used to remotely cancel the task.

pub fn spawn_local<F>(self, future: F) -> Result<AbortHandle>

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

Spawn the provided task on the current LocalSet with this builder’s settings, and store it in the JoinSet.

Returns

An AbortHandle that can be used to remotely cancel the task.

Panics

This method panics if it is called outside of a LocalSet.

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

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

Spawn the provided task on the provided LocalSet with this builder’s settings, and store it in the JoinSet.

Returns

An AbortHandle that can be used to remotely cancel the task.

Trait Implementations

impl<'a, T> Debug for Builder<'a, T>

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

Formats the value using the given formatter.