Skip to main content

TaskFuture

Struct TaskFuture 

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

A future that tracks completion of submitted tasks

TaskFuture provides both blocking and non-blocking ways to wait for task completion. Tasks can be checked for completion, waited on indefinitely, or waited on with a timeout.

TaskFuture is cheaply cloneable. However, it captures the thread handle of the thread that created it.

If sharing the future with other threads, is_complete() is safe to call from anywhere.

Important: wait() and wait_timeout() must be called from the same thread that created the TaskFuture. Calling these methods from a different thread will panic in debug builds and may cause the calling thread to hang indefinitely in release builds.

Implementations§

Source§

impl TaskFuture

Source

pub fn is_complete(&self) -> bool

Check if all tasks are complete without blocking

Returns true if all tasks have finished execution. This is a non-blocking operation using an atomic load.

Source

pub fn wait(&self)

Wait for all tasks to complete.

First checks completion with an atomic load; if incomplete, parks the thread.

Warning: This method must be called from the same thread that created this TaskFuture.

Source

pub fn wait_timeout(&self, timeout: Duration) -> bool

Wait for all tasks to complete with a timeout.

First checks completion with an atomic load; if incomplete, parks the thread. Returns true if all tasks completed within the timeout, false if the timeout was reached first.

Warning: This method must be called from the same thread that created this TaskFuture.

Trait Implementations§

Source§

impl Clone for TaskFuture

Source§

fn clone(&self) -> TaskFuture

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. 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> 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.