Struct Script

pub struct Script { /* private fields */ }

Represents a lua script.

Implementations

impl Script

The script object represents a lua script that can be executed on the redis server. The object itself takes care of automatic uploading and execution. The script object itself can be shared and is immutable.

Example:

let script = redis::Script::new(r"
    return tonumber(ARGV[1]) + tonumber(ARGV[2]);
");
let result = script.arg(1).arg(2).invoke(&mut con);
assert_eq!(result, Ok(3));

pub fn new(code: &str) -> Script

Creates a new script object.

pub fn get_hash(&self) -> &str

Returns the script’s SHA1 hash in hexadecimal format.

pub fn load(&self, con: &mut dyn ConnectionLike) -> RedisResult<String>

Loads the script and returns the SHA1 of it.

pub async fn load_async<C>(&self, con: &mut C) -> RedisResult<String>

where C: ConnectionLike,

Asynchronously loads the script and returns the SHA1 of it.

pub fn key<T: ToRedisArgs>(&self, key: T) -> ScriptInvocation<'_>

Creates a script invocation object with a key filled in.

pub fn arg<T: ToRedisArgs>(&self, arg: T) -> ScriptInvocation<'_>

Creates a script invocation object with an argument filled in.

pub fn prepare_invoke(&self) -> ScriptInvocation<'_>

Returns an empty script invocation object. This is primarily useful for programmatically adding arguments and keys because the type will not change. Normally you can use arg and key directly.

pub fn invoke<T: FromRedisValue>( &self, con: &mut dyn ConnectionLike, ) -> RedisResult<T>

Invokes the script directly without arguments.

pub async fn invoke_async<C, T>(&self, con: &mut C) -> RedisResult<T>

where C: ConnectionLike, T: FromRedisValue,

Asynchronously invokes the script without arguments.

Trait Implementations

impl Clone for Script

fn clone(&self) -> Script

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Script

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.