[][src]Trait redis::Commands

pub trait Commands: ConnectionLike + Sized {
    pub fn get<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn keys<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn set<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn set_multiple<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        items: &'a [(K, V)]
    ) -> RedisResult<RV> { ... }
pub fn set_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V,
        seconds: usize
    ) -> RedisResult<RV> { ... }
pub fn pset_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V,
        milliseconds: usize
    ) -> RedisResult<RV> { ... }
pub fn set_nx<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn mset_nx<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        items: &'a [(K, V)]
    ) -> RedisResult<RV> { ... }
pub fn getset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn getrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        from: isize,
        to: isize
    ) -> RedisResult<RV> { ... }
pub fn setrange<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        offset: isize,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn del<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn exists<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn expire<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        seconds: usize
    ) -> RedisResult<RV> { ... }
pub fn expire_at<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        ts: usize
    ) -> RedisResult<RV> { ... }
pub fn pexpire<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        ms: usize
    ) -> RedisResult<RV> { ... }
pub fn pexpire_at<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        ts: usize
    ) -> RedisResult<RV> { ... }
pub fn persist<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn ttl<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn pttl<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn rename<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        new_key: K
    ) -> RedisResult<RV> { ... }
pub fn rename_nx<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        new_key: K
    ) -> RedisResult<RV> { ... }
pub fn unlink<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn append<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn incr<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        delta: V
    ) -> RedisResult<RV> { ... }
pub fn decr<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        delta: V
    ) -> RedisResult<RV> { ... }
pub fn setbit<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        offset: usize,
        value: bool
    ) -> RedisResult<RV> { ... }
pub fn getbit<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        offset: usize
    ) -> RedisResult<RV> { ... }
pub fn bitcount<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn bitcount_range<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: usize,
        end: usize
    ) -> RedisResult<RV> { ... }
pub fn bit_and<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        srckeys: K
    ) -> RedisResult<RV> { ... }
pub fn bit_or<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        srckeys: K
    ) -> RedisResult<RV> { ... }
pub fn bit_xor<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        srckeys: K
    ) -> RedisResult<RV> { ... }
pub fn bit_not<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        srckey: K
    ) -> RedisResult<RV> { ... }
pub fn strlen<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn hget<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        field: F
    ) -> RedisResult<RV> { ... }
pub fn hdel<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        field: F
    ) -> RedisResult<RV> { ... }
pub fn hset<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        field: F,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn hset_nx<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        field: F,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn hset_multiple<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        items: &'a [(F, V)]
    ) -> RedisResult<RV> { ... }
pub fn hincr<'a, K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        field: F,
        delta: D
    ) -> RedisResult<RV> { ... }
pub fn hexists<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        field: F
    ) -> RedisResult<RV> { ... }
pub fn hkeys<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn hvals<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn hgetall<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn hlen<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn blpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        timeout: usize
    ) -> RedisResult<RV> { ... }
pub fn brpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        timeout: usize
    ) -> RedisResult<RV> { ... }
pub fn brpoplpush<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        srckey: K,
        dstkey: K,
        timeout: usize
    ) -> RedisResult<RV> { ... }
pub fn lindex<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        index: isize
    ) -> RedisResult<RV> { ... }
pub fn linsert_before<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        pivot: P,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn linsert_after<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        pivot: P,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn llen<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn lpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn lpos<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V,
        options: LposOptions
    ) -> RedisResult<RV> { ... }
pub fn lpush<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn lpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn lrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn lrem<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        count: isize,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn ltrim<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn lset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        index: isize,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn rpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn rpoplpush<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        dstkey: K
    ) -> RedisResult<RV> { ... }
pub fn rpush<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn rpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        value: V
    ) -> RedisResult<RV> { ... }
pub fn sadd<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn scard<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn sdiff<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        keys: K
    ) -> RedisResult<RV> { ... }
pub fn sdiffstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: K
    ) -> RedisResult<RV> { ... }
pub fn sinter<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        keys: K
    ) -> RedisResult<RV> { ... }
pub fn sinterstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: K
    ) -> RedisResult<RV> { ... }
pub fn sismember<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn smembers<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn smove<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        srckey: K,
        dstkey: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn spop<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn srandmember<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn srandmember_multiple<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        count: usize
    ) -> RedisResult<RV> { ... }
pub fn srem<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn sunion<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        keys: K
    ) -> RedisResult<RV> { ... }
pub fn sunionstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: K
    ) -> RedisResult<RV> { ... }
pub fn zadd<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M,
        score: S
    ) -> RedisResult<RV> { ... }
pub fn zadd_multiple<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        items: &'a [(S, M)]
    ) -> RedisResult<RV> { ... }
