pub struct Builder<'a, T> { /* private fields */ }
tokio_unstable
and crate feature tracing
only.Expand description
A variant of task::Builder
that spawns tasks on a JoinSet
rather
than on the current default runtime.
Implementations
sourceimpl<'a, T: 'static> Builder<'a, T>
impl<'a, T: 'static> Builder<'a, T>
sourcepub fn spawn<F>(self, future: F) -> AbortHandle where
F: Future<Output = T>,
F: Send + 'static,
T: Send,
pub fn spawn<F>(self, future: F) -> AbortHandle where
F: Future<Output = T>,
F: 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.
sourcepub fn spawn_on<F>(self, future: F, handle: &Handle) -> AbortHandle where
F: Future<Output = T>,
F: Send + 'static,
T: Send,
pub fn spawn_on<F>(self, future: F, handle: &Handle) -> AbortHandle where
F: Future<Output = T>,
F: 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.
sourcepub fn spawn_local<F>(self, future: F) -> AbortHandle where
F: Future<Output = T>,
F: 'static,
pub fn spawn_local<F>(self, future: F) -> AbortHandle where
F: Future<Output = T>,
F: '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
.
sourcepub fn spawn_local_on<F>(self, future: F, local_set: &LocalSet) -> AbortHandle where
F: Future<Output = T>,
F: 'static,
pub fn spawn_local_on<F>(self, future: F, local_set: &LocalSet) -> AbortHandle where
F: Future<Output = T>,
F: '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
Auto Trait Implementations
impl<'a, T> !RefUnwindSafe 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> !UnwindSafe for Builder<'a, T>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more