Script in redis - Rust
Description: Represents a lua script.

Skip to main content

## Script

# Struct Script

Source

    pub struct Script { /* private fields */ }

Available on crate feature `script` only.
Expand description

Represents a lua script.

## Implementations§

Source§

### 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));

Source

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

Creates a new script object.

Source

#### pub fn get_hash(&self) -> &str

Returns the script’s SHA1 hash in hexadecimal format.

Source

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

Loads the script and returns the SHA1 of it.

Source

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

Available on crate feature `aio` only.

Asynchronously loads the script and returns the SHA1 of it.

Source

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

Creates a script invocation object with a key filled in.

Source

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

Creates a script invocation object with an argument filled in.

Source

#### 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.

Source

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

Invokes the script directly without arguments.

Source

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

Available on crate feature `aio` only.

Asynchronously invokes the script without arguments.

## Trait Implementations§

Source§

### impl Clone for Script

Source§

#### fn clone(&self) -> Script

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for Script

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl Freeze for Script

§

### impl RefUnwindSafe for Script

§

### impl Send for Script

§

### impl Sync for Script

§

### impl Unpin for Script

§

### impl UnwindSafe for Script

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T