Skip to main content

TaskMap

Struct TaskMap 

Source
pub struct TaskMap<T> { /* private fields */ }
Expand description

A set of named tasks to run concurrently.

T is the success result type — all tasks in a TaskMap produce the same T. For heterogeneous batches, use tokio::join! directly.

Implementations§

Source§

impl<T> TaskMap<T>

Source

pub fn new() -> Self

Create an empty task map.

Source

pub fn insert<F, Fut, E>(self, name: &'static str, task: F) -> Self
where F: FnOnce(CancellationToken) -> Fut + Send + 'static, Fut: Future<Output = Result<T, E>> + Send + 'static, E: Into<Box<dyn Error + Send + Sync>>, T: Send + 'static,

Insert a named task into the map.

The closure receives the active CancellationToken and must return a future producing Result<T, E> where E can be boxed into a std::error::Error.

§Duplicate names

Backed by BTreeMap::insert — calling insert twice with the same name silently overwrites the earlier task (“last write wins”). If you need duplicate-name detection, check .len() before/after the second insert or use distinct names.

Source

pub fn len(&self) -> usize

Return the number of tasks currently in the map.

Source

pub fn is_empty(&self) -> bool

Return true if no tasks have been inserted.

Trait Implementations§

Source§

impl<T> Default for TaskMap<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for TaskMap<T>

§

impl<T> !Sync for TaskMap<T>

§

impl<T> !UnwindSafe for TaskMap<T>

§

impl<T> Freeze for TaskMap<T>

§

impl<T> Send for TaskMap<T>

§

impl<T> Unpin for TaskMap<T>

§

impl<T> UnsafeUnpin for TaskMap<T>

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> 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, 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