Struct Builder

pub struct Builder<'a, T> { /* 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 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_blocking<F>(self, f: F) -> Result<AbortHandle>
where F: FnOnce() -> T + Send + 'static, T: Send,

Spawn the blocking code on the blocking threadpool 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 called outside of a Tokio runtime.

pub fn spawn_blocking_on<F>(self, f: F, handle: &Handle) -> Result<AbortHandle>
where F: FnOnce() -> T + Send + 'static, T: Send,

Spawn the blocking code on the blocking threadpool of 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 or LocalRuntime 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 or LocalRuntime.

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. Read more

Auto Trait Implementations

impl<'a, T> !RefUnwindSafe for Builder<'a, T>

impl<'a, T> !UnwindSafe for Builder<'a, T>

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

impl<'a, T> Send for Builder<'a, T>
where T: Send,

impl<'a, T> Sync for Builder<'a, T>
where T: Send,

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

MIT License
Copyright © Tokio Contributors
https://docs.rs/tokio/1.53.1/tokio/task/join_set/struct.Builder.html

спецификации, руководства, описания, API

free hit counter