Struct ProcCtx 

pub struct ProcCtx(/* private fields */);

Object that denotes ownership of a ProcSem semaphore.

When the process is complete this object must be dropped so the semaphore can be acquired again.

Implementations

impl ProcCtx

pub fn action(&self, text: &str)

Provide a textual describe the current stage of the process.

pub fn progress(&self, percent: Option<u8>)

Set the progress (in percent).

pub fn end(&self, text: &str)

Set an end-state message.

The purpose of the “end message” is to be able to leave a final “result” message that can be read by the ProcSem.

Calling this function will not cause the StateReporter::end() to be called. However, if an end message has been set, a clone if it will be passed to the StateReporter::end() callback.

The message will be stored in the internal ProcSem storage and can be retrieved using ProcSem::endmsg().

Trait Implementations

impl Drop for ProcCtx

fn drop(&mut self)

Executes the destructor for this type.