Struct asynchron::Futurized

pub struct Futurized<C, T> { /* fields omitted */ }

Futurized task.

Implementations

impl<C, T> Futurized<C, T> where
    C: Clone + Send + 'static,
    T: Clone + Send + 'static, 

pub fn stack_size(&self, size: usize)

Set stack size (in bytes) of the thread for spawning Futurized task,

Rust’s official doc: https://doc.rust-lang.org/std/thread/struct.Builder.html#method.stack_size

if the given value is zero or default, it will use Rust’s standard stack size.

pub fn try_do(&self)

Try (it won’t block the current thread) to do the task now,

and then try to resolve later.

pub fn suspend(&self)

Send signal to the inner task handle that the task should be suspended.

this won’t do anything if not explicitly configured inside the task.

pub fn resume(&self)

Resume the suspended task.

pub fn is_suspended(&self) -> bool

Check if progress of the task is suspended.

pub fn is_resumed(&self) -> bool

Check if progress of the task is resumed.

pub fn cancel(&self)

Send signal to the inner task handle that the task should be canceled.

this won’t do anything if not explicitly configured inside the task.

pub fn is_canceled(&self) -> bool

Check if progress of the task is canceled.

pub fn handle(&self) -> TaskHandle<C, T>

Get the task handle, if only intended to try to do,

check progress, cancel, suspend or resume the task, from inside moving closures,

or from other threads to avoid (channel) synchronous Sender data races.

pub fn rt_handle(&self) -> RuntimeHandle

Get the runtime handle, if only intended to check progress, cancel,

suspend or resume the task from inside moving closures or from other threads.

use this to avoid unnecessary cloning unused task values.

pub fn id(&self) -> usize

Get the id of the task

pub fn try_resolve<F: FnOnce(Progress<'_, C, T>, bool)>(&self, f: F)

Try resolve the progress of the task,

WARNING! to prevent from data races this fn should be called once at a time.

pub fn is_in_progress(&self) -> bool

Check if the task is in progress.

pub fn is_done(&self) -> bool

Check if the task isn’t in progress anymore (done).

Trait Implementations

impl<C, T> Clone for Futurized<C, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.