TokioTask

Struct TokioTask 

Source
pub struct TokioTask<T> { /* private fields */ }
Available on crate feature tokio only.
Expand description

Task wrapper for Tokio’s JoinHandle that implements the Task trait.

This provides panic safety and proper error handling for tasks spawned with Tokio’s spawn function.

Trait Implementations§

Source§

impl<T> Debug for TokioTask<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Send + 'static> Future for TokioTask<T>

Source§

type Output = T

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
Source§

impl<T: Send + 'static> Task<T> for TokioTask<T>

Source§

fn poll_result( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<T, Box<dyn Any + Send>>>

Poll the task for completion, returning a Result that can contain errors. Read more
Source§

fn poll_cancel(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<()>

Poll for task cancellation. Read more
Source§

fn result(self) -> impl Future<Output = Result<T, Box<dyn Any + Send>>>
where Self: Sized,

Get the result of the task, including any errors that occurred. Read more
Source§

fn detach(self)
where Self: Sized,

Detach the task, allowing it to run in the background without being awaited. Read more
Source§

fn cancel(self) -> impl Future<Output = ()>
where Self: Sized,

Cancel the task. Read more

Auto Trait Implementations§

§

impl<T> Freeze for TokioTask<T>

§

impl<T> RefUnwindSafe for TokioTask<T>

§

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

§

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

§

impl<T> Unpin for TokioTask<T>

§

impl<T> UnwindSafe for TokioTask<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<F> FutureExt for F
where F: Future + ?Sized,

Source§

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>
where Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.
Source§

fn or<F>(self, other: F) -> Or<Self, F>
where Self: Sized, F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. 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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. 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<F, T, E> TryFuture for F
where F: Future<Output = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>, ) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more
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.