Trait Commands

Source
pub trait Commands: ConnectionLike + Sized {
Show 242 methods // Provided methods fn get<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn mget<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn keys<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn set<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn set_options<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, options: SetOptions, ) -> RedisResult<RV> { ... } fn set_multiple<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, items: &'a [(K, V)], ) -> RedisResult<RV> { ... } fn mset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, items: &'a [(K, V)], ) -> RedisResult<RV> { ... } fn set_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, seconds: u64, ) -> RedisResult<RV> { ... } fn pset_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, milliseconds: u64, ) -> RedisResult<RV> { ... } fn set_nx<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn mset_nx<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, items: &'a [(K, V)], ) -> RedisResult<RV> { ... } fn getset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn getrange<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, from: isize, to: isize, ) -> RedisResult<RV> { ... } fn setrange<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, offset: isize, value: V, ) -> RedisResult<RV> { ... } fn del<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn exists<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn key_type<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn expire<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, seconds: i64, ) -> RedisResult<RV> { ... } fn expire_at<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, ) -> RedisResult<RV> { ... } fn pexpire<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ms: i64, ) -> RedisResult<RV> { ... } fn pexpire_at<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, ) -> RedisResult<RV> { ... } fn expire_time<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn pexpire_time<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn persist<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn ttl<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn pttl<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn get_ex<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, expire_at: Expiry, ) -> RedisResult<RV> { ... } fn get_del<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn copy<'a, KSrc: ToRedisArgs, KDst: ToRedisArgs, Db: ToString, RV: FromRedisValue>( &mut self, source: KSrc, destination: KDst, options: CopyOptions<Db>, ) -> RedisResult<RV> { ... } fn rename<'a, K: ToRedisArgs, N: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, new_key: N, ) -> RedisResult<RV> { ... } fn rename_nx<'a, K: ToRedisArgs, N: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, new_key: N, ) -> RedisResult<RV> { ... } fn unlink<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn append<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn incr<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, delta: V, ) -> RedisResult<RV> { ... } fn decr<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, delta: V, ) -> RedisResult<RV> { ... } fn setbit<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, offset: usize, value: bool, ) -> RedisResult<RV> { ... } fn getbit<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, offset: usize, ) -> RedisResult<RV> { ... } fn bitcount<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn bitcount_range<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: usize, end: usize, ) -> RedisResult<RV> { ... } fn bit_and<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV> { ... } fn bit_or<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV> { ... } fn bit_xor<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV> { ... } fn bit_not<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckey: S, ) -> RedisResult<RV> { ... } fn strlen<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn hget<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, field: F, ) -> RedisResult<RV> { ... } fn hget_ex<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, expire_at: Expiry, ) -> RedisResult<RV> { ... } fn hdel<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, field: F, ) -> RedisResult<RV> { ... } fn hget_del<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV> { ... } fn hset<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, field: F, value: V, ) -> RedisResult<RV> { ... } fn hset_ex<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, hash_field_expiration_options: &'a HashFieldExpirationOptions, fields_values: &'a [(F, V)], ) -> RedisResult<RV> { ... } fn hset_nx<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, field: F, value: V, ) -> RedisResult<RV> { ... } fn hset_multiple<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, items: &'a [(F, V)], ) -> RedisResult<RV> { ... } fn hincr<'a, K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, field: F, delta: D, ) -> RedisResult<RV> { ... } fn hexists<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, field: F, ) -> RedisResult<RV> { ... } fn httl<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV> { ... } fn hpttl<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV> { ... } fn hexpire<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, seconds: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV> { ... } fn hexpire_at<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV> { ... } fn hexpire_time<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV> { ... } fn hpersist<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV> { ... } fn hpexpire<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, milliseconds: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV> { ... } fn hpexpire_at<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV> { ... } fn hpexpire_time<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV> { ... } fn hkeys<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn hvals<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn hgetall<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn hlen<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn blmove<'a, S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> RedisResult<RV> { ... } fn blmpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> RedisResult<RV> { ... } fn blpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV> { ... } fn brpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV> { ... } fn brpoplpush<'a, S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, timeout: f64, ) -> RedisResult<RV> { ... } fn lindex<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, index: isize, ) -> RedisResult<RV> { ... } fn linsert_before<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, pivot: P, value: V, ) -> RedisResult<RV> { ... } fn linsert_after<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, pivot: P, value: V, ) -> RedisResult<RV> { ... } fn llen<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn lmove<'a, S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> RedisResult<RV> { ... } fn lmpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, numkeys: usize, key: K, dir: Direction, count: usize, ) -> RedisResult<RV> { ... } fn lpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: Option<NonZeroUsize>, ) -> RedisResult<RV> { ... } fn lpos<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, options: LposOptions, ) -> RedisResult<RV> { ... } fn lpush<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn lpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn lrange<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn lrem<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: isize, value: V, ) -> RedisResult<RV> { ... } fn ltrim<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn lset<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, index: isize, value: V, ) -> RedisResult<RV> { ... } fn ping<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn ping_message<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, message: K, ) -> RedisResult<RV> { ... } fn rpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: Option<NonZeroUsize>, ) -> RedisResult<RV> { ... } fn rpoplpush<'a, K: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, dstkey: D, ) -> RedisResult<RV> { ... } fn rpush<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn rpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, ) -> RedisResult<RV> { ... } fn sadd<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, ) -> RedisResult<RV> { ... } fn scard<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn sdiff<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, ) -> RedisResult<RV> { ... } fn sdiffstore<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn sinter<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, ) -> RedisResult<RV> { ... } fn sinterstore<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn sismember<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, ) -> RedisResult<RV> { ... } fn smismember<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV> { ... } fn smembers<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn smove<'a, S: ToRedisArgs, D: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, member: M, ) -> RedisResult<RV> { ... } fn spop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn srandmember<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn srandmember_multiple<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: usize, ) -> RedisResult<RV> { ... } fn srem<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, ) -> RedisResult<RV> { ... } fn sunion<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, ) -> RedisResult<RV> { ... } fn sunionstore<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zadd<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, score: S, ) -> RedisResult<RV> { ... } fn zadd_multiple<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, items: &'a [(S, M)], ) -> RedisResult<RV> { ... } fn zcard<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn zcount<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } fn zincr<'a, K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, delta: D, ) -> RedisResult<RV> { ... } fn zinterstore<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zinterstore_min<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zinterstore_max<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zinterstore_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV> { ... } fn zinterstore_min_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV> { ... } fn zinterstore_max_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV> { ... } fn zlexcount<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } fn bzpopmax<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV> { ... } fn zpopmax<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: isize, ) -> RedisResult<RV> { ... } fn bzpopmin<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV> { ... } fn zpopmin<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: isize, ) -> RedisResult<RV> { ... } fn bzmpop_max<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, timeout: f64, keys: K, count: isize, ) -> RedisResult<RV> { ... } fn zmpop_max<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, count: isize, ) -> RedisResult<RV> { ... } fn bzmpop_min<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, timeout: f64, keys: K, count: isize, ) -> RedisResult<RV> { ... } fn zmpop_min<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, count: isize, ) -> RedisResult<RV> { ... } fn zrandmember<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: Option<isize>, ) -> RedisResult<RV> { ... } fn zrandmember_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: isize, ) -> RedisResult<RV> { ... } fn zrange<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn zrange_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn zrangebylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } 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> { ... } fn zrevrangebylex<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, max: MM, min: M, ) -> RedisResult<RV> { ... } 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> { ... } fn zrangebyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } fn zrangebyscore_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } 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> { ... } 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> { ... } fn zrank<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, ) -> RedisResult<RV> { ... } fn zrem<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV> { ... } fn zrembylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } fn zremrangebyrank<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn zrembyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV> { ... } fn zrevrange<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn zrevrange_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: isize, stop: isize, ) -> RedisResult<RV> { ... } fn zrevrangebyscore<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, max: MM, min: M, ) -> RedisResult<RV> { ... } fn zrevrangebyscore_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, max: MM, min: M, ) -> RedisResult<RV> { ... } 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> { ... } 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> { ... } fn zrevrank<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, ) -> RedisResult<RV> { ... } fn zscore<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member: M, ) -> RedisResult<RV> { ... } fn zscore_multiple<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: &'a [M], ) -> RedisResult<RV> { ... } fn zunionstore<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zunionstore_min<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zunionstore_max<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV> { ... } fn zunionstore_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV> { ... } fn zunionstore_min_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV> { ... } fn zunionstore_max_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV> { ... } fn pfadd<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, element: E, ) -> RedisResult<RV> { ... } fn pfcount<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn pfmerge<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV> { ... } fn publish<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>( &mut self, channel: K, message: E, ) -> RedisResult<RV> { ... } fn spublish<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>( &mut self, channel: K, message: E, ) -> RedisResult<RV> { ... } fn object_encoding<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn object_idletime<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn object_freq<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn object_refcount<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn client_getname<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn client_id<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn client_setname<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, connection_name: K, ) -> RedisResult<RV> { ... } fn acl_load<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_save<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_list<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_users<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_getuser<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, username: K, ) -> RedisResult<RV> { ... } fn acl_setuser<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, username: K, ) -> RedisResult<RV> { ... } fn acl_setuser_rules<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, username: K, rules: &'a [Rule], ) -> RedisResult<RV> { ... } fn acl_deluser<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, usernames: &'a [K], ) -> RedisResult<RV> { ... } fn acl_dryrun<'a, K: ToRedisArgs, C: ToRedisArgs, A: ToRedisArgs, RV: FromRedisValue>( &mut self, username: K, command: C, args: A, ) -> RedisResult<RV> { ... } fn acl_cat<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_cat_categoryname<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, categoryname: K, ) -> RedisResult<RV> { ... } fn acl_genpass<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_genpass_bits<'a, RV: FromRedisValue>( &mut self, bits: isize, ) -> RedisResult<RV> { ... } fn acl_whoami<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_log<'a, RV: FromRedisValue>( &mut self, count: isize, ) -> RedisResult<RV> { ... } fn acl_log_reset<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn acl_help<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn geo_add<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV> { ... } fn geo_dist<'a, K: ToRedisArgs, M1: ToRedisArgs, M2: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member1: M1, member2: M2, unit: Unit, ) -> RedisResult<RV> { ... } fn geo_hash<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV> { ... } fn geo_pos<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV> { ... } fn geo_radius<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, longitude: f64, latitude: f64, radius: f64, unit: Unit, options: RadiusOptions, ) -> RedisResult<RV> { ... } 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> { ... } fn xack<'a, K: ToRedisArgs, G: ToRedisArgs, I: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, ids: &'a [I], ) -> RedisResult<RV> { ... } 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> { ... } fn xadd_map<'a, K: ToRedisArgs, ID: ToRedisArgs, BTM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, id: ID, map: BTM, ) -> RedisResult<RV> { ... } fn xadd_options<'a, K: ToRedisArgs, ID: ToRedisArgs, I: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, id: ID, items: I, options: &'a StreamAddOptions, ) -> RedisResult<RV> { ... } 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> { ... } 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> { ... } fn xautoclaim_options<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, start: S, options: StreamAutoClaimOptions, ) -> RedisResult<RV> { ... } 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> { ... } 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> { ... } fn xdel<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ids: &'a [ID], ) -> RedisResult<RV> { ... } fn xgroup_create<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, id: ID, ) -> RedisResult<RV> { ... } fn xgroup_createconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, consumer: C, ) -> RedisResult<RV> { ... } fn xgroup_create_mkstream<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, id: ID, ) -> RedisResult<RV> { ... } fn xgroup_setid<'a, K: ToRedisArgs, G: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, id: ID, ) -> RedisResult<RV> { ... } fn xgroup_destroy<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, ) -> RedisResult<RV> { ... } fn xgroup_delconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, consumer: C, ) -> RedisResult<RV> { ... } fn xinfo_consumers<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, ) -> RedisResult<RV> { ... } fn xinfo_groups<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn xinfo_stream<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn xlen<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } fn xpending<'a, K: ToRedisArgs, G: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, ) -> RedisResult<RV> { ... } 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> { ... } 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> { ... } fn xrange<'a, K: ToRedisArgs, S: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, start: S, end: E, ) -> RedisResult<RV> { ... } fn xrange_all<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } 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> { ... } fn xread<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: &'a [K], ids: &'a [ID], ) -> RedisResult<RV> { ... } fn xread_options<'a, K: ToRedisArgs, ID: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: &'a [K], ids: &'a [ID], options: &'a StreamReadOptions, ) -> RedisResult<RV> { ... } fn xrevrange<'a, K: ToRedisArgs, E: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, end: E, start: S, ) -> RedisResult<RV> { ... } fn xrevrange_all<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV> { ... } 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> { ... } fn xtrim<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, maxlen: StreamMaxlen, ) -> RedisResult<RV> { ... } fn xtrim_options<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, options: &'a StreamTrimOptions, ) -> RedisResult<RV> { ... } fn invoke_script<'a, RV: FromRedisValue>( &mut self, invocation: &'a ScriptInvocation<'a>, ) -> RedisResult<RV> { ... } fn flushall<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn flushall_options<'a, RV: FromRedisValue>( &mut self, options: &'a FlushAllOptions, ) -> RedisResult<RV> { ... } fn flushdb<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV> { ... } fn flushdb_options<'a, RV: FromRedisValue>( &mut self, options: &'a FlushDbOptions, ) -> RedisResult<RV> { ... } fn scan<RV: FromRedisValue>(&mut self) -> RedisResult<Iter<'_, RV>> { ... } fn scan_options<RV: FromRedisValue>( &mut self, opts: ScanOptions, ) -> RedisResult<Iter<'_, RV>> { ... } fn scan_match<P: ToRedisArgs, RV: FromRedisValue>( &mut self, pattern: P, ) -> RedisResult<Iter<'_, RV>> { ... } fn hscan<K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<Iter<'_, RV>> { ... } fn hscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, pattern: P, ) -> RedisResult<Iter<'_, RV>> { ... } fn sscan<K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<Iter<'_, RV>> { ... } fn sscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, pattern: P, ) -> RedisResult<Iter<'_, RV>> { ... } fn zscan<K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<Iter<'_, RV>> { ... } fn zscan_match<K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, pattern: P, ) -> RedisResult<Iter<'_, RV>> { ... }
}
Expand description

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).exec(&mut con).unwrap();
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()?;
let _: () = con.set("my_key", 42)?;
assert_eq!(con.get("my_key"), Ok(42));

