dbuff 0.1.0

Double-buffered state with async command chains, streaming, and keyed task pools for ratatui applications
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use dbuff::*;
use error_stack::Report;
use std::time::Duration;

#[derive(Debug, Clone, Default)]
struct AppData {
    step1_status: TaskStatus<i32>,
    step2_status: TaskStatus<()>,
    error_log: Vec<String>,
}

#[derive(Debug, Clone, wherror::Error)]
#[error("step failed: {reason}")]
struct FailError {
    reason: String,
}

struct Add(i32);

#[derive(Debug, Clone, wherror::Error)]
#[error(debug)]
struct AddError;

#[async_trait::async_trait]
impl Command<()> for Add {
    type Output = i32;
    type Error = Report<AddError>;

    async fn execute(self, _: ()) -> Result<Self::Output, Self::Error> {
        tokio::time::sleep(Duration::from_millis(50)).await;
        Ok(self.0)
    }
}

struct Fail;

#[async_trait::async_trait]
impl Command<()> for Fail {
    type Output = ();
    type Error = Report<FailError>;

    async fn execute(self, _: ()) -> Result<Self::Output, Self::Error> {
        tokio::time::sleep(Duration::from_millis(50)).await;
        Err(Report::from(FailError {
            reason: "something went wrong".into(),
        }))
    }
}

#[tokio::main]
async fn main() {
    let rt = tokio::runtime::Handle::current();
    let (domain, write_handle) =
        SharedDomainData::with_coalesce(AppData::default(), Duration::from_micros(500));
    tokio::spawn(write_handle.run());

    println!("step1_status: {:?}", domain.read().step1_status);
    println!("step2_status: {:?}", domain.read().step2_status);
    println!("---");

    let handle = domain
        .bind((), rt.clone())
        .on_error(|report, d| {
            d.error_log.push(format!("{report}"));
            d.error_log.push(format!("{report:?}"));
        })
        .exec(Add(10), |_, _: &i32| {})
        .tracked(|d: &mut AppData, status: TaskStatus<i32>| d.step1_status = status)
        .exec_discard(Fail)
        .tracked(|d: &mut AppData, status: TaskStatus<()>| d.step2_status = status)
        .go();

    loop {
        let state = domain.read();
        match &state.step1_status {
            TaskStatus::Idle => {
                println!("step1_status: idle");
            }
            TaskStatus::Pending => {
                println!("step1_status: pending...");
            }
            TaskStatus::Resolved(v) => {
                println!("step1_status: resolved ({v})");
                break;
            }
            TaskStatus::Error(e) => {
                println!("step1_status: error ({e})");
                panic!("step1 should succeed");
            }
            TaskStatus::Aborted => {
                println!("step1_status: aborted");
                panic!("step1 should succeed");
            }
        }
        tokio::time::sleep(Duration::from_millis(5)).await;
    }

    loop {
        let state = domain.read();
        match &state.step2_status {
            TaskStatus::Idle => {
                println!("step2_status: idle");
            }
            TaskStatus::Pending => {
                println!("step2_status: pending...");
            }
            TaskStatus::Resolved(()) => {
                println!("step2_status: resolved");
                panic!("step2 should fail");
            }
            TaskStatus::Error(e) => {
                println!("step2_status: error ({e})");
                break;
            }
            TaskStatus::Aborted => {
                println!("step2_status: aborted");
                panic!("step2 should fail with error, not abort");
            }
        }
        tokio::time::sleep(Duration::from_millis(5)).await;
    }

    let flow = handle.await.unwrap();
    assert_eq!(flow, ControlFlow::Break);

    tokio::time::sleep(Duration::from_millis(10)).await;

    let state = domain.read();
    println!("---");
    println!("step1_status = {:?}", state.step1_status);
    println!("step2_status = {:?}", state.step2_status);
    println!("error_log = {:?}", state.error_log);

    assert!(state.step1_status.is_resolved());
    assert_eq!(*state.step1_status.resolved().unwrap(), 10);
    assert!(state.step2_status.is_error());
    let err_msg = state.step2_status.error().unwrap().to_string();
    assert!(
        err_msg.contains("step failed"),
        "expected actual error, got: {err_msg}"
    );
    assert!(
        !err_msg.contains("chain error"),
        "should not be generic 'chain error'"
    );
    assert!(!state.error_log.is_empty());
}