dfir_rs 0.16.0

DFIR runtime for Rust, used by Hydro.
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

use dfir_rs::util::collect_ready;
use multiplatform_test::multiplatform_test;

#[multiplatform_test]
pub fn test_scan_async_blocking_tick() {
    let (items_send, items_recv) = dfir_rs::util::unbounded_channel::<u32>();
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<u32>();

    let mut df = dfir_rs::dfir_syntax! {
        source_stream(items_recv)
            -> scan_async_blocking::<'tick>(|| 0, |acc: &mut u32, x: u32| {
                *acc += x;
                let val = *acc;
                async move { Some(val) }
            })
            -> for_each(|v| result_send.send(v).unwrap());
    };

    items_send.send(1).unwrap();
    items_send.send(2).unwrap();
    df.run_tick_sync();

    assert_eq!(&[1, 3], &*collect_ready::<Vec<_>, _>(&mut result_recv));

    // With 'tick' persistence, accumulator resets each tick
    items_send.send(3).unwrap();
    items_send.send(4).unwrap();
    df.run_tick_sync();

    assert_eq!(&[3, 7], &*collect_ready::<Vec<_>, _>(&mut result_recv));

    df.run_available_sync();
}

#[multiplatform_test]
pub fn test_scan_async_blocking_static() {
    let (items_send, items_recv) = dfir_rs::util::unbounded_channel::<u32>();
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<u32>();

    let mut df = dfir_rs::dfir_syntax! {
        source_stream(items_recv)
            -> scan_async_blocking::<'static>(|| 0, |acc: &mut u32, x: u32| {
                *acc += x;
                let val = *acc;
                async move { Some(val) }
            })
            -> for_each(|v| result_send.send(v).unwrap());
    };

    items_send.send(1).unwrap();
    items_send.send(2).unwrap();
    df.run_tick_sync();

    assert_eq!(&[1, 3], &*collect_ready::<Vec<_>, _>(&mut result_recv));

    // With 'static' persistence, accumulator persists across ticks
    items_send.send(3).unwrap();
    items_send.send(4).unwrap();
    df.run_tick_sync();

    assert_eq!(&[6, 10], &*collect_ready::<Vec<_>, _>(&mut result_recv));

    df.run_available_sync();
}

#[multiplatform_test]
pub fn test_scan_async_blocking_filter() {
    // Test that returning None from the future filters the item
    let (items_send, items_recv) = dfir_rs::util::unbounded_channel::<u32>();
    let (result_send, mut result_recv) = dfir_rs::util::unbounded_channel::<u32>();

    let mut df = dfir_rs::dfir_syntax! {
        source_stream(items_recv)
            -> scan_async_blocking::<'tick>(|| 0, |acc: &mut u32, x: u32| {
                *acc += x;
                let val = *acc;
                async move {
                    if val.is_multiple_of(2) { None } else { Some(val) }
                }
            })
            -> for_each(|v| result_send.send(v).unwrap());
    };

    items_send.send(1).unwrap(); // acc=1, odd -> Some(1)
    items_send.send(1).unwrap(); // acc=2, even -> None
    items_send.send(1).unwrap(); // acc=3, odd -> Some(3)
    items_send.send(1).unwrap(); // acc=4, even -> None
    df.run_tick_sync();

    assert_eq!(&[1, 3], &*collect_ready::<Vec<_>, _>(&mut result_recv));

    df.run_available_sync();
}