Provided Methods§

Source

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

Get the value of a key. If key is a vec this becomes an MGET (if using TypedCommands, you should specifically use mget to get the correct return type. Redis Docs

Source

fn mget<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Get values of keys Redis Docs

Source

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

Gets all keys matching pattern Redis Docs

Source

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

Set the string value of a key. Redis Docs

Source

fn set_options<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, options: SetOptions, ) -> RedisResult<RV>

Set the string value of a key with options. Redis Docs

Source

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

👎Deprecated since 0.22.4: Renamed to mset() to reflect Redis name

Sets multiple keys to their values. Redis Docs

Source

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

Sets multiple keys to their values. Redis Docs

Source

fn set_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, seconds: u64, ) -> RedisResult<RV>

Set the value and expiration of a key. Redis Docs

Source

fn pset_ex<'a, K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, value: V, milliseconds: u64, ) -> RedisResult<RV>

Set the value and expiration in milliseconds of a key. Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

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

Get a range of bytes/substring from the value of a key. Negative values provide an offset from the end of the value. Redis returns an empty string if the key doesn’t exist, not Nil Redis Docs

Source

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

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

Source

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

Delete one or more keys. Returns the number of keys deleted. Redis Docs

Source

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

Determine if a key exists. Redis Docs

Source

fn key_type<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Determine the type of key. Redis Docs

