Struct TaskCx 

pub struct TaskCx<Msg> { /* private fields */ }

What running work can do: report progress, send messages, notice cancellation and sleep.

Implementations

impl<Msg: Send + 'static> TaskCx<Msg>

pub fn id(&self) -> TaskId

The running task.

pub fn progress(&self, fraction: f32)

Reports the completed share, from 0 to 1.

pub fn note(&self, note: impl Into<String>)

Describes the current step, e.g. “pushing layers”.

pub fn send(&self, message: Msg)

Delivers message to the application while the work goes on, e.g. a log line.

pub fn is_cancelled(&self) -> bool

Whether the application asked this task to stop. Long work should check it and return.

pub fn sleep(&self, duration: Duration) -> bool

Waits duration, waking early when the task is cancelled. Returns false when it was cancelled. In tests the harness’s fake clock decides when the sleep ends.