egui_task_manager 0.1.1

Manage asynchronous easily
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use std::{future::Future, pin::Pin};

use crate::task::{AnyTask, TaskData};

mod caller;
pub mod executors;
mod handler;
mod progress;

pub use caller::Caller;
pub use handler::*;
pub use progress::*;

type PinnedFuture<T> = Pin<Box<dyn Future<Output = T> + Send + 'static>>;

/// Marker to determine if the task is finished.
pub(super) struct Finished;

const _: Option<Box<dyn TaskExecutor>> = None;

/// A trait that determines task's execution.
///
/// For examples see implementation of the [`Linear`](executors::Linear) and [`Parallel`](executors::Parallel)
/// executors.
pub trait TaskExecutor {
    /// Push a new task to the executor.
    fn push(&mut self, task: AnyTask);

    /// Poll the executor to get it's state.
    ///
    /// - `tasks` is a slice of the currently running tasks.
    ///
    /// See [`ExecutionPoll`] for more information. And [`executors`](executors) module for examples.
    fn poll(&mut self, tasks: &[TaskData]) -> ExecutionPoll;
}

/// Indicates whether a task available to be executed or not.
pub enum ExecutionPoll {
    /// There's a task ready to be executed. It will cause [`TasksExecutor::execute`] to be called.
    Ready(AnyTask),
    /// You're not executing a new task. Nothing will happen.
    Pending,
}