Source

fn expire<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, seconds: i64, ) -> RedisResult<RV>

Set a key’s time to live in seconds. Returns whether expiration was set. Redis Docs

Source

fn expire_at<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, ) -> RedisResult<RV>

Set the expiration for a key as a UNIX timestamp. Returns whether expiration was set. Redis Docs

Source

fn pexpire<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ms: i64, ) -> RedisResult<RV>

Set a key’s time to live in milliseconds. Returns whether expiration was set. Redis Docs

Source

fn pexpire_at<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, ) -> RedisResult<RV>

Set the expiration for a key as a UNIX timestamp in milliseconds. Returns whether expiration was set. Redis Docs

Source

fn expire_time<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Get the absolute Unix expiration timestamp in seconds. Returns ExistsButNotRelevant if key exists but has no expiration time. Redis Docs

Source

fn pexpire_time<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Get the absolute Unix expiration timestamp in milliseconds. Returns ExistsButNotRelevant if key exists but has no expiration time. Redis Docs

Source

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

Remove the expiration from a key. Returns whether a timeout was removed. Redis Docs

Source

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

Get the time to live for a key in seconds. Returns ExistsButNotRelevant if key exists but has no expiration time. Redis Docs

Source

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

Get the time to live for a key in milliseconds. Returns ExistsButNotRelevant if key exists but has no expiration time. Redis Docs

