Skip to main content

TaskRegistry

Struct TaskRegistry 

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

A clone-safe registry of spawned tasks.

TaskRegistry: Clone + Send + Sync. Cloning is cheap (Arc bump) and all clones share the same underlying task list.

Implementations§

Source§

impl TaskRegistry

Source

pub fn new(shutdown: ShutdownToken) -> Self

Construct an empty registry linked to the given shutdown token.

Source

pub fn spawn<F>( &self, name: &'static str, kind: TaskKind, fut: F, ) -> AbortHandle
where F: Future<Output = Result<()>> + Send + 'static,

Spawn a tracked task.

The closure receives no arguments — if it needs the shutdown token or a sub-registry, capture them via move. Use shutdown to obtain a clone of the token.

Returns an AbortHandle so the caller can force-abort the task if needed (e.g., a per-peer handler when the peer disconnects). The real JoinHandle is held by the registry and is awaited in join_all at shutdown. Callers that want to wait for a single task to complete must await by their own means (a tokio::sync::oneshot or similar inside fut) — the registry is optimised for the shutdown-join case, not per-task completion.

Source

pub fn shutdown(&self) -> &ShutdownToken

Borrow the shutdown token this registry is linked to.

Source

pub async fn join_all(&self, deadline: Duration) -> Result<()>

Await all tracked tasks up to deadline; abort laggards.

Returns Ok(()) if every task exited inside the deadline. Returns ServiceError::ShutdownDeadlineExceeded otherwise, with the count of aborted tasks.

Source

pub fn snapshot(&self) -> Vec<TaskSummary>

Snapshot of currently-tracked tasks (live only; completed tasks are not garbage-collected until join_all).

Source

pub fn len(&self) -> usize

Current live-task count.

Source

pub fn is_empty(&self) -> bool

Whether no tasks are currently registered.

Trait Implementations§

Source§

impl Clone for TaskRegistry

Source§

fn clone(&self) -> TaskRegistry

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. 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 = Infallible

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

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

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