valkey-module 0.1.14

A toolkit for building valkey modules in Rust
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

use valkey_module::alloc::ValkeyAlloc;
use valkey_module::InfoContext;
use valkey_module::{valkey_module, ValkeyResult};
use valkey_module_macros::{info_command_handler, InfoSection};

#[derive(Debug, Clone, InfoSection)]
struct InfoSection1 {
    field_1: String,
}

#[derive(Debug, Clone, InfoSection)]
struct InfoSection2 {
    field_2: String,
}

#[info_command_handler]
fn add_info(ctx: &InfoContext, _for_crash_report: bool) -> ValkeyResult<()> {
    let data = InfoSection1 {
        field_1: "value1".to_owned(),
    };
    let _ = ctx.build_one_section(data)?;

    let data = InfoSection2 {
        field_2: "value2".to_owned(),
    };

    ctx.build_one_section(data)
}

//////////////////////////////////////////////////////

valkey_module! {
    name: "info_handler_multiple_sections",
    version: 1,
    allocator: (ValkeyAlloc, ValkeyAlloc),
    data_types: [],
    commands: [],
}

#[cfg(test)]
mod tests {
    use super::*;
    use valkey_module::test_shims::{TestInfoEntry, TestInfoField, TestInfoSection, TestInfoValue};

    #[test]
    fn captures_both_derived_info_sections_in_order() {
        let info_ctx = InfoContext::test();

        assert!(add_info(&info_ctx, false).is_ok());

        assert_eq!(
            info_ctx.sections(),
            vec![
                TestInfoSection {
                    name: Some("InfoSection1".to_owned()),
                    entries: vec![TestInfoEntry::Field(TestInfoField {
                        name: "field_1".to_owned(),
                        value: TestInfoValue::String("value1".to_owned()),
                    })],
                },
                TestInfoSection {
                    name: Some("InfoSection2".to_owned()),
                    entries: vec![TestInfoEntry::Field(TestInfoField {
                        name: "field_2".to_owned(),
                        value: TestInfoValue::String("value2".to_owned()),
                    })],
                },
            ]
        );
    }

    #[test]
    fn skips_unrequested_first_info_section() {
        let mut info_ctx = InfoContext::test();
        info_ctx.expect_unrequested_section("InfoSection1");

        assert!(add_info(&info_ctx, false).is_ok());
        assert_eq!(
            info_ctx.sections(),
            vec![TestInfoSection {
                name: Some("InfoSection2".to_owned()),
                entries: vec![TestInfoEntry::Field(TestInfoField {
                    name: "field_2".to_owned(),
                    value: TestInfoValue::String("value2".to_owned()),
                })],
            }]
        );
    }
}