Struct tokio_task_tracker::TaskWaiter

source ·
pub struct TaskWaiter { /* private fields */ }
Expand description

TaskWaiter is used to wait until all task trackers have been dropped.

Implementations§

source§

impl TaskWaiter

source

pub fn cancel(&self)

Notify all tasks this TaskWaiter is waiting on that they should abort.

source

pub async fn wait_for_shutdown(self, timeout: Duration) -> Result<(), Error>

Wait for the application to be interrupted, and then gracefully shutdown allowing a timeout for all tasks to quit. A second interrupt will cause an immediate shutdown.

On Unix systems, “interrupt” means a SIGINT or SIGTERM. On all other platforms the current implementation uses tokio::signal::ctrl_c() to wait for an interrupt.

source

pub async fn wait_with_timeout(self, timeout: Duration) -> Result<(), Error>

Wait for all tasks to finish. If tasks do not finish before the timeout, Error::Timeout will be returned.

source

pub async fn wait(self)

Wait for all tasks to finish.

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

§

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

§

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.