minitimer 0.1.7

A mini timer of delayed tasks. Only asynchronous tasks are possible on tokio runtime, and dynamic add/cancel/remove is supported.
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

#![allow(clippy::module_inception)]
pub mod frequency;
pub mod runner;
pub(crate) mod task;

/// Unique identifier for a task.
pub type TaskId = u64;

/// Unique identifier for a task execution record.
pub type RecordId = i64;

/// Represents the current state of a task.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TaskState {
    /// Task is scheduled but not yet executing.
    Pending,
    /// Task is currently executing.
    Running,
    /// Task has completed execution.
    Completed,
    /// Task has been removed from the scheduler.
    Removed,
}

/// Record of a task execution instance.
#[derive(Debug, Clone)]
pub struct RunningRecord {
    /// The unique identifier of the task.
    pub task_id: TaskId,
    /// The unique identifier of this execution record.
    pub record_id: RecordId,
    /// The current state of this execution.
    pub state: TaskState,
}

pub use frequency::FrequencySeconds;
pub use runner::TaskRunner;

pub use task::{Task, TaskBuilder};