Struct TaskHandle 

pub struct TaskHandle { /* private fields */ }

A task being worked on in the background: keep it (it’s Clone and Send), report progress, and finish it. Updates after the task finished (or was canceled) are ignored.

Implementations

impl TaskHandle

pub fn id(&self) -> &str

pub fn working(&self, note: Option<&str>)

Working, with an optional progress note to the client.

pub fn artifact(&self, artifact: Artifact)

Add an output; subscribers get it at once.

pub fn complete(&self)

Done.

pub fn complete_with(&self, message: Message)

Done with a closing message.

pub fn fail(&self, reason: &str)

Failed, saying why.

pub fn input_required(&self, question: &str)

Waiting for the client to answer question (its next message carries this task’s id).

pub fn is_canceled(&self) -> bool

The client canceled the task: stop working on it.

pub fn snapshot(&self) -> Option<Task>

The task as it is now.

Trait Implementations

impl Clone for TaskHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.