Source

fn get_ex<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, expire_at: Expiry, ) -> RedisResult<RV>

Get the value of a key and set expiration Redis Docs

Source

fn get_del<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Get the value of a key and delete it Redis Docs

Source

fn copy<'a, KSrc: ToRedisArgs, KDst: ToRedisArgs, Db: ToString, RV: FromRedisValue>( &mut self, source: KSrc, destination: KDst, options: CopyOptions<Db>, ) -> RedisResult<RV>

Copy the value from one key to another, returning whether the copy was successful. Redis Docs

Source

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

Rename a key. Errors if key does not exist. Redis Docs

Source

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

Rename a key, only if the new key does not exist. Errors if key does not exist. Returns whether the key was renamed, or false if the new key already exists. Redis Docs

Unlink one or more keys. This is a non-blocking version of DEL. Returns number of keys unlinked. Redis Docs

Source

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

Append a value to a key. Returns length of string after operation. Redis Docs

Source

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

Increment the numeric value of a key by the given amount. This issues a INCRBY or INCRBYFLOAT depending on the type. If the key does not exist, it is set to 0 before performing the operation.

Source

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

Decrement the numeric value of a key by the given amount. If the key does not exist, it is set to 0 before performing the operation. Redis Docs

Source

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

Sets or clears the bit at offset in the string value stored at key. Returns the original bit value stored at offset. Redis Docs

Source

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

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

Source

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

Count set bits in a string. Returns 0 if key does not exist. Redis Docs

Source

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

Count set bits in a string in a range. Returns 0 if key does not exist. Redis Docs

Source

fn bit_and<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV>