pub fn zcard<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn zcount<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM
    ) -> RedisResult<RV> { ... }
pub fn zincr<'a, K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M,
        delta: D
    ) -> RedisResult<RV> { ... }
pub fn zinterstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn zinterstore_min<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn zinterstore_max<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn zlexcount<'a, K: ToRedisArgs, L: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: L,
        max: L
    ) -> RedisResult<RV> { ... }
pub fn zpopmax<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zpopmin<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn zrange_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn zrangebylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM
    ) -> RedisResult<RV> { ... }
pub fn zrangebylex_limit<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM,
        offset: isize,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrevrangebylex<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        max: MM,
        min: M
    ) -> RedisResult<RV> { ... }
pub fn zrevrangebylex_limit<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        max: MM,
        min: M,
        offset: isize,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrangebyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM
    ) -> RedisResult<RV> { ... }
pub fn zrangebyscore_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM
    ) -> RedisResult<RV> { ... }
pub fn zrangebyscore_limit<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM,
        offset: isize,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrangebyscore_limit_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM,
        offset: isize,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrank<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn zrem<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        members: M
    ) -> RedisResult<RV> { ... }
pub fn zrembylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM
    ) -> RedisResult<RV> { ... }
pub fn zremrangebyrank<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn zrembyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        min: M,
        max: MM
    ) -> RedisResult<RV> { ... }
pub fn zrevrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn zrevrange_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: isize,
        stop: isize
    ) -> RedisResult<RV> { ... }
pub fn zrevrangebyscore<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        max: MM,
        min: M
    ) -> RedisResult<RV> { ... }
pub fn zrevrangebyscore_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        max: MM,
        min: M
    ) -> RedisResult<RV> { ... }
pub fn zrevrangebyscore_limit<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        max: MM,
        min: M,
        offset: isize,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrevrangebyscore_limit_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        max: MM,
        min: M,
        offset: isize,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn zrevrank<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn zscore<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M
    ) -> RedisResult<RV> { ... }
pub fn zunionstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn zunionstore_min<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn zunionstore_max<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        keys: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn pfadd<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        element: E
    ) -> RedisResult<RV> { ... }
pub fn pfcount<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn pfmerge<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        dstkey: K,
        srckeys: K
    ) -> RedisResult<RV> { ... }
pub fn publish<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        channel: K,
        message: E
    ) -> RedisResult<RV> { ... }
pub fn acl_load<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_save<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_list<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_users<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_getuser<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        username: K
    ) -> RedisResult<RV> { ... }
pub fn acl_setuser<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        username: K
    ) -> RedisResult<RV> { ... }
pub fn acl_setuser_rules<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        username: K,
        rules: &'a [Rule]
    ) -> RedisResult<RV> { ... }
pub fn acl_deluser<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        usernames: &'a [K]
    ) -> RedisResult<RV> { ... }
pub fn acl_cat<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_cat_categoryname<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        categoryname: K
    ) -> RedisResult<RV> { ... }
pub fn acl_genpass<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_genpass_bits<'a, RV: FromRedisValue>(
        &mut self,
        bits: isize
    ) -> RedisResult<RV> { ... }
pub fn acl_whoami<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_log<'a, RV: FromRedisValue>(
        &mut self,
        count: isize
    ) -> RedisResult<RV> { ... }
pub fn acl_log_reset<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn acl_help<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... }
pub fn geo_add<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        members: M
    ) -> RedisResult<RV> { ... }
pub fn geo_dist<'a, K: ToRedisArgs, M1: ToRedisArgs, M2: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member1: M1,
        member2: M2,
        unit: Unit
    ) -> RedisResult<RV> { ... }
pub fn geo_hash<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        members: M
    ) -> RedisResult<RV> { ... }
pub fn geo_pos<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        members: M
    ) -> RedisResult<RV> { ... }
pub fn geo_radius<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        longitude: f64,
        latitude: f64,
        radius: f64,
        unit: Unit,
        options: RadiusOptions
    ) -> RedisResult<RV> { ... }
pub fn geo_radius_by_member<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        member: M,
        radius: f64,
        unit: Unit,
        options: RadiusOptions
    ) -> RedisResult<RV> { ... }
pub fn xack<'a, K: ToRedisArgs, G: ToRedisArgs, I: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        ids: &'a [I]
    ) -> RedisResult<RV> { ... }
pub fn xadd<'a, K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        id: ID,
        items: &'a [(F, V)]
    ) -> RedisResult<RV> { ... }
pub fn xadd_map<'a, K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        id: ID,
        map: BTM
    ) -> RedisResult<RV> { ... }
