Struct Handle

pub struct Handle<S, R>
where
    S: Send,
    R: Send,
{ /* private fields */ }

A handle for the Flower

Implementations

impl<S, R> Handle<S, R>

where S: Send, R: Send,

pub fn id(&self) -> usize

Get ID of the Flower.

pub fn activate(&self)

Activate current Flower

pub fn is_active(&self) -> bool

Check if the current Flower is active

pub fn should_cancel(&self) -> bool

Check if the current Flower should be canceled

pub fn send(&self, s: S)

Send current progress value

pub async fn send_async(&self, s: S)

Send current progress value asynchronously.

pub fn set_result(&self, r: Result<R, Box<dyn Error>>)

Set Result value with verboser error message.

(for more easier to keep in track with the real cause of the error)

pub fn set_result_no_verbose(&self, r: Result<R, Box<dyn Error>>)

Set Result value with no verbose (simpler error message)

pub fn success(&self, r: R)

Set the Ok value of the Result.

pub fn error(&self, e: impl ToString)

Set the Err value of the Result.

pub fn error_verbose(&self, e: Box<dyn Error>)

Set the Err value of the Result with more verboser error message.

Trait Implementations

impl<S, R> Debug for Handle<S, R>

where S: Send + Debug, R: Send + Debug,

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

Formats the value using the given formatter.

impl<S, R> Drop for Handle<S, R>

where S: Send, R: Send,

fn drop(&mut self)

Executes the destructor for this type.