Struct TaskBuilder

pub struct TaskBuilder { /* private fields */ }

Builder to create a new task

Implementations

impl TaskBuilder

pub fn new(name: impl Into<Cow<'static, str>>) -> Self

Start the construction of a new task with the given name

pub fn id(&self) -> usize

Unique id of the task we are creating

pub fn set_run_token(self, run_token: RunToken) -> Self

Set the run_token for the task. It is sometimes nessesary to know the run_token of a task before it is created

pub fn critical(self) -> Self

If the task fails the whole application should be stopped

pub fn main(self) -> Self

If the task stops, the whole application should be stopped

pub fn abort(self) -> Self

Cancel the task by dropping the future, instead of only setting the cancel token

pub fn no_shutdown(self) -> Self

Keep the task running on shutdown

pub fn shutdown_order(self, shutdown_order: i32) -> Self

Tasks with a lower shutdown order are stopped earlier on shutdown

pub fn create<T: 'static + Send + Sync, E: Debug + Sync + Send + 'static, Fu: Future<Output = Result<T, E>> + Send + 'static, F: FnOnce(RunToken) -> Fu>( self, fun: F, ) -> Arc<Task<T, E>>

Create the new task