pub fn xadd_maxlen<'a, K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        maxlen: StreamMaxlen,
        id: ID,
        items: &'a [(F, V)]
    ) -> RedisResult<RV> { ... }
pub fn xadd_maxlen_map<'a, K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        maxlen: StreamMaxlen,
        id: ID,
        map: BTM
    ) -> RedisResult<RV> { ... }
pub fn xclaim<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        consumer: C,
        min_idle_time: MIT,
        ids: &'a [ID]
    ) -> RedisResult<RV> { ... }
pub fn xclaim_options<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        consumer: C,
        min_idle_time: MIT,
        ids: &'a [ID],
        options: StreamClaimOptions
    ) -> RedisResult<RV> { ... }
pub fn xdel<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        ids: &'a [ID]
    ) -> RedisResult<RV> { ... }
pub fn xgroup_create<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        id: ID
    ) -> RedisResult<RV> { ... }
pub fn xgroup_create_mkstream<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        id: ID
    ) -> RedisResult<RV> { ... }
pub fn xgroup_setid<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        id: ID
    ) -> RedisResult<RV> { ... }
pub fn xgroup_destroy<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G
    ) -> RedisResult<RV> { ... }
pub fn xgroup_delconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        consumer: C
    ) -> RedisResult<RV> { ... }
pub fn xinfo_consumers<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G
    ) -> RedisResult<RV> { ... }
pub fn xinfo_groups<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn xinfo_stream<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn xlen<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn xpending<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G
    ) -> RedisResult<RV> { ... }
pub fn xpending_count<'a, K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        start: S,
        end: E,
        count: C
    ) -> RedisResult<RV> { ... }
pub fn xpending_consumer_count<'a, K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, CN: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        group: G,
        start: S,
        end: E,
        count: C,
        consumer: CN
    ) -> RedisResult<RV> { ... }
pub fn xrange<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: S,
        end: E
    ) -> RedisResult<RV> { ... }
pub fn xrange_all<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn xrange_count<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        start: S,
        end: E,
        count: C
    ) -> RedisResult<RV> { ... }
pub fn xread<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        keys: &'a [K],
        ids: &'a [ID]
    ) -> RedisResult<RV> { ... }
pub fn xread_options<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        keys: &'a [K],
        ids: &'a [ID],
        options: StreamReadOptions
    ) -> RedisResult<RV> { ... }
pub fn xrevrange<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        end: E,
        start: S
    ) -> RedisResult<RV> { ... }
pub fn xrevrange_all<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<RV> { ... }
pub fn xrevrange_count<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        end: E,
        start: S,
        count: C
    ) -> RedisResult<RV> { ... }
pub fn xtrim<'a, K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        maxlen: StreamMaxlen
    ) -> RedisResult<RV> { ... }
pub fn scan<RV: FromRedisValue>(&mut self) -> RedisResult<Iter<'_, RV>> { ... }
pub fn scan_match<P: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        pattern: P
    ) -> RedisResult<Iter<'_, RV>> { ... }
pub fn hscan<K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<Iter<'_, RV>> { ... }
pub fn hscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        pattern: P
    ) -> RedisResult<Iter<'_, RV>> { ... }
pub fn sscan<K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<Iter<'_, RV>> { ... }
pub fn sscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        pattern: P
    ) -> RedisResult<Iter<'_, RV>> { ... }
pub fn zscan<K: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K
    ) -> RedisResult<Iter<'_, RV>> { ... }
pub fn zscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>(
        &mut self,
        key: K,
        pattern: P
    ) -> RedisResult<Iter<'_, RV>> { ... } }

Implements common redis commands for connection like objects. This allows you to send commands straight to a connection or client. It is also implemented for redis results of clients which makes for very convenient access in some basic cases.

This allows you to use nicer syntax for some common operations. For instance this code:

let client = redis::Client::open("redis://127.0.0.1/")?;
let mut con = client.get_connection()?;
redis::cmd("SET").arg("my_key").arg(42).execute(&mut con);
assert_eq!(redis::cmd("GET").arg("my_key").query(&mut con), Ok(42));

Will become this:

use redis::Commands;
let client = redis::Client::open("redis://127.0.0.1/")?;
let mut con = client.get_connection()?;
con.set("my_key", 42)?;
assert_eq!(con.get("my_key"), Ok(42));

Provided methods

pub fn get<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

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

pub fn keys<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Gets all keys matching pattern

pub fn set<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

Set the string value of a key.

pub fn set_multiple<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    items: &'a [(K, V)]
) -> RedisResult<RV>
[src]

Sets multiple keys to their values.

