Struct Task 

pub struct Task<Msg> { /* private fields */ }

Work to run in the background with progress, cancellation and an outcome.

use std::time::Duration;
use qframe::runtime::{Command, Task, TaskEvent};

enum Msg {
    Task(TaskEvent),
    Built(String),
}

let task = Task::new("Build image", |cx| {
    for step in 0..4 {
        if !cx.sleep(Duration::from_millis(300)) {
            return Err("stopped".into());
        }
        cx.progress((step + 1) as f32 / 4.0);
    }
    Ok(Msg::Built("sha256:4f2a".into()))
})
.on_event(Msg::Task);
let id = task.id(); // keep it to cancel the task later
let command: Command<Msg> = Command::task(task);

Implementations

impl<Msg: Send + 'static> Task<Msg>

pub fn new( label: impl Into<String>, work: impl FnOnce(&TaskCx<Msg>) -> Result<Msg, String> + Send + 'static, ) -> Self

A task labelled label running work. Ok delivers its message; Err fails the task with a reason.

pub fn on_event( self, message: impl Fn(TaskEvent) -> Msg + Send + Sync + 'static, ) -> Self

Turns start, progress and the outcome into messages, e.g. to update a Tasks model.

pub fn id(&self) -> TaskId

The task’s id, known before it starts.

pub fn label(&self) -> &str

The task’s label.