ScriptInvocation in redis - Rust
Description: Represents a prepared script call.

Skip to main content

## ScriptInvocation

# Struct ScriptInvocation

Source

    pub struct ScriptInvocation<'a> { /* private fields */ }

Available on crate feature `script` only.
Expand description

Represents a prepared script call.

## Implementations§

Source§

### impl<'a> ScriptInvocation<'a>

This type collects keys and other arguments for the script so that it can be then invoked. While the `Script` type itself holds the script, the `ScriptInvocation` holds the arguments that should be invoked until it’s sent to the server.

Source

#### pub fn arg<'b, T: ToRedisArgs>( &'b mut self, arg: T, ) -> &'b mut ScriptInvocation<'a>
where 'a: 'b,

Adds a regular argument to the invocation. This ends up as `ARGV[i]` in the script.

Source

#### pub fn key<'b, T: ToRedisArgs>( &'b mut self, key: T, ) -> &'b mut ScriptInvocation<'a>
where 'a: 'b,

Adds a key argument to the invocation. This ends up as `KEYS[i]` in the script.

Source

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

Invokes the script and returns the result.

Source

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

Available on crate feature `aio` only.

Asynchronously invokes the script and returns the result.

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.

## Auto Trait Implementations§

§

### impl<'a> Freeze for ScriptInvocation<'a>

§

### impl<'a> RefUnwindSafe for ScriptInvocation<'a>

§

### impl<'a> Send for ScriptInvocation<'a>

§

### impl<'a> Sync for ScriptInvocation<'a>

§

### impl<'a> Unpin for ScriptInvocation<'a>

§

### impl<'a> UnwindSafe for ScriptInvocation<'a>

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