Struct flowync::FlowerHandle

source · [−]

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

Expand description

A handle for the Flower

Implementations

source

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

source

pub fn id(&self) -> usize

Get ID of the flower.

source

pub fn activate(&self)

Activate current flower

source

pub fn is_active(&self) -> bool

Check if the current flower is active

source

pub fn should_cancel(&self) -> bool

Check if the current flower should be canceled

source

pub fn send(&self, _value: SOME)

Send current progress value

source

pub async fn send_async(&self, _value: SOME)

Send current progress value asynchronously.

source

pub fn ok(&self, _value: OK)

Contains the success value for the result.

source

pub fn err(&self, _value: String)

Contains the error value for the result.

Trait Implementations

source

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

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations

impl<SOME, OK> !RefUnwindSafe for FlowerHandle<SOME, OK>

impl<SOME, OK> Send for FlowerHandle<SOME, OK>

impl<SOME, OK> Sync for FlowerHandle<SOME, OK>

impl<SOME, OK> Unpin for FlowerHandle<SOME, OK>

impl<SOME, OK> !UnwindSafe for FlowerHandle<SOME, OK>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct flowync::FlowerHandle

Implementations

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

pub fn id(&self) -> usize

pub fn activate(&self)

pub fn is_active(&self) -> bool

pub fn should_cancel(&self) -> bool

pub fn send(&self, _value: SOME)

pub async fn send_async(&self, _value: SOME)

pub fn ok(&self, _value: OK)

pub fn err(&self, _value: String)

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

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

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

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

fn drop(&mut self)

Auto Trait Implementations

impl<SOME, OK> !RefUnwindSafe for FlowerHandle<SOME, OK>

impl<SOME, OK> Send for FlowerHandle<SOME, OK>

impl<SOME, OK> Sync for FlowerHandle<SOME, OK>

impl<SOME, OK> Unpin for FlowerHandle<SOME, OK>

impl<SOME, OK> !UnwindSafe for FlowerHandle<SOME, OK>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,