Skip to main content

TaskScope

Struct TaskScope 

Source
pub struct TaskScope {
    pub name: Rc<str>,
    pub tasks: RefCell<Vec<Rc<Task>>>,
    /* private fields */
}
Expand description

The task scope scope name { ... } binds.

The scope owns every task spawned into it, which is what lets leaving the scope wait for or cancel its children.

Fields§

§name: Rc<str>

The name the scope is bound to, for diagnostics.

§tasks: RefCell<Vec<Rc<Task>>>

Child tasks in spawn order.

Implementations§

Source§

impl TaskScope

Source

pub fn new(name: Rc<str>) -> Rc<TaskScope>

Source

pub fn adopt(&self, task: Rc<Task>) -> Rc<Task>

Adopts a task that is already running, and returns its handle.

Source

pub fn next_position(&self) -> usize

The position the next task spawned into this scope will have.

Source

pub fn task_at(&self, index: usize) -> Option<Rc<Task>>

The task at index in spawn order, if the scope has one.

Source

pub fn cancel_running(&self)

Asks every child that is still running to stop.

Source

pub fn is_closed(&self) -> bool

Source

pub fn close(&self)

Trait Implementations§

Source§

impl Debug for TaskScope

Source§

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

Formats the value using the given formatter. 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.