AsyncHandle

Struct AsyncHandle 

Source
pub struct AsyncHandle<T> { /* private fields */ }
Expand description

A handle to a cancellable async operation

AsyncHandle allows you to:

  • Cancel long-running operations cooperatively
  • Check if an operation is still running
  • Wait for completion with .await
  • Abort forcefully if needed

The handle automatically cancels the operation when dropped.

Implementations§

Source§

impl<T> AsyncHandle<T>

Source

pub fn cancel(&self)

Cancel the operation

This sends a cancellation signal to the async task. The task must cooperatively check for cancellation to actually stop.

Source

pub fn is_cancelled(&self) -> bool

Check if the operation is cancelled

Source

pub fn is_running(&self) -> bool

Check if the operation is still running

Source

pub fn is_finished(&self) -> bool

Check if the operation has finished

Source

pub fn abort(&self)

Abort the task immediately

This is more forceful than cancel() - it immediately aborts the task without waiting for cooperative cancellation.

Source

pub fn cancellation_token(&self) -> &CancellationToken

Get the cancellation token for cooperative cancellation

This can be cloned and passed to child tasks for hierarchical cancellation.

Trait Implementations§

Source§

impl<T> Drop for AsyncHandle<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for AsyncHandle<T>

§

impl<T> RefUnwindSafe for AsyncHandle<T>

§

impl<T> Send for AsyncHandle<T>
where T: Send,

§

impl<T> Sync for AsyncHandle<T>
where T: Send,

§

impl<T> Unpin for AsyncHandle<T>

§

impl<T> UnwindSafe for AsyncHandle<T>

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

Source§

fn inspect(self, label: &str) -> Self
where Self: Debug,

Inspect this value with a label
Source§

fn inspect_if(self, condition: bool, label: &str) -> Self
where Self: Debug,

Conditionally inspect this value
Source§

fn inspect_with<F>(self, label: &str, f: F) -> Self
where F: FnOnce(&Self) -> String,

Inspect with a custom formatter
Source§

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Tap into the value for side effects
Source§

fn tap_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&Self),

Conditionally tap into the value
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.
Source§

impl<T> Message for T
where T: Send + 'static,