tasktree 0.1.0

Distributed task-tree values: W3C trace-compatible task identities under an application-supplied URN scheme, validated lifecycle transitions, lineage, and progress
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

//! A single typed task-progress observation.

use crate::TaskEventLevel;

/// A single progress observation for a task.
///
/// Bundles counters with the optional step label that produced them, so one
/// progress emission stays one event rather than duplicating its label as a
/// separate step record.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TaskProgressUpdate {
    processed: u64,
    total: Option<u64>,
    level: TaskEventLevel,
    label: Option<String>,
}

impl TaskProgressUpdate {
    /// Create a bare observation with no total or label at the default level.
    #[must_use]
    pub fn new(processed: u64) -> Self {
        Self {
            processed,
            total: None,
            level: TaskEventLevel::default(),
            label: None,
        }
    }

    /// Attach the total, when the producing stage knows one.
    #[must_use]
    pub fn with_total(mut self, total: Option<u64>) -> Self {
        self.total = total;
        self
    }

    /// Set the verbosity tier of the producing call site.
    #[must_use]
    pub fn with_level(mut self, level: TaskEventLevel) -> Self {
        self.level = level;
        self
    }

    /// Attach the step label describing the counted work.
    #[must_use]
    pub fn with_label(mut self, label: Option<String>) -> Self {
        self.label = label;
        self
    }

    /// Items processed so far.
    #[must_use]
    pub fn processed(&self) -> u64 {
        self.processed
    }

    /// Total items, when known.
    #[must_use]
    pub fn total(&self) -> Option<u64> {
        self.total
    }

    /// Verbosity tier of the producing call site.
    #[must_use]
    pub fn level(&self) -> TaskEventLevel {
        self.level
    }

    /// Step label describing the counted work.
    #[must_use]
    pub fn label(&self) -> Option<&str> {
        self.label.as_deref()
    }

    /// Consume the update, yielding its label.
    #[must_use]
    pub fn into_label(self) -> Option<String> {
        self.label
    }
}

#[cfg(test)]
mod tests {
    use super::TaskProgressUpdate;
    use crate::TaskEventLevel;

    #[test]
    fn builder_defaults_are_bare() {
        let update = TaskProgressUpdate::new(7);

        assert_eq!(update.processed(), 7);
        assert_eq!(update.total(), None);
        assert_eq!(update.level(), TaskEventLevel::Info);
        assert_eq!(update.label(), None);
    }

    #[test]
    fn consuming_an_update_yields_its_label() {
        let update = TaskProgressUpdate::new(1).with_label(Some("hydrate".to_owned()));

        assert_eq!(update.into_label().as_deref(), Some("hydrate"));
    }
}