busybeaver 0.2.0

This Beaver executes your Futures independently of your worker threads, supporting scheduling strategies such as time intervals, execution count intervals, specific-time polling policies, and more.
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use crate::fixed_count_task::FixedCountTask;
use crate::periodic_task::PeriodicTask;
use crate::range_interval_task::RangeIntervalTask;
use crate::time_interval_task::TimeIntervalTask;
use std::sync::atomic::Ordering;
use uuid::Uuid;

/// Unique task identifier (16-byte UUID, no heap allocation).
#[derive(Clone, Copy, Debug, Hash, Eq, PartialEq)]
pub struct TaskId(Uuid);

impl TaskId {
    #[inline]
    pub(crate) fn new() -> Self {
        TaskId(Uuid::new_v4())
    }

    /// Returns the underlying UUID, e.g. for logging or persistence.
    #[inline]
    pub fn as_uuid(&self) -> Uuid {
        self.0
    }
}

impl Default for TaskId {
    fn default() -> Self {
        Self::new()
    }
}

impl std::fmt::Display for TaskId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

pub enum Task {
    TimeInterval(TimeIntervalTask),
    RangeInterval(RangeIntervalTask),
    FixedCount(FixedCountTask),
    Periodic(PeriodicTask),
}

impl Task {
    pub fn id(&self) -> &TaskId {
        match self {
            Task::TimeInterval(s) => &s.id,
            Task::RangeInterval(s) => &s.id,
            Task::FixedCount(s) => &s.id,
            Task::Periodic(s) => &s.id,
        }
    }
    #[inline]
    pub fn tag(&self) -> &str {
        match self {
            Task::TimeInterval(s) => s.tag.as_deref().unwrap_or(""),
            Task::RangeInterval(s) => s.tag.as_deref().unwrap_or(""),
            Task::FixedCount(s) => s.tag.as_deref().unwrap_or(""),
            Task::Periodic(s) => s.tag.as_deref().unwrap_or(""),
        }
    }
    #[inline]
    pub fn interrupted(&self) -> bool {
        match self {
            Task::TimeInterval(s) => s.interrupted.load(Ordering::Relaxed),
            Task::RangeInterval(s) => s.interrupted.load(Ordering::Relaxed),
            Task::FixedCount(s) => s.interrupted.load(Ordering::Relaxed),
            Task::Periodic(s) => s.interrupted.load(Ordering::Relaxed),
        }
    }
    #[inline]
    pub(crate) fn set_interrupted(&self, v: bool) {
        match self {
            Task::TimeInterval(s) => s.interrupted.store(v, Ordering::Release),
            Task::RangeInterval(s) => s.interrupted.store(v, Ordering::Release),
            Task::FixedCount(s) => s.interrupted.store(v, Ordering::Release),
            Task::Periodic(s) => s.interrupted.store(v, Ordering::Release),
        }
    }
    /// Marks as interrupted and calls the listener's `on_interrupt` if present.
    pub(crate) fn interrupt(&self) {
        self.set_interrupted(true);
        match self {
            Task::TimeInterval(s) => {
                if let Some(l) = &s.listener {
                    l.on_interrupt();
                }
            }
            Task::RangeInterval(s) => {
                if let Some(l) = &s.listener {
                    l.on_interrupt();
                }
            }
            Task::FixedCount(s) => {
                if let Some(l) = &s.listener {
                    l.on_interrupt();
                }
            }
            Task::Periodic(s) => {
                if let Some(l) = &s.listener {
                    l.on_interrupt();
                }
            }
        }
    }
}