pub fn set_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V,
    seconds: usize
) -> RedisResult<RV>
[src]

Set the value and expiration of a key.

pub fn pset_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V,
    milliseconds: usize
) -> RedisResult<RV>
[src]

Set the value and expiration in milliseconds of a key.

pub fn set_nx<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn mset_nx<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    items: &'a [(K, V)]
) -> RedisResult<RV>
[src]

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

pub fn getset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn getrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    from: isize,
    to: isize
) -> RedisResult<RV>
[src]

Get a range of bytes/substring from the value of a key. Negative values provide an offset from the end of the value.

pub fn setrange<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    offset: isize,
    value: V
) -> RedisResult<RV>
[src]

Overwrite the part of the value stored in key at the specified offset.

pub fn del<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Delete one or more keys.

pub fn exists<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Determine if a key exists.

pub fn expire<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    seconds: usize
) -> RedisResult<RV>
[src]

Set a key's time to live in seconds.

pub fn expire_at<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    ts: usize
) -> RedisResult<RV>
[src]

Set the expiration for a key as a UNIX timestamp.

pub fn pexpire<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    ms: usize
) -> RedisResult<RV>
[src]

Set a key's time to live in milliseconds.

pub fn pexpire_at<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    ts: usize
) -> RedisResult<RV>
[src]

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

pub fn persist<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Remove the expiration from a key.

pub fn ttl<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get the expiration time of a key.

pub fn pttl<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get the expiration time of a key in milliseconds.

pub fn rename<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    new_key: K
) -> RedisResult<RV>
[src]

Rename a key.

pub fn rename_nx<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    new_key: K
) -> RedisResult<RV>
[src]

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

Unlink one or more keys.

pub fn append<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

Append a value to a key.

pub fn incr<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    delta: V
) -> RedisResult<RV>
[src]

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

pub fn decr<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    delta: V
) -> RedisResult<RV>
[src]

Decrement the numeric value of a key by the given amount.

pub fn setbit<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    offset: usize,
    value: bool
) -> RedisResult<RV>
[src]

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

pub fn getbit<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    offset: usize
) -> RedisResult<RV>
[src]

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

pub fn bitcount<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Count set bits in a string.

pub fn bitcount_range<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: usize,
    end: usize
) -> RedisResult<RV>
[src]

Count set bits in a string in a range.

pub fn bit_and<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    srckeys: K
) -> RedisResult<RV>
[src]

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

pub fn bit_or<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    srckeys: K
) -> RedisResult<RV>
[src]

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

pub fn bit_xor<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    srckeys: K
) -> RedisResult<RV>
[src]

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

pub fn bit_not<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    srckey: K
) -> RedisResult<RV>
[src]

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

pub fn strlen<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get the length of the value stored in a key.

pub fn hget<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    field: F
) -> RedisResult<RV>
[src]

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

pub fn hdel<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    field: F
) -> RedisResult<RV>
[src]

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

pub fn hset<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    field: F,
    value: V
) -> RedisResult<RV>
[src]

Sets a single field in a hash.

pub fn hset_nx<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    field: F,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn hset_multiple<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    items: &'a [(F, V)]
) -> RedisResult<RV>
[src]

Sets a multiple fields in a hash.

pub fn hincr<'a, K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    field: F,
    delta: D
) -> RedisResult<RV>
[src]

Increments a value.

pub fn hexists<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    field: F
) -> RedisResult<RV>
[src]

Checks if a field in a hash exists.

pub fn hkeys<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Gets all the keys in a hash.

pub fn hvals<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Gets all the values in a hash.

pub fn hgetall<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Gets all the fields and values in a hash.

pub fn hlen<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Gets the length of a hash.

pub fn blpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    timeout: usize
) -> RedisResult<RV>
[src]

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

pub fn brpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    timeout: usize
) -> RedisResult<RV>
[src]

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

pub fn brpoplpush<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    srckey: K,
    dstkey: K,
    timeout: usize
) -> RedisResult<RV>
[src]

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

pub fn lindex<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    index: isize
) -> RedisResult<RV>
[src]

Get an element from a list by its index.

pub fn linsert_before<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    pivot: P,
    value: V
) -> RedisResult<RV>
[src]

Insert an element before another element in a list.

pub fn linsert_after<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    pivot: P,
    value: V
) -> RedisResult<RV>
[src]

Insert an element after another element in a list.

pub fn llen<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Returns the length of the list stored at key.

pub fn lpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

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

pub fn lpos<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V,
    options: LposOptions
) -> RedisResult<RV>
[src]

Returns the index of the first matching value of the list stored at key.

pub fn lpush<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn lpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn lrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

