valkey-module 0.1.12

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

use valkey_module::alloc::ValkeyAlloc;
use valkey_module::{valkey_module, Context, Status, ValkeyString};

fn preload(ctx: &Context, args: &[ValkeyString]) -> Status {
    // perform preload validations here, useful for MODULE LOAD
    // unlike init which is called at the end of the valkey_module! macro this is called at the beginning
    let version = ctx.get_server_version().unwrap();
    ctx.log_notice(&format!(
        "preload for server version {:?} with args: {:?}",
        version, args
    ));
    // respond with either Status::Ok or Status::Err (if you want to prevent module loading)
    Status::Ok
}

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

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn accepts_configured_server_version() {
        let mut context = Context::test();
        context.expect_get_server_version(8, 1, 2);
        let args = [ValkeyString::test("arg1")];

        assert_eq!(preload(&context, &args), Status::Ok);
    }
}