Skip to main content

TaskHandle

Struct TaskHandle 

Source
pub struct TaskHandle<T, E = String> { /* private fields */ }
Expand description

A worker’s reporting channel for one run of a Task.

Every report is ignored once the run is retired: after the task is started again, reset, or completed or cancelled by this or another handle. Dropping a handle without completing leaves the task Loading; call cancel to abandon a run.

Implementations§

Source§

impl<T, E> TaskHandle<T, E>

Source

pub fn is_current(&self) -> bool

Whether this run is still the task’s current one. A worker may poll this to stop early after being superseded.

Source

pub fn set_progress(&self, progress: f32) -> bool

Report determinate progress, clamped to 0..=1. Repeating the current value does not notify. NaN reports indeterminate progress.

Source

pub fn cancel(self) -> bool

Abandon the run: back to Idle, or to the previous result after a Task::refresh. Ignored if the run was already retired.

Source

pub fn run<Work>( self, work: Work, ) -> impl Future<Output = bool> + use<T, E, Work>
where Work: Future<Output = Result<T, E>>,

Wrap work so its output completes this run. Spawn the returned future on any executor; it resolves to whether the result was stored. Dropping it before work finishes cancels the run.

ⓘ
let handle = results.refresh();
let progress = handle.clone();
wasm_bindgen_futures::spawn_local(async move {
    handle
        .run(async move {
            progress.set_progress(0.5);
            fetch_results().await
        })
        .await;
});
Source

pub fn finish(self, value: T) -> bool

Source

pub fn fail(self, error: E) -> bool

Source

pub fn complete(self, result: Result<T, E>) -> bool

Store the run’s result unless the run was retired. Returns whether it was stored.

Source

pub fn task(&self) -> &Task<T, E>

Trait Implementations§

Source§

impl<T, E> Clone for TaskHandle<T, E>

Source§

fn clone(&self) -> TaskHandle<T, E>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T, E> Debug for TaskHandle<T, E>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T, E> Forget for TaskHandle<T, E>

§

impl<T, E> Freeze for TaskHandle<T, E>
where Task<T, E>: Freeze,

§

impl<T, E> Move for TaskHandle<T, E>

§

impl<T, E> RefUnwindSafe for TaskHandle<T, E>
where Task<T, E>: RefUnwindSafe,

§

impl<T, E> Send for TaskHandle<T, E>
where Task<T, E>: Send,

§

impl<T, E> Sync for TaskHandle<T, E>
where Task<T, E>: Sync,

§

impl<T, E> Unpin for TaskHandle<T, E>
where Task<T, E>: Unpin,

§

impl<T, E> UnsafeUnpin for TaskHandle<T, E>
where Task<T, E>: UnsafeUnpin,

§

impl<T, E> UnwindSafe for TaskHandle<T, E>
where Task<T, E>: UnwindSafe,

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ThemeExtension for T
where T: Any + Send + Sync,

Source§

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

Source§

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)

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more