Struct tokio_tasks::Task

pub struct Task<T: Send + Sync, E: Sync> { /* private fields */ }

A possible running task, with a return value of Result<T, E>

Implementations

impl<T: Send + Sync, E: Send + Sync> Task<T, E>

pub async fn cancel(self: Arc<Self>)

Cancel the task, either by setting the cancel_token or by aborting it. Wait for it to finish Note that this function fill fail t

pub async fn wait(self: Arc<Self>) -> Result<T, WaitError<E>>

Wait for the task to finish.

Trait Implementations

impl<T: Send + Sync + 'static, E: Send + Sync + 'static> TaskBase for Task<T, E>

fn shutdown_order(&self) -> i32

Return the shutdown order of this task as defined by the TaskBuilder

fn name(&self) -> &str

Return the name of this task as defined by the TaskBuilder

fn id(&self) -> usize

Return the unique id of this task

fn cancel(self: Arc<Self>) -> BoxFuture<'static, ()>

Cantle the task, return futer that returns when the task is done

fn main(&self) -> bool

If true the application will shut down with an error if this task returns

fn abort(&self) -> bool

If this is true the task will be cancled by dropping the future instead of signaling the run token

fn critical(&self) -> bool

If true the application will shut down with an error if this task returns with an error

fn start_time(&self) -> f64

Unixtimestamp of when the task started

fn run_token(&self) -> &RunToken

Get the run token associated with the task

fn no_shutdown(&self) -> bool

Do not stop task on shutdown