Perform a bitwise AND between multiple keys (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs.arg(“AND)

Source

fn bit_or<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV>

Perform a bitwise OR between multiple keys (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs.arg(“OR)

Source

fn bit_xor<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV>

Perform a bitwise XOR between multiple keys (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs.arg(“XOR)

Source

fn bit_not<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckey: S, ) -> RedisResult<RV>

Perform a bitwise NOT of the key (containing string values) and store the result in the destination key. Returns size of destination string after operation. Redis Docs.arg(“NOT)

Source

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

Get the length of the value stored in a key. 0 if key does not exist. Redis Docs

Source

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

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

Source

fn hget_ex<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, expire_at: Expiry, ) -> RedisResult<RV>

Get the value of one or more fields of a given hash key, and optionally set their expiration Redis Docs.arg(key).arg(expire_at).arg(“FIELDS)

Source

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

Deletes a single (or multiple) fields from a hash. Returns number of fields deleted. Redis Docs

Source

fn hget_del<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV>

Get and delete the value of one or more fields of a given hash key Redis Docs.arg(key).arg(“FIELDS)

Source

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

Sets a single field in a hash. Returns number of fields added. Redis Docs

Source

fn hset_ex<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, hash_field_expiration_options: &'a HashFieldExpirationOptions, fields_values: &'a [(F, V)], ) -> RedisResult<RV>

Set the value of one or more fields of a given hash key, and optionally set their expiration Redis Docs.arg(key).arg(hash_field_expiration_options).arg(“FIELDS)

Source

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

Sets a single field in a hash if it does not exist. Returns whether the field was added. Redis Docs

Source

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

Sets multiple fields in a hash. Redis Docs

Source

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

Increments a value. Returns the new value of the field after incrementation.

Source

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

Checks if a field in a hash exists. Redis Docs

Source

fn httl<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV>

Get one or more fields’ TTL in seconds. Redis Docs.arg(key).arg(“FIELDS)

Source

fn hpttl<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV>

Get one or more fields’ TTL in milliseconds. Redis Docs.arg(key).arg(“FIELDS)

Source

fn hexpire<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, seconds: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV>

Set one or more fields’ time to live in seconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with 0 seconds. Errors if provided key exists but is not a hash. Redis Docs.arg(key).arg(seconds).arg(opt).arg(“FIELDS)

Source

fn hexpire_at<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV>

Set the expiration for one or more fields as a UNIX timestamp in milliseconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with a time in the past. Errors if provided key exists but is not a hash. Redis Docs.arg(key).arg(ts).arg(opt).arg(“FIELDS)

Source

fn hexpire_time<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV>

Returns the absolute Unix expiration timestamp in seconds. Redis Docs.arg(key).arg(“FIELDS)

Source

fn hpersist<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV>

Remove the expiration from a key. Returns 1 if the expiration was removed. Redis Docs.arg(key).arg(“FIELDS)

Source

fn hpexpire<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, milliseconds: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV>

Set one or more fields’ time to live in milliseconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with 0 seconds. Errors if provided key exists but is not a hash. Redis Docs.arg(key).arg(milliseconds).arg(opt).arg(“FIELDS)

Source

fn hpexpire_at<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> RedisResult<RV>

Set the expiration for one or more fields as a UNIX timestamp in milliseconds. Returns an array where each element corresponds to the field at the same index in the fields argument. Each element of the array is either: 0 if the specified condition has not been met. 1 if the expiration time was updated. 2 if called with a time in the past. Errors if provided key exists but is not a hash. Redis Docs.arg(key).arg(ts).arg(opt).arg(“FIELDS)

Source

fn hpexpire_time<'a, K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, fields: F, ) -> RedisResult<RV>

Returns the absolute Unix expiration timestamp in seconds. Redis Docs.arg(key).arg(“FIELDS)

Source

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

Gets all the keys in a hash. Redis Docs

Source

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

Gets all the values in a hash. Redis Docs

Source

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

Gets all the fields and values in a hash. Redis Docs

Source

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

Gets the length of a hash. Returns 0 if key does not exist. Redis Docs

Source

fn blmove<'a, S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> RedisResult<RV>

Pop an element from a list, push it to another list and return it; or block until one is available Redis Docs

Source

fn blmpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> RedisResult<RV>

Pops count elements from the first non-empty list key from the list of provided key names; or blocks until one is available. Redis Docs.arg(timeout).arg(numkeys).arg(key).arg(dir).arg(“COUNT)

Source

fn blpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV>

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

Source

fn brpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV>

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

Source

fn brpoplpush<'a, S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, timeout: f64, ) -> RedisResult<RV>

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

Source

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

Get an element from a list by its index. Redis Docs

Source

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

Insert an element before another element in a list. Redis Docs

Source

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

Insert an element after another element in a list. Redis Docs

Source

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

Returns the length of the list stored at key. Redis Docs

Source

fn lmove<'a, S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> RedisResult<RV>

Pop an element a list, push it to another list and return it Redis Docs

Source

fn lmpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, numkeys: usize, key: K, dir: Direction, count: usize, ) -> RedisResult<RV>

Pops count elements from the first non-empty list key from the list of provided key names. Redis Docs.arg(numkeys).arg(key).arg(dir).arg(“COUNT)

Source

fn lpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: Option<NonZeroUsize>, ) -> RedisResult<RV>

Removes and returns the up to count first elements of the list stored at key.

If count is not specified, then defaults to first element. Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

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

Returns the specified elements of the list stored at key. Redis Docs

