Struct flowync::FlowerHandle

pub struct FlowerHandle<SOME, OK> where
    SOME: Clone + Send + Sync + 'static,
    OK: Clone + Send + Sync + 'static,  { /* fields omitted */ }

A handle for the Flower

Implementations

impl<SOME, OK> FlowerHandle<SOME, OK> where
    SOME: Clone + Send + Sync + 'static,
    OK: Clone + Send + Sync + 'static, 

pub fn id(&self) -> usize

Get ID of the flower.

pub fn start_flowing(&self)

Call this fn every time at the very begining (runtime) to initialize, otherwise the flower won’t flow.

pub fn pause(&self)

Pause the flower from flowing.

pub fn is_flowing(&self) -> bool

Check if the flower is flowing

pub fn should_cancel(&self) -> bool

Check if the current flower should be canceled

pub fn send_current(&self, _value: SOME)

Send current progress value

pub fn ok(&self, _value: OK)

Contains the success value for the result.

pub fn err(&self, _value: String)

Contains the error value for the result.

Trait Implementations

impl<SOME, OK> Clone for FlowerHandle<SOME, OK> where
    SOME: Clone + Send + Sync + 'static,
    OK: Clone + Send + Sync + 'static, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<SOME, OK> Debug for FlowerHandle<SOME, OK> where
    SOME: Debug + Clone + Send + Sync + 'static,
    OK: Debug + Clone + Send + Sync + 'static, 

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

Formats the value using the given formatter.

impl<SOME, OK> Drop for FlowerHandle<SOME, OK> where
    SOME: Clone + Send + Sync + 'static,
    OK: Clone + Send + Sync + 'static, 

fn drop(&mut self)

Executes the destructor for this type.