Skip to main content

TaskHandle

Struct TaskHandle 

Source
pub struct TaskHandle<O: Clone + Send + 'static> {
    pub id: Uuid,
    /* private fields */
}
Expand description

Handle returned to a caller after submitting a task to the pool.

  • result() awaits the final task output.
  • events() returns a broadcast receiver for intermediate Events.
  • cancel() requests cooperative cancellation.

Fields§

§id: Uuid

Unique identifier assigned to this task by the pool.

Implementations§

Source§

impl<O: Clone + Send + 'static> TaskHandle<O>

Source

pub async fn result(self) -> AppResult<O>

Await the final result of the task.

Source

pub fn events(&self) -> Receiver<Event<O>>

Get a new broadcast receiver for intermediate events.

Source

pub fn cancel(&self)

Signal the task to cancel.

Source

pub fn cancel_token(&self) -> CancellationToken

Clone the cancellation token so it can be stored separately (e.g., for cancelling after the handle is consumed by result()).

Auto Trait Implementations§

§

impl<O> !RefUnwindSafe for TaskHandle<O>

§

impl<O> !UnwindSafe for TaskHandle<O>

§

impl<O> Freeze for TaskHandle<O>

§

impl<O> Send for TaskHandle<O>

§

impl<O> Sync for TaskHandle<O>

§

impl<O> Unpin for TaskHandle<O>

§

impl<O> UnsafeUnpin for TaskHandle<O>

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

Source§

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

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

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, 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> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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