Skip to main content

TaskGroup

Struct TaskGroup 

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

A set of SpawnedTasks shut down together.

Each task owns its own cancellation token; shutdown cancels all of them, then drains each within a per-task grace period, aborting stragglers so a single wedged task cannot stall teardown.

Implementations§

Source§

impl TaskGroup

Source

pub const fn new() -> Self

Create an empty group.

Source

pub fn push(&mut self, task: SpawnedTask)

Add a task to the group.

Source

pub const fn len(&self) -> usize

Number of tasks currently owned.

Source

pub const fn is_empty(&self) -> bool

Whether the group owns no tasks.

Source

pub fn cancel_all(&self)

Cancel every task without waiting.

Source

pub async fn shutdown(&mut self, grace: Duration)

Cancel and drain every task, each within grace, aborting stragglers.

Trait Implementations§

Source§

impl Debug for TaskGroup

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TaskGroup

Source§

fn default() -> TaskGroup

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.