Returns the specified elements of the list stored at key.

pub fn lrem<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    count: isize,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn ltrim<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

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

pub fn lset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    index: isize,
    value: V
) -> RedisResult<RV>
[src]

Sets the list element at index to value

pub fn rpop<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

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

pub fn rpoplpush<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    dstkey: K
) -> RedisResult<RV>
[src]

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

pub fn rpush<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn rpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    value: V
) -> RedisResult<RV>
[src]

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

pub fn sadd<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M
) -> RedisResult<RV>
[src]

Add one or more members to a set.

pub fn scard<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get the number of members in a set.

pub fn sdiff<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    keys: K
) -> RedisResult<RV>
[src]

Subtract multiple sets.

pub fn sdiffstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: K
) -> RedisResult<RV>
[src]

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

pub fn sinter<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    keys: K
) -> RedisResult<RV>
[src]

Intersect multiple sets.

pub fn sinterstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: K
) -> RedisResult<RV>
[src]

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

pub fn sismember<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M
) -> RedisResult<RV>
[src]

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

pub fn smembers<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get all the members in a set.

pub fn smove<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    srckey: K,
    dstkey: K,
    member: M
) -> RedisResult<RV>
[src]

Move a member from one set to another.

pub fn spop<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Remove and return a random member from a set.

pub fn srandmember<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get one random member from a set.

pub fn srandmember_multiple<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    count: usize
) -> RedisResult<RV>
[src]

Get multiple random members from a set.

pub fn srem<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M
) -> RedisResult<RV>
[src]

Remove one or more members from a set.

pub fn sunion<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    keys: K
) -> RedisResult<RV>
[src]

Add multiple sets.

pub fn sunionstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: K
) -> RedisResult<RV>
[src]

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

pub fn zadd<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M,
    score: S
) -> RedisResult<RV>
[src]

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

pub fn zadd_multiple<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    items: &'a [(S, M)]
) -> RedisResult<RV>
[src]

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

pub fn zcard<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

Get the number of members in a sorted set.

pub fn zcount<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> RedisResult<RV>
[src]

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

pub fn zincr<'a, K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M,
    delta: D
) -> RedisResult<RV>
[src]

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<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: &'a [K]
) -> RedisResult<RV>
[src]

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

pub fn zinterstore_min<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: &'a [K]
) -> RedisResult<RV>
[src]

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

pub fn zinterstore_max<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: &'a [K]
) -> RedisResult<RV>
[src]

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

pub fn zlexcount<'a, K: ToRedisArgs, L: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: L,
    max: L
) -> RedisResult<RV>
[src]

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

pub fn zpopmax<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    count: isize
) -> RedisResult<RV>
[src]

Removes and returns up to count members with the highest scores in a sorted set

pub fn zpopmin<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    count: isize
) -> RedisResult<RV>
[src]

Removes and returns up to count members with the lowest scores in a sorted set

pub fn zrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

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

pub fn zrange_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

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

pub fn zrangebylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> RedisResult<RV>
[src]

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

pub fn zrangebylex_limit<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM,
    offset: isize,
    count: isize
) -> RedisResult<RV>
[src]

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

pub fn zrevrangebylex<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    max: MM,
    min: M
) -> RedisResult<RV>
[src]

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

pub fn zrevrangebylex_limit<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    max: MM,
    min: M,
    offset: isize,
    count: isize
) -> RedisResult<RV>
[src]

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

pub fn zrangebyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> RedisResult<RV>
[src]

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

pub fn zrangebyscore_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> RedisResult<RV>
[src]

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

pub fn zrangebyscore_limit<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM,
    offset: isize,
    count: isize
) -> RedisResult<RV>
[src]

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

pub fn zrangebyscore_limit_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM,
    offset: isize,
    count: isize
) -> RedisResult<RV>
[src]

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

pub fn zrank<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M
) -> RedisResult<RV>
[src]

Determine the index of a member in a sorted set.

pub fn zrem<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    members: M
) -> RedisResult<RV>
[src]

Remove one or more members from a sorted set.

pub fn zrembylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> RedisResult<RV>
[src]

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

pub fn zremrangebyrank<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

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

pub fn zrembyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    min: M,
    max: MM
) -> RedisResult<RV>
[src]

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

pub fn zrevrange<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

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

pub fn zrevrange_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: isize,
    stop: isize
) -> RedisResult<RV>
[src]

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

pub fn zrevrangebyscore<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    max: MM,
    min: M
) -> RedisResult<RV>
[src]

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

pub fn zrevrangebyscore_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    max: MM,
    min: M
) -> RedisResult<RV>
[src]

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

