Trait Task

pub trait Task:
    Send
    + Sync
    + Clone {
    type Output: Send + Sync;

    // Required method
    fn run(&self, cancel_tok: &CancellationToken) -> Result<Self::Output, Error>;
}

A cancellable task which is meant to be run in a background thread.

For more information on the Task API, refer to the module documentation.

Required Associated Types

type Output: Send + Sync

Required Methods

fn run(&self, cancel_tok: &CancellationToken) -> Result<Self::Output, Error>

Run this task to completion synchronously, exiting early if the provided CancellationToken is triggered.

You probably shouldn’t call this function directly. Instead prefer higher level abstractions like TaskHandle::spawn() or bindings generated by the export_task!() macro.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors