Skip to main content

Task

Struct Task 

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

Observable state of a background operation: a Signal holding a TaskState, plus a generation counter that keeps stale workers from overwriting newer results.

start moves to Loading and returns a TaskHandle for the worker; refresh does the same but keeps the last result visible. Starting again, reset, or setting a result directly retires every earlier handle, whose later reports are ignored.

For async work, TaskHandle::run wraps a future that you spawn on any executor; dropping that future cancels the run.

ⓘ
let thumbnails: Task<Arc<Vec<Image>>> = Task::named("thumbnails");
let handle = thumbnails.start();
std::thread::spawn(move || {
    for (index, path) in paths.iter().enumerate() {
        handle.set_progress(index as f32 / paths.len() as f32);
        // ...
    }
    handle.complete(load_all(&paths).map(Arc::new));
});

Writes need no Clone or PartialEq on T or E. Observers run on the reporting thread, as with any Signal. Wrap large results in Arc so state stays cheap, or read with with.

Implementations§

Source§

impl<T, E> Task<T, E>

Source

pub fn new() -> Task<T, E>

Source

pub fn named(name: impl Into<Arc<str>>) -> Task<T, E>

Source

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

Enter Loading with indeterminate progress and return the handle the worker reports through. Retires earlier handles and drops any result.

Source

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

Like start, but keep the current result as Loading { previous } so the UI can show it until the new one lands. Cancelling the run restores it as Ready.

Source

pub fn reset(&self) -> bool

Return to Idle, retiring every outstanding handle.

Source

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

Store a result directly, retiring every outstanding handle.

Source

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

Store a failure directly, retiring every outstanding handle.

Source

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

Source

pub fn state(&self) -> TaskState<T, E>
where T: Clone, E: Clone,

Source

pub fn with<R>(&self, read: impl FnOnce(&TaskState<T, E>) -> R) -> R

Read the state by reference without cloning a result.

Source

pub fn is_loading(&self) -> bool

Source

pub fn progress(&self) -> Option<f32>

Source

pub fn signal(&self) -> &Signal<TaskState<T, E>>

The underlying signal, for APIs that take a Signal.

Source

pub fn source_id(&self) -> SourceId

Source

pub fn version(&self) -> u64

Source

pub fn subscribe(&self, observer: Observer) -> Subscription

Source

pub fn changed(&self) -> Changed ⓘ

A future that resolves at the next state change.

Source

pub fn select<U>( &self, select: impl Fn(&TaskState<T, E>) -> U + Send + Sync + 'static, ) -> Selector<Signal<TaskState<T, E>>, TaskState<T, E>, U>
where T: Clone + Send + Sync + 'static, E: Clone + Send + Sync + 'static, U: Clone + PartialEq + Send + Sync + 'static,

Source

pub fn select_named<U>( &self, name: impl Into<Arc<str>>, select: impl Fn(&TaskState<T, E>) -> U + Send + Sync + 'static, ) -> Selector<Signal<TaskState<T, E>>, TaskState<T, E>, U>
where T: Clone + Send + Sync + 'static, E: Clone + Send + Sync + 'static, U: Clone + PartialEq + Send + Sync + 'static,

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Task<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 Task<T, E>
where T: Debug, E: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, E> Default for Task<T, E>

Source§

fn default() -> Task<T, E>

Returns the “default value” for a type. Read more
Source§

impl<T, E> Observable<TaskState<T, E>> for Task<T, E>
where T: Clone + 'static, E: Clone + 'static,

Source§

fn source_id(&self) -> SourceId

Source§

fn source_name(&self) -> Arc<str> ⓘ

Source§

fn get(&self) -> TaskState<T, E>

Source§

fn read(&self, reader: &mut dyn FnMut(&TaskState<T, E>))

Call reader once with a borrow of the current value. Read more
Source§

fn value_version(&self) -> Option<u64>

A counter identifying the current value, or None if unknown. Read more
Source§

fn subscribe(&self, observer: Observer) -> Subscription

Source§

fn changed(&self) -> Changed ⓘ
where Self: Sized,

A future that resolves with the next change notification after this call. It subscribes immediately, so a change made before the first poll is not missed. It needs no particular executor.

Auto Trait Implementations§

§

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

§

impl<T, E> Freeze for Task<T, E>
where Signal<TaskState<T, E>>: Freeze,

§

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

§

impl<T, E> RefUnwindSafe for Task<T, E>

§

impl<T, E> Send for Task<T, E>
where Signal<TaskState<T, E>>: Send,

§

impl<T, E> Sync for Task<T, E>
where Signal<TaskState<T, E>>: Sync,

§

impl<T, E> Unpin for Task<T, E>
where Signal<TaskState<T, E>>: Unpin,

§

impl<T, E> UnsafeUnpin for Task<T, E>

§

impl<T, E> UnwindSafe for Task<T, E>
where Signal<TaskState<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