Source

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

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

Source

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

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

Source

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

Sets the list element at index to value Redis Docs

Source

fn ping<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>

Sends a ping to the server Redis Docs

Source

fn ping_message<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, message: K, ) -> RedisResult<RV>

Sends a ping with a message to the server Redis Docs

Source

fn rpop<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: Option<NonZeroUsize>, ) -> RedisResult<RV>

Removes and returns the up to count last elements of the list stored at key

If count is not specified, then defaults to last element. Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

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

Add one or more members to a set. Redis Docs

Source

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

Get the number of members in a set. Redis Docs

Source

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

Subtract multiple sets. Redis Docs

Source

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

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

Source

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

Intersect multiple sets. Redis Docs

Source

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

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

Source

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

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

Source

fn smismember<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV>

Determine if given values are members of a set. Redis Docs

Source

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

Get all the members in a set. Redis Docs

Source

fn smove<'a, S: ToRedisArgs, D: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, srckey: S, dstkey: D, member: M, ) -> RedisResult<RV>

Move a member from one set to another. Redis Docs

Source

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

Remove and return a random member from a set. Redis Docs

Source

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

Get one random member from a set. Redis Docs

Source

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

Get multiple random members from a set. Redis Docs

Source

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

Remove one or more members from a set. Redis Docs

Source

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

Add multiple sets. Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

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

Get the number of members in a sorted set. Redis Docs

Source

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

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

Source

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

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. Redis Docs

Source

fn zinterstore<'a, D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: K, ) -> RedisResult<RV>

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

Source

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

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

Source

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

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

Source

fn zinterstore_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV>

Commands::zinterstore, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

fn zinterstore_min_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV>

Commands::zinterstore_min, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

fn zinterstore_max_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV>

Commands::zinterstore_max, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

fn zlexcount<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, min: M, max: MM, ) -> RedisResult<RV>

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

Source

fn bzpopmax<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV>

Removes and returns the member with the highest score in a sorted set. Blocks until a member is available otherwise. Redis Docs

Source

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

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

Source

fn bzpopmin<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, timeout: f64, ) -> RedisResult<RV>

Removes and returns the member with the lowest score in a sorted set. Blocks until a member is available otherwise. Redis Docs

Source

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

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

Source

fn bzmpop_max<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, timeout: f64, keys: K, count: isize, ) -> RedisResult<RV>

Removes and returns up to count members with the highest scores, from the first non-empty sorted set in the provided list of key names. Blocks until a member is available otherwise. Redis Docs

Source

fn zmpop_max<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, count: isize, ) -> RedisResult<RV>

Removes and returns up to count members with the highest scores, from the first non-empty sorted set in the provided list of key names. Redis Docs

Source

fn bzmpop_min<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, timeout: f64, keys: K, count: isize, ) -> RedisResult<RV>

Removes and returns up to count members with the lowest scores, from the first non-empty sorted set in the provided list of key names. Blocks until a member is available otherwise. Redis Docs

Source

fn zmpop_min<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, keys: K, count: isize, ) -> RedisResult<RV>

Removes and returns up to count members with the lowest scores, from the first non-empty sorted set in the provided list of key names. Redis Docs

Source

fn zrandmember<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: Option<isize>, ) -> RedisResult<RV>

Return up to count random members in a sorted set (or 1 if count == None) Redis Docs

Source

fn zrandmember_withscores<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, count: isize, ) -> RedisResult<RV>

Return up to count random members in a sorted set with scores Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

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>

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

Source

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

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

Source

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>

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

Source

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

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

Source

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

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

Source

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>

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

Source

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>

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

Source

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

Determine the index of a member in a sorted set. Redis Docs

Source

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

Remove one or more members from a sorted set. Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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>

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

Source

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>

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

Source

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

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

Source

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

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

Source

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

Get the scores associated with multiple members in a sorted set. Redis Docs

Source

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

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

Source

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

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

Source

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

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

Source

fn zunionstore_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV>

Commands::zunionstore, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

fn zunionstore_min_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV>

Commands::zunionstore_min, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

fn zunionstore_max_weights<'a, D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> RedisResult<RV>

Commands::zunionstore_max, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple. Redis Docs

Source

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

Adds the specified elements to the specified HyperLogLog. Redis Docs

Source

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

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

Source

fn pfmerge<'a, D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, dstkey: D, srckeys: S, ) -> RedisResult<RV>

Merge N different HyperLogLogs into a single one. Redis Docs

Source

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

Posts a message to the given channel. Redis Docs

Source

fn spublish<'a, K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue>( &mut self, channel: K, message: E, ) -> RedisResult<RV>

Posts a message to the given sharded channel. Redis Docs

Source

fn object_encoding<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Returns the encoding of a key. Redis Docs

Source

fn object_idletime<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Returns the time in seconds since the last access of a key. Redis Docs

Source

fn object_freq<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Returns the logarithmic access frequency counter of a key. Redis Docs

