Trait redis_driver::ScriptingCommands

pub trait ScriptingCommands<T>: PrepareCommand<T> {
    fn eval<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>
    where
        R: FromValue,
    { ... }
    fn eval_readonly<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>
    where
        R: FromValue,
    { ... }
    fn evalsha<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>
    where
        R: FromValue,
    { ... }
    fn evalsha_readonly<R>(
        &self,
        builder: CallBuilder
    ) -> CommandResult<'_, T, R>
    where
        R: FromValue,
    { ... }
    fn fcall<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>
    where
        R: FromValue,
    { ... }
    fn fcall_readonly<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>
    where
        R: FromValue,
    { ... }
    fn function_delete<L>(&self, library_name: L) -> CommandResult<'_, T, ()>
    where
        L: Into<BulkString>,
    { ... }
    fn function_dump<P>(&self) -> CommandResult<'_, T, P>
    where
        P: FromValue,
    { ... }
    fn function_flush(
        &self,
        flushing_mode: FlushingMode
    ) -> CommandResult<'_, T, ()> { ... }
    fn function_kill(&self) -> CommandResult<'_, T, ()> { ... }
    fn function_list(
        &self,
        options: FunctionListOptions
    ) -> CommandResult<'_, T, Vec<LibraryInfo>> { ... }
    fn function_load<F, L>(
        &self,
        replace: bool,
        function_code: F
    ) -> CommandResult<'_, T, L>
    where
        F: Into<BulkString>,
        L: FromValue,
    { ... }
    fn function_restore<P>(
        &self,
        serialized_payload: P,
        policy: FunctionRestorePolicy
    ) -> CommandResult<'_, T, ()>
    where
        P: Into<BulkString>,
    { ... }
    fn function_stats(&self) -> CommandResult<'_, T, FunctionStats> { ... }
    fn script_debug(
        &self,
        debug_mode: ScriptDebugMode
    ) -> CommandResult<'_, T, ()> { ... }
    fn script_exists<S, C>(&self, sha1s: C) -> CommandResult<'_, T, Vec<bool>>
    where
        S: Into<BulkString>,
        C: SingleArgOrCollection<S>,
    { ... }
    fn script_flush(
        &self,
        flushing_mode: FlushingMode
    ) -> CommandResult<'_, T, ()> { ... }
    fn script_kill(&self) -> CommandResult<'_, T, ()> { ... }
    fn script_load<S, V>(&self, script: S) -> CommandResult<'_, T, V>
    where
        S: Into<BulkString>,
        V: FromValue,
    { ... }
}

A group of Redis commands related to Scripting and Functions

See Also

Redis Scripting and Functions Commands Scripting with LUA Functions

Provided Methods

fn eval<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>where
    R: FromValue,

Invoke the execution of a server-side Lua script.

Return

The return value of the script

See Also

https://redis.io/commands/eval/

fn eval_readonly<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>where
    R: FromValue,

This is a read-only variant of the eval] command that cannot execute commands that modify data.

Return

The return value of the script

See Also

https://redis.io/commands/eval_ro/

fn evalsha<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>where
    R: FromValue,

Evaluate a script from the server’s cache by its SHA1 digest.

Return

The return value of the script

See Also

https://redis.io/commands/eval/

fn evalsha_readonly<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>where
    R: FromValue,

This is a read-only variant of the evalsha command that cannot execute commands that modify data.

Return

The return value of the script

See Also

https://redis.io/commands/evalsha_ro/

fn fcall<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>where
    R: FromValue,

Invoke a function.

Return

The return value of the function

See Also

https://redis.io/commands/fcall/

fn fcall_readonly<R>(&self, builder: CallBuilder) -> CommandResult<'_, T, R>where
    R: FromValue,

Invoke a function.

Return

The return value of the function

See Also

https://redis.io/commands/fcall-ro/

fn function_delete<L>(&self, library_name: L) -> CommandResult<'_, T, ()>where
    L: Into<BulkString>,

Delete a library and all its functions.

See Also

https://redis.io/commands/function-delete/

fn function_dump<P>(&self) -> CommandResult<'_, T, P>where
    P: FromValue,

Return the serialized payload of loaded libraries. You can restore the serialized payload later with the function_restore command.

Return

The serialized payload

See Also

https://redis.io/commands/function-dump/

fn function_flush(&self, flushing_mode: FlushingMode) -> CommandResult<'_, T, ()>

Deletes all the libraries.

See Also

https://redis.io/commands/function-flush/

fn function_kill(&self) -> CommandResult<'_, T, ()>

Kill a function that is currently executing.

See Also

https://redis.io/commands/function-kill/

fn function_list(
    &self,
    options: FunctionListOptions
) -> CommandResult<'_, T, Vec<LibraryInfo>>

Return information about the functions and libraries.

See Also

https://redis.io/commands/function-list/

fn function_load<F, L>(
    &self,
    replace: bool,
    function_code: F
) -> CommandResult<'_, T, L>where
    F: Into<BulkString>,
    L: FromValue,

Load a library to Redis.

Return

The library name that was loaded

See Also

https://redis.io/commands/function-load/

fn function_restore<P>(
    &self,
    serialized_payload: P,
    policy: FunctionRestorePolicy
) -> CommandResult<'_, T, ()>where
    P: Into<BulkString>,

Restore libraries from the serialized payload.

See Also

https://redis.io/commands/function-restore/

fn function_stats(&self) -> CommandResult<'_, T, FunctionStats>

Return information about the function that’s currently running and information about the available execution engines.

See Also

https://redis.io/commands/function-stats/

fn script_debug(&self, debug_mode: ScriptDebugMode) -> CommandResult<'_, T, ()>

Set the debug mode for subsequent scripts executed with EVAL.

See Also

https://redis.io/commands/script-debug/

fn script_exists<S, C>(&self, sha1s: C) -> CommandResult<'_, T, Vec<bool>>where
    S: Into<BulkString>,
    C: SingleArgOrCollection<S>,

Returns information about the existence of the scripts in the script cache.

Return

The SHA1 digest of the script added into the script cache.

See Also

https://redis.io/commands/script-exists/

fn script_flush(&self, flushing_mode: FlushingMode) -> CommandResult<'_, T, ()>

Flush the Lua scripts cache.

See Also

https://redis.io/commands/script-flush/

fn script_kill(&self) -> CommandResult<'_, T, ()>

Kills the currently executing EVAL script, assuming no write operation was yet performed by the script.

See Also

https://redis.io/commands/script-kill/

fn script_load<S, V>(&self, script: S) -> CommandResult<'_, T, V>where
    S: Into<BulkString>,
    V: FromValue,

Load a script into the scripts cache, without executing it.

Return

The SHA1 digest of the script added into the script cache.

See Also

https://redis.io/commands/script-load/

Implementors

impl ScriptingCommands<ClientResult> for Client

impl<T: Send + Sync> ScriptingCommands<T> for Transaction<T>