Trait redis_cluster_rs::PipelineCommands

pub trait PipelineCommands {
    pub fn get<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn keys<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn set<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn set_multiple<K, V>(&mut self, items: &[(K, V)]) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn set_ex<K, V>(
        &mut self, 
        key: K, 
        value: V, 
        seconds: usize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn set_nx<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn mset_nx<K, V>(&mut self, items: &[(K, V)]) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn getset<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn del<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn exists<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn expire<K>(&mut self, key: K, seconds: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn expire_at<K>(&mut self, key: K, ts: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn pexpire<K>(&mut self, key: K, ms: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn pexpire_at<K>(&mut self, key: K, ts: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn persist<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn ttl<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn rename<K>(&mut self, key: K, new_key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn rename_nx<K>(&mut self, key: K, new_key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn append<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn incr<K, V>(&mut self, key: K, delta: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn setbit<K>(&mut self, key: K, offset: usize, value: bool) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn getbit<K>(&mut self, key: K, offset: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn bitcount<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn bitcount_range<K>(
        &mut self, 
        key: K, 
        start: usize, 
        end: usize
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn bit_and<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn bit_or<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn bit_xor<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn bit_not<K>(&mut self, dstkey: K, srckey: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn strlen<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn hget<K, F>(&mut self, key: K, field: F) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
    { ... }
    pub fn hdel<K, F>(&mut self, key: K, field: F) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
    { ... }
    pub fn hset<K, F, V>(&mut self, key: K, field: F, value: V) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn hset_nx<K, F, V>(&mut self, key: K, field: F, value: V) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn hset_multiple<K, F, V>(
        &mut self, 
        key: K, 
        items: &[(F, V)]
    ) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn hincr<K, F, D>(&mut self, key: K, field: F, delta: D) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
        D: ToRedisArgs,
    { ... }
    pub fn hexists<K, F>(&mut self, key: K, field: F) -> &mut Self
    where
        F: ToRedisArgs,
        K: ToRedisArgs,
    { ... }
    pub fn hkeys<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn hvals<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn hgetall<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn hlen<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn blpop<K>(&mut self, key: K, timeout: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn brpop<K>(&mut self, key: K, timeout: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn brpoplpush<K>(
        &mut self, 
        srckey: K, 
        dstkey: K, 
        timeout: usize
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn lindex<K>(&mut self, key: K, index: isize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn linsert_before<K, P, V>(
        &mut self, 
        key: K, 
        pivot: P, 
        value: V
    ) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
        P: ToRedisArgs,
    { ... }
    pub fn linsert_after<K, P, V>(
        &mut self, 
        key: K, 
        pivot: P, 
        value: V
    ) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
        P: ToRedisArgs,
    { ... }
    pub fn llen<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn lpop<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn lpush<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn lpush_exists<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn lrange<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn lrem<K, V>(&mut self, key: K, count: isize, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn ltrim<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn lset<K, V>(&mut self, key: K, index: isize, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn rpop<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn rpoplpush<K>(&mut self, key: K, dstkey: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn rpush<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn rpush_exists<K, V>(&mut self, key: K, value: V) -> &mut Self
    where
        K: ToRedisArgs,
        V: ToRedisArgs,
    { ... }
    pub fn sadd<K, M>(&mut self, key: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn scard<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn sdiff<K>(&mut self, keys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn sdiffstore<K>(&mut self, dstkey: K, keys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn sinter<K>(&mut self, keys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn sdinterstore<K>(&mut self, dstkey: K, keys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn sismember<K, M>(&mut self, key: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn smembers<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn smove<K, M>(&mut self, srckey: K, dstkey: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn spop<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn srandmember<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn srandmember_multiple<K>(&mut self, key: K, count: usize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn srem<K, M>(&mut self, key: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn sunion<K>(&mut self, keys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn sunionstore<K>(&mut self, dstkey: K, keys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zadd<K, S, M>(&mut self, key: K, member: M, score: S) -> &mut Self
    where
        K: ToRedisArgs,
        S: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn zadd_multiple<K, S, M>(
        &mut self, 
        key: K, 
        items: &[(S, M)]
    ) -> &mut Self
    where
        K: ToRedisArgs,
        S: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn zcard<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zcount<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zincr<K, M, D>(&mut self, key: K, member: M, delta: D) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        D: ToRedisArgs,
    { ... }
    pub fn zinterstore<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zinterstore_min<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zinterstore_max<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zlexcount<K, L>(&mut self, key: K, min: L, max: L) -> &mut Self
    where
        K: ToRedisArgs,
        L: ToRedisArgs,
    { ... }
    pub fn zrange<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zrange_withscores<K>(
        &mut self, 
        key: K, 
        start: isize, 
        stop: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zrangebylex<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrangebylex_limit<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM, 
        offset: isize, 
        count: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrangebylex<K, MM, M>(
        &mut self, 
        key: K, 
        max: MM, 
        min: M
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrangebylex_limit<K, MM, M>(
        &mut self, 
        key: K, 
        max: MM, 
        min: M, 
        offset: isize, 
        count: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrangebyscore<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrangebyscore_withscores<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrangebyscore_limit<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM, 
        offset: isize, 
        count: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrangebyscore_limit_withscores<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM, 
        offset: isize, 
        count: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrank<K, M>(&mut self, key: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn zrem<K, M>(&mut self, key: K, members: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn zrembylex<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrembyrank<K>(
        &mut self, 
        key: K, 
        start: isize, 
        stop: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zrembyscore<K, M, MM>(
        &mut self, 
        key: K, 
        min: M, 
        max: MM
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrange<K>(
        &mut self, 
        key: K, 
        start: isize, 
        stop: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zrevrange_withscores<K>(
        &mut self, 
        key: K, 
        start: isize, 
        stop: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zrevrangebyscore<K, MM, M>(
        &mut self, 
        key: K, 
        max: MM, 
        min: M
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrangebyscore_withscores<K, MM, M>(
        &mut self, 
        key: K, 
        max: MM, 
        min: M
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrangebyscore_limit<K, MM, M>(
        &mut self, 
        key: K, 
        max: MM, 
        min: M, 
        offset: isize, 
        count: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrangebyscore_limit_withscores<K, MM, M>(
        &mut self, 
        key: K, 
        max: MM, 
        min: M, 
        offset: isize, 
        count: isize
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
        MM: ToRedisArgs,
    { ... }
    pub fn zrevrank<K, M>(&mut self, key: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn zscore<K, M>(&mut self, key: K, member: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn zunionstore<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zunionstore_min<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn zunionstore_max<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn pfadd<K, E>(&mut self, key: K, element: E) -> &mut Self
    where
        K: ToRedisArgs,
        E: ToRedisArgs,
    { ... }
    pub fn pfcount<K>(&mut self, key: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn pfmerge<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn publish<K, E>(&mut self, channel: K, message: E) -> &mut Self
    where
        K: ToRedisArgs,
        E: ToRedisArgs,
    { ... }
    pub fn geo_add<K, M>(&mut self, key: K, members: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn geo_dist<K, M1, M2>(
        &mut self, 
        key: K, 
        member1: M1, 
        member2: M2, 
        unit: Unit
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M1: ToRedisArgs,
        M2: ToRedisArgs,
    { ... }
    pub fn geo_hash<K, M>(&mut self, key: K, members: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn geo_pos<K, M>(&mut self, key: K, members: M) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
    pub fn geo_radius<K>(
        &mut self, 
        key: K, 
        longitude: f64, 
        latitude: f64, 
        radius: f64, 
        unit: Unit, 
        options: RadiusOptions
    ) -> &mut Self
    where
        K: ToRedisArgs,
    { ... }
    pub fn geo_radius_by_member<K, M>(
        &mut self, 
        key: K, 
        member: M, 
        radius: f64, 
        unit: Unit, 
        options: RadiusOptions
    ) -> &mut Self
    where
        K: ToRedisArgs,
        M: ToRedisArgs,
    { ... }
}

Implements common redis commands for pipelines. Unlike the regular commands trait, this returns the pipeline rather than a result directly. Other than that it works the same however.

Provided methods

pub fn get<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Get the value of a key. If key is a vec this becomes an MGET.

pub fn keys<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Gets all keys matching pattern

pub fn set<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Set the string value of a key.

pub fn set_multiple<K, V>(&mut self, items: &[(K, V)]) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Sets multiple keys to their values.

pub fn set_ex<K, V>(&mut self, key: K, value: V, seconds: usize) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Set the value and expiration of a key.

pub fn set_nx<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Set the value of a key, only if the key does not exist

pub fn mset_nx<K, V>(&mut self, items: &[(K, V)]) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Sets multiple keys to their values failing if at least one already exists.

pub fn getset<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Set the string value of a key and return its old value.

pub fn del<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Delete one or more keys.

pub fn exists<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Determine if a key exists.

pub fn expire<K>(&mut self, key: K, seconds: usize) -> &mut Self where
    K: ToRedisArgs, 

Set a key's time to live in seconds.

pub fn expire_at<K>(&mut self, key: K, ts: usize) -> &mut Self where
    K: ToRedisArgs, 

Set the expiration for a key as a UNIX timestamp.

pub fn pexpire<K>(&mut self, key: K, ms: usize) -> &mut Self where
    K: ToRedisArgs, 

Set a key's time to live in milliseconds.

pub fn pexpire_at<K>(&mut self, key: K, ts: usize) -> &mut Self where
    K: ToRedisArgs, 

Set the expiration for a key as a UNIX timestamp in milliseconds.

pub fn persist<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Remove the expiration from a key.

pub fn ttl<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Check the expiration time of a key.

pub fn rename<K>(&mut self, key: K, new_key: K) -> &mut Self where
    K: ToRedisArgs, 

Rename a key.

pub fn rename_nx<K>(&mut self, key: K, new_key: K) -> &mut Self where
    K: ToRedisArgs, 

Rename a key, only if the new key does not exist.

pub fn append<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Append a value to a key.

pub fn incr<K, V>(&mut self, key: K, delta: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Increment the numeric value of a key by the given amount. This issues a INCRBY or INCRBYFLOAT depending on the type.

pub fn setbit<K>(&mut self, key: K, offset: usize, value: bool) -> &mut Self where
    K: ToRedisArgs, 

Sets or clears the bit at offset in the string value stored at key.

pub fn getbit<K>(&mut self, key: K, offset: usize) -> &mut Self where
    K: ToRedisArgs, 

Returns the bit value at offset in the string value stored at key.

pub fn bitcount<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Count set bits in a string.

pub fn bitcount_range<K>(
    &mut self,
    key: K,
    start: usize,
    end: usize
) -> &mut Self where
    K: ToRedisArgs, 

Count set bits in a string in a range.

pub fn bit_and<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self where
    K: ToRedisArgs, 

Perform a bitwise AND between multiple keys (containing string values) and store the result in the destination key.

pub fn bit_or<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self where
    K: ToRedisArgs, 

Perform a bitwise OR between multiple keys (containing string values) and store the result in the destination key.

pub fn bit_xor<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self where
    K: ToRedisArgs, 

Perform a bitwise XOR between multiple keys (containing string values) and store the result in the destination key.

pub fn bit_not<K>(&mut self, dstkey: K, srckey: K) -> &mut Self where
    K: ToRedisArgs, 

Perform a bitwise NOT of the key (containing string values) and store the result in the destination key.

pub fn strlen<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Get the length of the value stored in a key.

pub fn hget<K, F>(&mut self, key: K, field: F) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs, 

Gets a single (or multiple) fields from a hash.

pub fn hdel<K, F>(&mut self, key: K, field: F) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs, 

Deletes a single (or multiple) fields from a hash.

pub fn hset<K, F, V>(&mut self, key: K, field: F, value: V) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs,
    V: ToRedisArgs, 

Sets a single field in a hash.

pub fn hset_nx<K, F, V>(&mut self, key: K, field: F, value: V) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs,
    V: ToRedisArgs, 

Sets a single field in a hash if it does not exist.

pub fn hset_multiple<K, F, V>(&mut self, key: K, items: &[(F, V)]) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs,
    V: ToRedisArgs, 

Sets a multiple fields in a hash.

pub fn hincr<K, F, D>(&mut self, key: K, field: F, delta: D) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs,
    D: ToRedisArgs, 

Increments a value.

pub fn hexists<K, F>(&mut self, key: K, field: F) -> &mut Self where
    F: ToRedisArgs,
    K: ToRedisArgs, 

Checks if a field in a hash exists.

pub fn hkeys<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Gets all the keys in a hash.

pub fn hvals<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Gets all the values in a hash.

pub fn hgetall<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Gets all the fields and values in a hash.

pub fn hlen<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Gets the length of a hash.

pub fn blpop<K>(&mut self, key: K, timeout: usize) -> &mut Self where
    K: ToRedisArgs, 

Remove and get the first element in a list, or block until one is available.

pub fn brpop<K>(&mut self, key: K, timeout: usize) -> &mut Self where
    K: ToRedisArgs, 

Remove and get the last element in a list, or block until one is available.

pub fn brpoplpush<K>(
    &mut self,
    srckey: K,
    dstkey: K,
    timeout: usize
) -> &mut Self where
    K: ToRedisArgs, 

Pop a value from a list, push it to another list and return it; or block until one is available.

pub fn lindex<K>(&mut self, key: K, index: isize) -> &mut Self where
    K: ToRedisArgs, 

Get an element from a list by its index.

pub fn linsert_before<K, P, V>(
    &mut self,
    key: K,
    pivot: P,
    value: V
) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs,
    P: ToRedisArgs, 

Insert an element before another element in a list.

pub fn linsert_after<K, P, V>(
    &mut self,
    key: K,
    pivot: P,
    value: V
) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs,
    P: ToRedisArgs, 

Insert an element after another element in a list.

pub fn llen<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Returns the length of the list stored at key.

pub fn lpop<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Removes and returns the first element of the list stored at key.

pub fn lpush<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Insert all the specified values at the head of the list stored at key.

pub fn lpush_exists<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Inserts a value at the head of the list stored at key, only if key already exists and holds a list.

pub fn lrange<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self where
    K: ToRedisArgs, 

Returns the specified elements of the list stored at key.

pub fn lrem<K, V>(&mut self, key: K, count: isize, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Removes the first count occurrences of elements equal to value from the list stored at key.

pub fn ltrim<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self where
    K: ToRedisArgs, 

Trim an existing list so that it will contain only the specified range of elements specified.

pub fn lset<K, V>(&mut self, key: K, index: isize, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Sets the list element at index to value

pub fn rpop<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Removes and returns the last element of the list stored at key.

pub fn rpoplpush<K>(&mut self, key: K, dstkey: K) -> &mut Self where
    K: ToRedisArgs, 

Pop a value from a list, push it to another list and return it.

pub fn rpush<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Insert all the specified values at the tail of the list stored at key.

pub fn rpush_exists<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: ToRedisArgs,
    V: ToRedisArgs, 

Inserts value at the tail of the list stored at key, only if key already exists and holds a list.

pub fn sadd<K, M>(&mut self, key: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Add one or more members to a set.

pub fn scard<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Get the number of members in a set.

pub fn sdiff<K>(&mut self, keys: K) -> &mut Self where
    K: ToRedisArgs, 

Subtract multiple sets.

pub fn sdiffstore<K>(&mut self, dstkey: K, keys: K) -> &mut Self where
    K: ToRedisArgs, 

Subtract multiple sets and store the resulting set in a key.

pub fn sinter<K>(&mut self, keys: K) -> &mut Self where
    K: ToRedisArgs, 

Intersect multiple sets.

pub fn sdinterstore<K>(&mut self, dstkey: K, keys: K) -> &mut Self where
    K: ToRedisArgs, 

Intersect multiple sets and store the resulting set in a key.

pub fn sismember<K, M>(&mut self, key: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Determine if a given value is a member of a set.

pub fn smembers<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Get all the members in a set.

pub fn smove<K, M>(&mut self, srckey: K, dstkey: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Move a member from one set to another.

pub fn spop<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Remove and return a random member from a set.

pub fn srandmember<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Get one random member from a set.

pub fn srandmember_multiple<K>(&mut self, key: K, count: usize) -> &mut Self where
    K: ToRedisArgs, 

Get multiple random members from a set.

pub fn srem<K, M>(&mut self, key: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Remove one or more members from a set.

pub fn sunion<K>(&mut self, keys: K) -> &mut Self where
    K: ToRedisArgs, 

Add multiple sets.

pub fn sunionstore<K>(&mut self, dstkey: K, keys: K) -> &mut Self where
    K: ToRedisArgs, 

Add multiple sets and store the resulting set in a key.

pub fn zadd<K, S, M>(&mut self, key: K, member: M, score: S) -> &mut Self where
    K: ToRedisArgs,
    S: ToRedisArgs,
    M: ToRedisArgs, 

Add one member to a sorted set, or update its score if it already exists.

pub fn zadd_multiple<K, S, M>(&mut self, key: K, items: &[(S, M)]) -> &mut Self where
    K: ToRedisArgs,
    S: ToRedisArgs,
    M: ToRedisArgs, 

Add multiple members to a sorted set, or update its score if it already exists.

pub fn zcard<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Get the number of members in a sorted set.

pub fn zcount<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Count the members in a sorted set with scores within the given values.

pub fn zincr<K, M, D>(&mut self, key: K, member: M, delta: D) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    D: ToRedisArgs, 

Increments the member in a sorted set at key by delta. If the member does not exist, it is added with delta as its score.

pub fn zinterstore<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self where
    K: ToRedisArgs, 

Intersect multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function.

pub fn zinterstore_min<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self where
    K: ToRedisArgs, 

Intersect multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function.

pub fn zinterstore_max<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self where
    K: ToRedisArgs, 

Intersect multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function.

pub fn zlexcount<K, L>(&mut self, key: K, min: L, max: L) -> &mut Self where
    K: ToRedisArgs,
    L: ToRedisArgs, 

Count the number of members in a sorted set between a given lexicographical range.

pub fn zrange<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self where
    K: ToRedisArgs, 

Return a range of members in a sorted set, by index

pub fn zrange_withscores<K>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> &mut Self where
    K: ToRedisArgs, 

Return a range of members in a sorted set, by index with scores.

pub fn zrangebylex<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by lexicographical range.

pub fn zrangebylex_limit<K, M, MM>(
    &mut self,
    key: K,
    min: M,
    max: MM,
    offset: isize,
    count: isize
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by lexicographical range with offset and limit.

pub fn zrevrangebylex<K, MM, M>(&mut self, key: K, max: MM, min: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by lexicographical range.

pub fn zrevrangebylex_limit<K, MM, M>(
    &mut self,
    key: K,
    max: MM,
    min: M,
    offset: isize,
    count: isize
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by lexicographical range with offset and limit.

pub fn zrangebyscore<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score.

pub fn zrangebyscore_withscores<K, M, MM>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score with scores.

pub fn zrangebyscore_limit<K, M, MM>(
    &mut self,
    key: K,
    min: M,
    max: MM,
    offset: isize,
    count: isize
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score with limit.

pub fn zrangebyscore_limit_withscores<K, M, MM>(
    &mut self,
    key: K,
    min: M,
    max: MM,
    offset: isize,
    count: isize
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score with limit with scores.

pub fn zrank<K, M>(&mut self, key: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Determine the index of a member in a sorted set.

pub fn zrem<K, M>(&mut self, key: K, members: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Remove one or more members from a sorted set.

pub fn zrembylex<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Remove all members in a sorted set between the given lexicographical range.

pub fn zrembyrank<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self where
    K: ToRedisArgs, 

Remove all members in a sorted set within the given indexes.

pub fn zrembyscore<K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Remove all members in a sorted set within the given scores.

pub fn zrevrange<K>(&mut self, key: K, start: isize, stop: isize) -> &mut Self where
    K: ToRedisArgs, 

Return a range of members in a sorted set, by index, with scores ordered from high to low.

pub fn zrevrange_withscores<K>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> &mut Self where
    K: ToRedisArgs, 

Return a range of members in a sorted set, by index, with scores ordered from high to low.

pub fn zrevrangebyscore<K, MM, M>(
    &mut self,
    key: K,
    max: MM,
    min: M
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score.

pub fn zrevrangebyscore_withscores<K, MM, M>(
    &mut self,
    key: K,
    max: MM,
    min: M
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score with scores.

pub fn zrevrangebyscore_limit<K, MM, M>(
    &mut self,
    key: K,
    max: MM,
    min: M,
    offset: isize,
    count: isize
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score with limit.

pub fn zrevrangebyscore_limit_withscores<K, MM, M>(
    &mut self,
    key: K,
    max: MM,
    min: M,
    offset: isize,
    count: isize
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs,
    MM: ToRedisArgs, 

Return a range of members in a sorted set, by score with limit with scores.

pub fn zrevrank<K, M>(&mut self, key: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Determine the index of a member in a sorted set, with scores ordered from high to low.

pub fn zscore<K, M>(&mut self, key: K, member: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Get the score associated with the given member in a sorted set.

pub fn zunionstore<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self where
    K: ToRedisArgs, 

Unions multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function.

pub fn zunionstore_min<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self where
    K: ToRedisArgs, 

Unions multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function.

pub fn zunionstore_max<K>(&mut self, dstkey: K, keys: &[K]) -> &mut Self where
    K: ToRedisArgs, 

Unions multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function.

pub fn pfadd<K, E>(&mut self, key: K, element: E) -> &mut Self where
    K: ToRedisArgs,
    E: ToRedisArgs, 

Adds the specified elements to the specified HyperLogLog.

pub fn pfcount<K>(&mut self, key: K) -> &mut Self where
    K: ToRedisArgs, 

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

pub fn pfmerge<K>(&mut self, dstkey: K, srckeys: K) -> &mut Self where
    K: ToRedisArgs, 

Merge N different HyperLogLogs into a single one.

pub fn publish<K, E>(&mut self, channel: K, message: E) -> &mut Self where
    K: ToRedisArgs,
    E: ToRedisArgs, 

Posts a message to the given channel.

pub fn geo_add<K, M>(&mut self, key: K, members: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Adds the specified geospatial items to the specified key.

Every member has to be written as a tuple of (longitude, latitude, member_name). It can be a single tuple, or a vector of tuples.

longitude, latitude can be set using redis::geo::Coord.

Returns the number of elements added to the sorted set, not including elements already existing for which the score was updated.

Example

use redis::{Commands, Connection, RedisResult};
use redis::geo::Coord;

fn add_point(con: &mut Connection) -> RedisResult<isize> {
    con.geo_add("my_gis", (Coord::lon_lat(13.361389, 38.115556), "Palermo"))
}

fn add_point_with_tuples(con: &mut Connection) -> RedisResult<isize> {
    con.geo_add("my_gis", ("13.361389", "38.115556", "Palermo"))
}

fn add_many_points(con: &mut Connection) -> RedisResult<isize> {
    con.geo_add("my_gis", &[
        ("13.361389", "38.115556", "Palermo"),
        ("15.087269", "37.502669", "Catania")
    ])
}

pub fn geo_dist<K, M1, M2>(
    &mut self,
    key: K,
    member1: M1,
    member2: M2,
    unit: Unit
) -> &mut Self where
    K: ToRedisArgs,
    M1: ToRedisArgs,
    M2: ToRedisArgs, 

Return the distance between two members in the geospatial index represented by the sorted set.

If one or both the members are missing, the command returns NULL, so it may be convenient to parse its response as either Option<f64> or Option<String>.

Example

use redis::{Commands, RedisResult};
use redis::geo::Unit;

fn get_dists(con: &mut redis::Connection) {
    let x: RedisResult<f64> = con.geo_dist(
        "my_gis",
        "Palermo",
        "Catania",
        Unit::Kilometers
    );
    // x is Ok(166.2742)

    let x: RedisResult<Option<f64>> = con.geo_dist(
        "my_gis",
        "Palermo",
        "Atlantis",
        Unit::Meters
    );
    // x is Ok(None)
}

pub fn geo_hash<K, M>(&mut self, key: K, members: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Return valid Geohash strings representing the position of one or more members of the geospatial index represented by the sorted set at key.

Example

use redis::{Commands, RedisResult};

fn get_hash(con: &mut redis::Connection) {
    let x: RedisResult<Vec<String>> = con.geo_hash("my_gis", "Palermo");
    // x is vec!["sqc8b49rny0"]

    let x: RedisResult<Vec<String>> = con.geo_hash("my_gis", &["Palermo", "Catania"]);
    // x is vec!["sqc8b49rny0", "sqdtr74hyu0"]
}

pub fn geo_pos<K, M>(&mut self, key: K, members: M) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Return the positions of all the specified members of the geospatial index represented by the sorted set at key.

Every position is a pair of (longitude, latitude). redis::geo::Coord can be used to convert these value in a struct.

Example

use redis::{Commands, RedisResult};
use redis::geo::Coord;

fn get_position(con: &mut redis::Connection) {
    let x: RedisResult<Vec<Vec<f64>>> = con.geo_pos("my_gis", &["Palermo", "Catania"]);
    // x is [ [ 13.361389, 38.115556 ], [ 15.087269, 37.502669 ] ];

    let x: Vec<Coord<f64>> = con.geo_pos("my_gis", "Palermo").unwrap();
    // x[0].longitude is 13.361389
    // x[0].latitude is 38.115556
}

pub fn geo_radius<K>(
    &mut self,
    key: K,
    longitude: f64,
    latitude: f64,
    radius: f64,
    unit: Unit,
    options: RadiusOptions
) -> &mut Self where
    K: ToRedisArgs, 

Return the members of a sorted set populated with geospatial information using geo_add, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

Every item in the result can be read with redis::geo::RadiusSearchResult, which support the multiple formats returned by GEORADIUS.

use redis::{Commands, RedisResult};
use redis::geo::{RadiusOptions, RadiusSearchResult, RadiusOrder, Unit};

fn radius(con: &mut redis::Connection) -> Vec<RadiusSearchResult> {
    let opts = RadiusOptions::default().with_dist().order(RadiusOrder::Asc);
    con.geo_radius("my_gis", 15.90, 37.21, 51.39, Unit::Kilometers, opts).unwrap()
}

pub fn geo_radius_by_member<K, M>(
    &mut self,
    key: K,
    member: M,
    radius: f64,
    unit: Unit,
    options: RadiusOptions
) -> &mut Self where
    K: ToRedisArgs,
    M: ToRedisArgs, 

Retrieve members selected by distance with the center of member. The member itself is always contained in the results.

Loading content...

Implementations on Foreign Types

impl PipelineCommands for Pipeline

pub fn perform(&mut self, cmd: Cmd) -> &mut Pipeline

Loading content...

Implementors

Loading content...