Struct JoinMapBuilder

pub struct JoinMapBuilder<'a, K, V, S> { /* private fields */ }

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

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

Implementations

impl<'a, K, V, S> Builder<'a, K, V, S>

where K: Hash + Eq, V: 'static, S: BuildHasher,

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

Assigns a name to the task which will be spawned.

pub fn spawn<F>(self, key: K, task: F) -> Result<()>

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

Spawn the provided task with this builder’s settings and store it in this JoinMap with the provided key.

If a task previously existed in the JoinMap for this key, that task will be cancelled and replaced with the new one. The previous task will be removed from the JoinMap; a subsequent call to join_next will not return a cancelled JoinError for that task.

Panics

This method panics if called outside of a Tokio runtime.

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

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

Spawn the provided task on the provided runtime and store it in this JoinMap with the provided key.

If a task previously existed in the JoinMap for this key, that task will be cancelled and replaced with the new one. The previous task will be removed from the JoinMap; a subsequent call to join_next will not return a cancelled JoinError for that task.

pub fn spawn_blocking<F>(&mut self, key: K, f: F) -> Result<()>

where F: FnOnce() -> V + Send + 'static, V: Send,

Spawn the blocking code on the blocking threadpool and store it in this JoinMap with the provided key.

If a task previously existed in the JoinMap for this key, that task will be cancelled and replaced with the new one. The previous task will be removed from the JoinMap; a subsequent call to join_next will not return a cancelled JoinError for that task.

Note that blocking tasks cannot be cancelled after execution starts. Replaced blocking tasks will still run to completion if the task has begun to execute when it is replaced. A blocking task which is replaced before it has been scheduled on a blocking worker thread will be cancelled.

Panics

This method panics if called outside of a Tokio runtime.

pub fn spawn_blocking_on<F>( &mut self, key: K, f: F, handle: &Handle, ) -> Result<()>

where F: FnOnce() -> V + Send + 'static, V: Send,

Spawn the blocking code on the blocking threadpool of the provided runtime and store it in this JoinMap with the provided key.

If a task previously existed in the JoinMap for this key, that task will be cancelled and replaced with the new one. The previous task will be removed from the JoinMap; a subsequent call to join_next will not return a cancelled JoinError for that task.

Note that blocking tasks cannot be cancelled after execution starts. Replaced blocking tasks will still run to completion if the task has begun to execute when it is replaced. A blocking task which is replaced before it has been scheduled on a blocking worker thread will be cancelled.

pub fn spawn_local<F>(&mut self, key: K, task: F) -> Result<()>

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

Spawn the provided task on the current LocalSet and store it in this JoinMap with the provided key.

If a task previously existed in the JoinMap for this key, that task will be cancelled and replaced with the new one. The previous task will be removed from the JoinMap; a subsequent call to join_next will not return a cancelled JoinError for that task.

Panics

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

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

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

Spawn the provided task on the provided LocalSet and store it in this JoinMap with the provided key.

If a task previously existed in the JoinMap for this key, that task will be cancelled and replaced with the new one. The previous task will be removed from the JoinMap; a subsequent call to join_next will not return a cancelled JoinError for that task.

Trait Implementations

impl<'a, K: Debug, V, S> Debug for Builder<'a, K, V, S>

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

Formats the value using the given formatter.