pub fn zrevrangebyscore_limit<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    max: MM,
    min: M,
    offset: isize,
    count: isize
) -> RedisResult<RV>
[src]

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

pub fn zrevrangebyscore_limit_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    max: MM,
    min: M,
    offset: isize,
    count: isize
) -> RedisResult<RV>
[src]

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

pub fn zrevrank<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M
) -> RedisResult<RV>
[src]

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

pub fn zscore<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M
) -> RedisResult<RV>
[src]

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

pub fn zunionstore<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: &'a [K]
) -> RedisResult<RV>
[src]

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

pub fn zunionstore_min<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: &'a [K]
) -> RedisResult<RV>
[src]

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

pub fn zunionstore_max<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    keys: &'a [K]
) -> RedisResult<RV>
[src]

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

pub fn pfadd<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    element: E
) -> RedisResult<RV>
[src]

Adds the specified elements to the specified HyperLogLog.

pub fn pfcount<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

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

pub fn pfmerge<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    dstkey: K,
    srckeys: K
) -> RedisResult<RV>
[src]

Merge N different HyperLogLogs into a single one.

pub fn publish<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    channel: K,
    message: E
) -> RedisResult<RV>
[src]

Posts a message to the given channel.

pub fn acl_load<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file.

pub fn acl_save<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file.

pub fn acl_list<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Shows the currently active ACL rules in the Redis server.

pub fn acl_users<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Shows a list of all the usernames of the currently configured users in the Redis ACL system.

pub fn acl_getuser<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    username: K
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Returns all the rules defined for an existing ACL user.

pub fn acl_setuser<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    username: K
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Creates an ACL user without any privilege.

pub fn acl_setuser_rules<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    username: K,
    rules: &'a [Rule]
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Creates an ACL user with the specified rules or modify the rules of an existing user.

pub fn acl_deluser<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    usernames: &'a [K]
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Delete all the specified ACL users and terminate all the connections that are authenticated with such users.

pub fn acl_cat<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Shows the available ACL categories.

pub fn acl_cat_categoryname<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    categoryname: K
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Shows all the Redis commands in the specified category.

pub fn acl_genpass<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Generates a 256-bits password starting from /dev/urandom if available.

pub fn acl_genpass_bits<'a, RV: FromRedisValue>(
    &mut self,
    bits: isize
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Generates a 1-to-1024-bits password starting from /dev/urandom if available.

pub fn acl_whoami<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Returns the username the current connection is authenticated with.

pub fn acl_log<'a, RV: FromRedisValue>(
    &mut self,
    count: isize
) -> RedisResult<RV>
[src]

This is supported on crate feature acl only.

Shows a list of recent ACL security events

pub fn acl_log_reset<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Clears the ACL log.

pub fn acl_help<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>[src]

This is supported on crate feature acl only.

Returns a helpful text describing the different subcommands.

pub fn geo_add<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    members: M
) -> RedisResult<RV>
[src]

This is supported on crate feature geospatial only.

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<'a, K: ToRedisArgs, M1: ToRedisArgs, M2: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member1: M1,
    member2: M2,
    unit: Unit
) -> RedisResult<RV>
[src]

This is supported on crate feature geospatial only.

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<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    members: M
) -> RedisResult<RV>
[src]

This is supported on crate feature geospatial only.

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<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    members: M
) -> RedisResult<RV>
[src]

This is supported on crate feature geospatial only.

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<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    longitude: f64,
    latitude: f64,
    radius: f64,
    unit: Unit,
    options: RadiusOptions
) -> RedisResult<RV>
[src]

This is supported on crate feature geospatial only.

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<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    member: M,
    radius: f64,
    unit: Unit,
    options: RadiusOptions
) -> RedisResult<RV>
[src]

This is supported on crate feature geospatial only.

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

pub fn xack<'a, K: ToRedisArgs, G: ToRedisArgs, I: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    ids: &'a [I]
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Ack pending stream messages checked out by a consumer.

XACK <key> <group> <id> <id> ... <id>

pub fn xadd<'a, K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    id: ID,
    items: &'a [(F, V)]
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Add a stream message by key. Use * as the id for the current timestamp.

XADD key <ID or *> [field value] [field value] ...

pub fn xadd_map<'a, K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    id: ID,
    map: BTM
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

BTreeMap variant for adding a stream message by key. Use * as the id for the current timestamp.

XADD key <ID or *> [rust BTreeMap] ...

pub fn xadd_maxlen<'a, K: ToRedisArgs, ID: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    maxlen: StreamMaxlen,
    id: ID,
    items: &'a [(F, V)]
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Add a stream message while capping the stream at a maxlength.

