Struct TaskGroup

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

A TaskGroup is used to spawn a collection of tasks. The collection has two properties:

  • if any task returns an error or panicks, all tasks are terminated.
  • if the TaskManager returned by TaskGroup::new is dropped, all tasks are terminated.

Implementations§

Source§

impl<E: Send + 'static> TaskGroup<E>

Source

pub fn new() -> (Self, TaskManager<E>)

Source

pub fn spawn( &self, name: impl AsRef<str>, f: impl Future<Output = Result<(), E>> + Send + 'static, ) -> impl Future<Output = Result<(), SpawnError>> + '_

Source

pub fn spawn_on( &self, name: impl AsRef<str>, runtime: Handle, f: impl Future<Output = Result<(), E>> + Send + 'static, ) -> impl Future<Output = Result<(), SpawnError>> + '_

Source

pub fn spawn_local( &self, name: impl AsRef<str>, f: impl Future<Output = Result<(), E>> + 'static, ) -> impl Future<Output = Result<(), SpawnError>> + '_

Source

pub fn is_closed(&self) -> bool

Returns true if the task group has been shut down.

Trait Implementations§

Source§

impl<E> Clone for TaskGroup<E>

Source§

fn clone(&self) -> Self

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§

§

impl<E> Freeze for TaskGroup<E>

§

impl<E> !RefUnwindSafe for TaskGroup<E>

§

impl<E> Send for TaskGroup<E>
where E: Send,

§

impl<E> Sync for TaskGroup<E>
where E: Send,

§

impl<E> Unpin for TaskGroup<E>

§

impl<E> !UnwindSafe for TaskGroup<E>

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