Struct Library

pub struct Library { /* private fields */ }

Available on crate feature i-scripts only.

A helper struct for interacting with libraries and functions.

let code = "#!lua name=mylib \n redis.register_function('myfunc', function(keys, args) return \
            args[1] end)";
let library = Library::from_code(client, code).await?;
assert_eq!(library.name(), "mylib");

if let Some(func) = library.functions().get("myfunc") {
  if func.flags().contains(&FunctionFlag::NoWrites) {
    let _: () = func.fcall_ro(client, "key", "arg").await?;
  } else {
    let _: () = func.fcall(client, "key", "arg").await?;
  }
}

Implementations

impl Library

pub async fn from_code<S>( client: &RedisClient, code: S, ) -> Result<Self, RedisError>

where S: Into<Str>,

Create a new Library with the provided code, loading it on all the servers and inspecting the contents via the FUNCTION LIST command.

This interface will load the library on the server.

pub async fn from_name<S>( client: &RedisClient, name: S, ) -> Result<Self, RedisError>

where S: Into<Str>,

Create a new Library with the associated name, inspecting the library contents via the FUNCTION LIST command.

This interface assumes the library is already loaded on the server.

pub fn name(&self) -> &Str

Read the name of the library.

pub fn functions(&self) -> &HashMap<Str, Function>

Read the functions contained within this library.

Trait Implementations

impl Clone for Library

fn clone(&self) -> Library

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Library

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

Formats the value using the given formatter.

impl Display for Library

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

Formats the value using the given formatter.

impl Hash for Library

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 Library

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,

Restrict a value to a certain interval.

impl PartialEq for Library

fn eq(&self, other: &Library) -> 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 Library

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 Library

impl StructuralPartialEq for Library