XADD key [MAXLEN [~|=] <count>] <ID or *> [field value] [field value] ...

pub fn xadd_maxlen_map<'a, K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    maxlen: StreamMaxlen,
    id: ID,
    map: BTM
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

BTreeMap variant for adding a stream message while capping the stream at a maxlength.

XADD key [MAXLEN [~|=] <count>] <ID or *> [rust BTreeMap] ...

pub fn xclaim<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    consumer: C,
    min_idle_time: MIT,
    ids: &'a [ID]
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Claim pending, unacked messages, after some period of time, currently checked out by another consumer.

This method only accepts the must-have arguments for claiming messages. If optional arguments are required, see xclaim_options below.

XCLAIM <key> <group> <consumer> <min-idle-time> [<ID-1> <ID-2>]

pub fn xclaim_options<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    consumer: C,
    min_idle_time: MIT,
    ids: &'a [ID],
    options: StreamClaimOptions
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This is the optional arguments version for claiming unacked, pending messages currently checked out by another consumer.

use redis::{Connection,Commands,RedisResult};
use redis::streams::{StreamClaimOptions,StreamClaimReply};
let client = redis::Client::open("redis://127.0.0.1/0").unwrap();
let mut con = client.get_connection().unwrap();

// Claim all pending messages for key "k1",
// from group "g1", checked out by consumer "c1"
// for 10ms with RETRYCOUNT 2 and FORCE

let opts = StreamClaimOptions::default()
    .with_force()
    .retry(2);
let results: RedisResult<StreamClaimReply> =
    con.xclaim_options("k1", "g1", "c1", 10, &["0"], opts);

// All optional arguments return a `Result<StreamClaimReply>` with one exception:
// Passing JUSTID returns only the message `id` and omits the HashMap for each message.

let opts = StreamClaimOptions::default()
    .with_justid();
let results: RedisResult<Vec<String>> =
    con.xclaim_options("k1", "g1", "c1", 10, &["0"], opts);
XCLAIM <key> <group> <consumer> <min-idle-time> <ID-1> <ID-2>
    [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>]
    [FORCE] [JUSTID]

pub fn xdel<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    ids: &'a [ID]
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Deletes a list of ids for a given stream key.

XDEL <key> [<ID1> <ID2> ... <IDN>]

pub fn xgroup_create<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    id: ID
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This command is used for creating a consumer group. It expects the stream key to already exist. Otherwise, use xgroup_create_mkstream if it doesn't. The id is the starting message id all consumers should read from. Use $ If you want all consumers to read from the last message added to stream.

XGROUP CREATE <key> <groupname> <id or $>

pub fn xgroup_create_mkstream<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    id: ID
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This is the alternate version for creating a consumer group which makes the stream if it doesn't exist.

XGROUP CREATE <key> <groupname> <id or $> [MKSTREAM]

pub fn xgroup_setid<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    id: ID
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Alter which id you want consumers to begin reading from an existing consumer group.

XGROUP SETID <key> <groupname> <id or $>

pub fn xgroup_destroy<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Destroy an existing consumer group for a given stream key

XGROUP SETID <key> <groupname> <id or $>

