karyon_core::async_util

Struct TaskGroup

Source
pub struct TaskGroup {
    tasks: Mutex<Vec<TaskHandler>>,
    stop_signal: Arc<CondWait>,
    executor: Executor,
}
Expand description

TaskGroup A group that contains spawned tasks.

§Example


use std::sync::Arc;

use karyon_core::async_util::{TaskGroup, sleep};

async {
    let group = TaskGroup::new();

    group.spawn(sleep(std::time::Duration::MAX), |_| async {});

    group.cancel().await;

};

Fields§

§tasks: Mutex<Vec<TaskHandler>>§stop_signal: Arc<CondWait>§executor: Executor

Implementations§

Source§

impl TaskGroup

Source

pub fn new() -> Self

Creates a new TaskGroup without providing an executor

This will spawn a task onto a global executor (single-threaded by default).

Source

pub fn with_executor(executor: Executor) -> Self

Creates a new TaskGroup by providing an executor

Source

pub fn spawn<T, Fut, CallbackF, CallbackFut>( &self, fut: Fut, callback: CallbackF, )
where T: Send + Sync + 'static, Fut: Future<Output = T> + Send + 'static, CallbackF: FnOnce(TaskResult<T>) -> CallbackFut + Send + 'static, CallbackFut: Future<Output = ()> + Send + 'static,

Spawns a new task and calls the callback after it has completed or been canceled. The callback will have the TaskResult as a parameter, indicating whether the task completed or was canceled.

Source

pub fn is_empty(&self) -> bool

Checks if the TaskGroup is empty.

Source

pub fn len(&self) -> usize

Get the number of the tasks in the group.

Source

pub async fn cancel(&self)

Cancels all tasks in the group.

Trait Implementations§

Source§

impl Default for TaskGroup

Source§

fn default() -> Self

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.

§

impl<T> Instrument for T

§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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