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.

pub fn recv<T>(&self, rx: &Receiver<T>) -> Option<T>

Waits for the next item from rx, the receiving end of a channel another thread feeds, such as a connection handing over what it read. Returns None when the task is cancelled (which wins over an item already waiting) or when every sender is gone and nothing is left. A cancel reaches a waiting task within 50 ms: a standard channel wakes only for its senders, so the wait looks at the cancel in slices.

In a Harness a task waiting here rests like one asleep, so no step of the harness waits for it. An item sent from the test wakes it on its own thread; the harness applies what the task then sends at a later step, such as advance.

pub fn recv_timeout<T>( &self, rx: &Receiver<T>, timeout: Duration, ) -> Result<T, RecvWait>

Like TaskCx::recv, giving up after timeout, and telling why no item came. In a Harness the timeout runs on the fake clock, like TaskCx::sleep.

Errors

RecvWait::Timeout when timeout passed without an item, RecvWait::Cancelled when the task was cancelled and RecvWait::Closed when every sender is gone and nothing is left to receive.