Source

fn object_refcount<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, ) -> RedisResult<RV>

Returns the reference count of a key. Redis Docs

Source

fn client_getname<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>

Returns the name of the current connection as set by CLIENT SETNAME. Redis Docs

Source

fn client_id<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>

Returns the ID of the current connection. Redis Docs

Source

fn client_setname<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, connection_name: K, ) -> RedisResult<RV>

Command assigns a name to the current connection. Redis Docs

Source

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

Available 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. Redis Docs

Source

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

Available 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. Redis Docs

Source

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

Available on crate feature acl only.

Shows the currently active ACL rules in the Redis server. Redis Docs

Source

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

Available on crate feature acl only.

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

Source

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

Available on crate feature acl only.

Returns all the rules defined for an existing ACL user. Redis Docs

Source

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

Available on crate feature acl only.

Creates an ACL user without any privilege. Redis Docs

Source

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

Available on crate feature acl only.

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

Source

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

Available on crate feature acl only.

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

Source

fn acl_dryrun<'a, K: ToRedisArgs, C: ToRedisArgs, A: ToRedisArgs, RV: FromRedisValue>( &mut self, username: K, command: C, args: A, ) -> RedisResult<RV>

Available on crate feature acl only.

Simulate the execution of a given command by a given user. Redis Docs

Source

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

Available on crate feature acl only.

Shows the available ACL categories. Redis Docs

Source

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

Available on crate feature acl only.

Shows all the Redis commands in the specified category. Redis Docs

Source

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

Available on crate feature acl only.

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

Source

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

Available on crate feature acl only.

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

Source

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

Available on crate feature acl only.

Returns the username the current connection is authenticated with. Redis Docs

Source

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

Available on crate feature acl only.

Shows a list of recent ACL security events Redis Docs

Source

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

Available on crate feature acl only.

Clears the ACL log. Redis Docs

Source

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

Available on crate feature acl only.

Returns a helpful text describing the different subcommands. Redis Docs

Source

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

Available 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")
    ])
}

Redis Docs

Source

fn geo_dist<'a, K: ToRedisArgs, M1: ToRedisArgs, M2: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, member1: M1, member2: M2, unit: Unit, ) -> RedisResult<RV>

Available 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)
}

Redis Docs

Source

fn geo_hash<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV>

Available 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"]
}

Redis Docs

Source

fn geo_pos<'a, K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, members: M, ) -> RedisResult<RV>

Available 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
}

Redis Docs

Source

fn geo_radius<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, longitude: f64, latitude: f64, radius: f64, unit: Unit, options: RadiusOptions, ) -> RedisResult<RV>

Available 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()
}

Redis Docs

Source

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>

Available on crate feature geospatial only.

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

Source

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

Available on crate feature streams only.

Ack pending stream messages checked out by a consumer.

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

Redis Docs

Source

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>

Available 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] ...

Redis Docs

Source

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

Available 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] ...

Redis Docs

Source

fn xadd_options<'a, K: ToRedisArgs, ID: ToRedisArgs, I: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, id: ID, items: I, options: &'a StreamAddOptions, ) -> RedisResult<RV>

Available on crate feature streams only.

Add a stream message with options.

Items can be any list type, e.g.

// static items
let items = &[("key", "val"), ("key2", "val2")];
// A map (Can be BTreeMap, HashMap, etc)
let mut map: BTreeMap<&str, &str> = BTreeMap::new();
map.insert("ab", "cd");
map.insert("ef", "gh");
map.insert("ij", "kl");
XADD key [NOMKSTREAM] [<MAXLEN|MINID> [~|=] threshold [LIMIT count]] <* | ID> field value [field value] ...

Redis Docs

Source

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>

Available 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] ...

Redis Docs

Source

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>

Available 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] ...

Redis Docs

Source

fn xautoclaim_options<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, MIT: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, start: S, options: StreamAutoClaimOptions, ) -> RedisResult<RV>

Available on crate feature streams only.

Perform a combined xpending and xclaim flow.

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

let opts = StreamAutoClaimOptions::default();
let results : RedisResult<StreamAutoClaimReply> = con.xautoclaim_options("k1", "g1", "c1", 10, "0-0", opts);
XAUTOCLAIM <key> <group> <consumer> <min-idle-time> <start> [COUNT <count>] [JUSTID]

Redis Docs

Source

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>

Available 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>]

Redis Docs

Source

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>

Available 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] [LASTID <lastid>]

Redis Docs

Source

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

Available on crate feature streams only.

Deletes a list of ids for a given stream key.

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

Redis Docs

Source

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

Available 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 $>

Redis Docs

Source

fn xgroup_createconsumer<'a, K: ToRedisArgs, G: ToRedisArgs, C: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, group: G, consumer: C, ) -> RedisResult<RV>

Available on crate feature streams only.

