Skip to main content

TaskSpawner

Struct TaskSpawner 

Source
pub struct TaskSpawner { /* private fields */ }
Expand description

Narrow capability for spawning work owned by an existing TaskGroup.

Cloning this value shares lifecycle authority; it cannot create a runtime root, expose a raw Tokio handle, detach work, or outlive owner shutdown.

Implementations§

Source§

impl TaskSpawner

Source

pub fn group_id(&self) -> TaskGroupId

Returns the identity of the owned task group.

Source

pub fn group_name(&self) -> &str

Returns the diagnostic name of the owned task group.

Source

pub fn cancellation_token(&self) -> CancellationToken

Returns a child token cancelled by owner shutdown.

Cancelling the returned token does not cancel the owning task group.

Source

pub fn spawn<F>( &self, name: impl Into<TaskName>, kind: TaskKind, future: F, ) -> RuntimeResult<TaskId>
where F: Future<Output = ()> + Send + 'static,

Registers future as parent-owned work.

The future must be Send and tasks have no ordering guarantee relative to other submissions. Owner shutdown cancels and awaits the registered task according to the parent task group’s deadline.

§Errors

Returns an error when the parent group is shutting down or closed.

Source

pub fn spawn_service<F>( &self, name: impl Into<TaskName>, future: F, ) -> RuntimeResult<TaskId>
where F: Future<Output = ()> + Send + 'static,

Registers a long-lived service future with a custom shutdown protocol.

The future must observe a cancellation token and perform its own ordered cleanup. Use Self::spawn_cancellable_service when owner cancellation may drop the future immediately.

§Errors

Returns an error when the parent group is shutting down or closed.

Source

pub fn spawn_cancellable_service<F>( &self, name: impl Into<TaskName>, future: F, ) -> RuntimeResult<TaskId>
where F: Future<Output = ()> + Send + 'static,

Registers a service that exits when either its future completes or its owner is cancelled.

§Errors

Returns an error when the parent group is shutting down or closed.

Source

pub fn spawn_critical<F>( &self, name: impl Into<TaskName>, kind: TaskKind, failures: CriticalFailureState, future: F, ) -> RuntimeResult<TaskId>
where F: Future<Output = ()> + Send + 'static,

Registers parent-owned work whose panic is recorded as a critical failure.

The failure record stays pending until a handler takes it, so a full notification channel cannot lose the fact that the task failed.

§Errors

Returns an error when the parent group is shutting down or closed.

Source

pub fn spawn_critical_service<F>( &self, name: impl Into<TaskName>, failures: CriticalFailureState, future: F, ) -> RuntimeResult<TaskId>
where F: Future<Output = ()> + Send + 'static,

Registers a critical service that must run until its owner is cancelled.

A panic and a return before owner cancellation are both recorded; owner cancellation is an expected exit and records nothing.

§Errors

Returns an error when the parent group is shutting down or closed.

Trait Implementations§

Source§

impl Clone for TaskSpawner

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TaskSpawner

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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