pub fn xgroup_delconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    consumer: C
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This deletes a consumer from an existing consumer group for given stream `key.

XGROUP DELCONSUMER <key> <groupname> <consumername>

pub fn xinfo_consumers<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This returns all info details about which consumers have read messages for given consumer group. Take note of the StreamInfoConsumersReply return type.

It's possible this return value might not contain new fields added by Redis in future versions.

XINFO CONSUMERS <key> <group>

pub fn xinfo_groups<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Returns all consumer groups created for a given stream key. Take note of the StreamInfoGroupsReply return type.

It's possible this return value might not contain new fields added by Redis in future versions.

XINFO GROUPS <key>

pub fn xinfo_stream<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Returns info about high-level stream details (first & last message id, length, number of groups, etc.) Take note of the StreamInfoStreamReply return type.

It's possible this return value might not contain new fields added by Redis in future versions.

XINFO STREAM <key>

pub fn xlen<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Returns the number of messages for a given stream key.

XLEN <key>

pub fn xpending<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This is a basic version of making XPENDING command calls which only passes a stream key and consumer group and it returns details about which consumers have pending messages that haven't been acked.

You can use this method along with xclaim or xclaim_options for determining which messages need to be retried.

Take note of the StreamPendingReply return type.

XPENDING <key> <group> [<start> <stop> <count> [<consumer>]]

pub fn xpending_count<'a, K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    start: S,
    end: E,
    count: C
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This XPENDING version returns a list of all messages over the range. You can use this for paginating pending messages (but without the message HashMap).

Start and end follow the same rules xrange args. Set start to - and end to + for the entire stream.

Take note of the StreamPendingCountReply return type.

XPENDING <key> <group> <start> <stop> <count>

pub fn xpending_consumer_count<'a, K: ToRedisArgs, G: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, CN: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    group: G,
    start: S,
    end: E,
    count: C,
    consumer: CN
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

An alternate version of xpending_count which filters by consumer name.

Start and end follow the same rules xrange args. Set start to - and end to + for the entire stream.

Take note of the StreamPendingCountReply return type.

XPENDING <key> <group> <start> <stop> <count> <consumer>

pub fn xrange<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: S,
    end: E
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Returns a range of messages in a given stream key.

Set start to - to begin at the first message. Set end to + to end the most recent message. You can pass message id to both start and end.

Take note of the StreamRangeReply return type.

XRANGE key start end

pub fn xrange_all<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

A helper method for automatically returning all messages in a stream by key. Use with caution!

XRANGE key - +

pub fn xrange_count<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    start: S,
    end: E,
    count: C
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

A method for paginating a stream by key.

XRANGE key start end [COUNT <n>]

pub fn xread<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    keys: &'a [K],
    ids: &'a [ID]
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Read a list of ids for each stream key. This is the basic form of reading streams. For more advanced control, like blocking, limiting, or reading by consumer group, see xread_options.

XREAD STREAMS key_1 key_2 ... key_N ID_1 ID_2 ... ID_N

pub fn xread_options<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    keys: &'a [K],
    ids: &'a [ID],
    options: StreamReadOptions
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This method handles setting optional arguments for XREAD or XREADGROUP Redis commands.

use redis::{Connection,RedisResult,Commands};
use redis::streams::{StreamReadOptions,StreamReadReply};
let client = redis::Client::open("redis://127.0.0.1/0").unwrap();
let mut con = client.get_connection().unwrap();

// Read 10 messages from the start of the stream,
// without registering as a consumer group.

let opts = StreamReadOptions::default()
    .count(10);
let results: RedisResult<StreamReadReply> =
    con.xread_options(&["k1"], &["0"], opts);

// Read all undelivered messages for a given
// consumer group. Be advised: the consumer group must already
// exist before making this call. Also note: we're passing
// '>' as the id here, which means all undelivered messages.

let opts = StreamReadOptions::default()
    .group("group-1", "consumer-1");
let results: RedisResult<StreamReadReply> =
    con.xread_options(&["k1"], &[">"], opts);
XREAD [BLOCK <milliseconds>] [COUNT <count>]
    STREAMS key_1 key_2 ... key_N
    ID_1 ID_2 ... ID_N

XREADGROUP [BLOCK <milliseconds>] [COUNT <count>] [NOACK] [GROUP group-name consumer-name]
    STREAMS key_1 key_2 ... key_N
    ID_1 ID_2 ... ID_N

pub fn xrevrange<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    end: E,
    start: S
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This is the reverse version of xrange. The same rules apply for start and end here.

XREVRANGE key end start

pub fn xrevrange_all<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<RV>
[src]

This is the reverse version of xrange_all. The same rules apply for start and end here.

XREVRANGE key + -

pub fn xrevrange_count<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    end: E,
    start: S,
    count: C
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

This is the reverse version of xrange_count. The same rules apply for start and end here.

XREVRANGE key end start [COUNT <n>]

pub fn xtrim<'a, K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    maxlen: StreamMaxlen
) -> RedisResult<RV>
[src]

This is supported on crate feature streams only.

Trim a stream key to a MAXLEN count.

XTRIM <key> MAXLEN [~|=] <count>  (Same as XADD MAXLEN option)

pub fn scan<RV: FromRedisValue>(&mut self) -> RedisResult<Iter<'_, RV>>[src]

Incrementally iterate the keys space.

pub fn scan_match<P: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    pattern: P
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate the keys space for keys matching a pattern.

pub fn hscan<K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate hash fields and associated values.

pub fn hscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    pattern: P
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate hash fields and associated values for field names matching a pattern.

pub fn sscan<K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate set elements.

pub fn sscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    pattern: P
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate set elements for elements matching a pattern.

pub fn zscan<K: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate sorted set elements.

pub fn zscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>(
    &mut self,
    key: K,
    pattern: P
) -> RedisResult<Iter<'_, RV>>
[src]

Incrementally iterate sorted set elements for elements matching a pattern.

Loading content...

Implementors

impl<T> Commands for T where
    T: ConnectionLike
[src]

Loading content...