Struct fred::types::Script

pub struct Script { /* private fields */ }

Available on crate feature i-scripts only.

An interface for caching and running lua scripts.

async fn example(client: &RedisClient) -> Result<(), RedisError> {
  let script = Script::from_lua("return ARGV[1]");
  assert_eq!(script.sha1(), "098e0f0d1448c0a81dafe820f66d460eb09263da");

  let _ = script.load(client).await?;
  let result: String = script.evalsha(client, "key", "arg").await?;
  assert_eq!(result, "arg");
  Ok(())
}

Implementations

impl Script

pub fn from_lua<S: Into<Str>>(lua: S) -> Self

Available on crate feature sha-1 only.

Create a new Script from a lua script.

pub fn from_hash<S: Into<Str>>(hash: S) -> Self

Create a new Script from a lua hash.

pub fn lua(&self) -> Option<&Str>

Read the lua script contents.

pub fn sha1(&self) -> &Str

Read the SHA-1 hash for the script.

pub async fn load(&self, client: &RedisClient) -> RedisResult<()>

Available on crate feature sha-1 only.

Call SCRIPT LOAD on all the associated servers. This must be called once before calling evalsha.

pub async fn evalsha<R, C, K, V>( &self, client: &C, keys: K, args: V, ) -> RedisResult<R>

where R: FromRedis, C: LuaInterface + Send + Sync, K: Into<MultipleKeys> + Send, V: TryInto<MultipleValues> + Send, V::Error: Into<RedisError> + Send,

Send EVALSHA to the server with the provided arguments.

pub async fn evalsha_with_reload<R, K, V>( &self, client: &RedisClient, keys: K, args: V, ) -> RedisResult<R>

where R: FromRedis, K: Into<MultipleKeys> + Send, V: TryInto<MultipleValues> + Send, V::Error: Into<RedisError> + Send,

Available on crate feature sha-1 only.

Send EVALSHA to the server with the provided arguments. Automatically SCRIPT LOAD in case of NOSCRIPT error and try EVALSHA again.

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.

impl Display for Script

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

Formats the value using the given formatter.

impl Hash for Script

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Script

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Script

fn eq(&self, other: &Script) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Script

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Script

impl StructuralPartialEq for Script