This creates a consumer explicitly (vs implicit via XREADGROUP) for given stream `key.

The return value is either a 0 or a 1 for the number of consumers created 0 means the consumer already exists

XGROUP CREATECONSUMER <key> <groupname> <consumername>

Redis Docs

Source

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

Available 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]

Redis Docs

Source

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

Available 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 $>

Redis Docs

Source

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

Available on crate feature streams only.

Destroy an existing consumer group for a given stream key

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

Redis Docs

Source

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

Available on crate feature streams only.

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

XGROUP DELCONSUMER <key> <groupname> <consumername>

Redis Docs

Source

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

Available 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>

Redis Docs

Source

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

Available 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>

Redis Docs Redis Docs.arg(“GROUPS)

Source

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

Available 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>

Redis Docs.arg(“STREAM)

Source

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

Available on crate feature streams only.

Returns the number of messages for a given stream key.

XLEN <key>

Redis Docs

Source

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

Available 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>]]

Redis Docs

Source

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>

Available 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>

Redis Docs

Source

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>

Available 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>

Redis Docs

Source

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

Available 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

Redis Docs

Source

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

Available on crate feature streams only.

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

XRANGE key - +

Redis Docs.arg(key).arg(“-”).arg(“+)

Source

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>

Available on crate feature streams only.

A method for paginating a stream by key.

XRANGE key start end [COUNT <n>]

Redis Docs

Source

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

Available 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

Redis Docs

Source

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

Available 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 [GROUP group-name consumer-name] [BLOCK <milliseconds>] [COUNT <count>] [NOACK]
    STREAMS key_1 key_2 ... key_N
    ID_1 ID_2 ... ID_N

Redis Docs

Source

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

Available 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

Redis Docs

Source

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

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

XREVRANGE key + -

Redis Docs.arg(key).arg(“+”).arg(“-)

Source

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>

Available 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>]

Redis Docs

Source

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

Available on crate feature streams only.

Trim a stream key to a MAXLEN count.

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

Redis Docs

Source

fn xtrim_options<'a, K: ToRedisArgs, RV: FromRedisValue>( &mut self, key: K, options: &'a StreamTrimOptions, ) -> RedisResult<RV>

Available on crate feature streams only.

Trim a stream key with full options

XTRIM <key> <MAXLEN|MINID> [~|=] <threshold> [LIMIT <count>]  (Same as XADD MAXID|MINID options)

Redis Docs

Source

fn invoke_script<'a, RV: FromRedisValue>( &mut self, invocation: &'a ScriptInvocation<'a>, ) -> RedisResult<RV>

Available on crate feature script only.

Adds a prepared script command to the pipeline.

Note: unlike a call to invoke, if the script isn’t loaded during the pipeline operation, it will not automatically be loaded and retried. The script can be loaded using the load operation.

§Examples:
let script = redis::Script::new(r"
    return tonumber(ARGV[1]) + tonumber(ARGV[2]);
");
script.prepare_invoke().load(&mut con)?;
let (a, b): (isize, isize) = redis::pipe()
    .invoke_script(script.arg(1).arg(2))
    .invoke_script(script.arg(2).arg(3))
    .query(&mut con)?;

assert_eq!(a, 3);
assert_eq!(b, 5);
Source

fn flushall<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>

Deletes all the keys of all databases

Whether the flushing happens asynchronously or synchronously depends on the configuration of your Redis server.

To enforce a flush mode, use Commands::flushall_options.

FLUSHALL

Redis Docs

Source

fn flushall_options<'a, RV: FromRedisValue>( &mut self, options: &'a FlushAllOptions, ) -> RedisResult<RV>

Deletes all the keys of all databases with options

FLUSHALL [ASYNC|SYNC]

Redis Docs

Source

fn flushdb<'a, RV: FromRedisValue>(&mut self) -> RedisResult<RV>

Deletes all the keys of the current database

Whether the flushing happens asynchronously or synchronously depends on the configuration of your Redis server.

To enforce a flush mode, use Commands::flushdb_options.

FLUSHDB

Redis Docs

Source

fn flushdb_options<'a, RV: FromRedisValue>( &mut self, options: &'a FlushDbOptions, ) -> RedisResult<RV>

Deletes all the keys of the current database with options

FLUSHDB [ASYNC|SYNC]

Redis Docs

Source

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

Incrementally iterate the keys space.

Source

fn scan_options<RV: FromRedisValue>( &mut self, opts: ScanOptions, ) -> RedisResult<Iter<'_, RV>>

Incrementally iterate the keys space with options.

Source

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

Incrementally iterate the keys space for keys matching a pattern.

Source

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

Incrementally iterate hash fields and associated values.

Source

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

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

Source

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

Incrementally iterate set elements.

Source

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

Incrementally iterate set elements for elements matching a pattern.

Source

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

Incrementally iterate sorted set elements.

Source

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

Incrementally iterate sorted set elements for elements matching a pattern.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl<T> Commands for T
where T: ConnectionLike,