redis-lua

Lua脚本助手，用于redis-rs。

• 编译时对Redis Lua脚本进行检查。
• 在Lua脚本中捕获Rust变量。
• 安全的参数替换。

use redis_lua::lua;

fn main() {
    let client = redis::Client::open("redis://127.0.0.1/").unwrap();
    let mut con = client.get_connection().unwrap();

    let msg = "Hello Lua";
    let num = 42;

    let script = lua!(
        return @msg .. " / " .. @num
    );

    let v: String = script.invoke(&mut con).unwrap();
    println!("result: {}", v);
}

使用说明

将以下内容添加到您的 Cargo.toml

redis-lua = "0.2"

错误报告

在Lua脚本中的错误（如未定义变量）将在编译时检测到。

let script = lua!(
    return @msg .. " / " .. @num .. x
);

$ cargo build
...
error: in lua: `x` is not defined (undefined_variable)     
  --> redis-lua/examples/simple.rs:11:41                   
   |                         
11 |         return @msg .. " / " .. @num .. x             
   |                                         ^             

error: aborting due to previous error                      

参数替换

支持两种从Rust传递值到脚本的方法。

• @x 用于捕获Rust变量（通过移动）。
• $x 用于稍后替换值。

let x = 50;

let script = lua!(
    local v = $a * $b * $c
    if v > @x then
        return v .. " is large"
    else
        return v .. " is small"
    end
);

for i in 0..4 {
    // You can `clone()` the script to call it multiple times with different parameters.
    let r: String = script.clone().a(15).b(i).c(3).invoke(&mut con).unwrap();
    println!("{}", r);
}

脚本可重用性

由 lua! 返回的脚本对象如果是可克隆的，则可克隆。

连接脚本

+ 运算符连接两个脚本。脚本被视为单个脚本，并在Redis中原子性地执行。第一个脚本的返回值被丢弃。只有最后一个脚本的返回值由Redis回复。

let script1 = redis_lua::lua!(
    return redis.call("set", "a", $x);
);
let script2 = redis_lua::lua!(
    return redis.call("set", "b", $y);
);
let script = script1 + script2;

let mut cli = redis::Client::open("redis://127.0.0.1").unwrap();
let res: String = script.x(20).y(2).invoke(&mut cli).unwrap();
assert_eq!(res, "OK");

脚本特征

任何完成替换的脚本都实现了 Script 特征。您可以将其作为 Box<dyn Script> 传递。

let script1 = lua! {
    return 1 + 2;
};

let x = 10;
let script2 = lua! {
    return @x + 2;
};

let incomplete_script = lua! {
    return $x + 2;
};
let script3 = incomplete_script.x(2);

let boxed1 = Box::new(script1) as Box<dyn redis_lua::Script>;
let boxed2 = Box::new(script2) as Box<dyn redis_lua::Script>;
let boxed3 = Box::new(script3) as Box<dyn redis_lua::Script>;

如果您想连接boxed脚本，请使用 join 方法。

let joined_boxed = boxed1.join(boxed2).join(boxed3);

异步支持

支持异步等待。

use redis_lua::lua;

#[tokio::main]
async fn main() {
    let client = redis::Client::open("redis://127.0.0.1/").unwrap();
    let mut con = client.get_multiplexed_tokio_connection().await.unwrap();

    let msg = "Hello Lua";
    let num = 42;

    let script = lua!(
        return @msg .. " / " .. @num
    );

    let v: String = script.invoke_async(&mut con).await.unwrap();
    println!("result: {}", v);
}