redis_driver

Trait HashCommands

Source 
pub trait HashCommands {

Show 17 methods    // Provided methods
    fn hdel<K, F, C>(
        &mut self,
        key: K,
        fields: C,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg>,
             C: SingleArgOrCollection<F> { ... }
    fn hexists<K, F>(
        &mut self,
        key: K,
        field: F,
    ) -> PreparedCommand<'_, Self, bool>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg> { ... }
    fn hget<K, F, V>(
        &mut self,
        key: K,
        field: F,
    ) -> PreparedCommand<'_, Self, V>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg>,
             V: FromValue { ... }
    fn hgetall<K, F, V, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             F: FromValue,
             V: FromValue,
             A: FromKeyValueValueArray<F, V> { ... }
    fn hincrby<K, F>(
        &mut self,
        key: K,
        field: F,
        increment: i64,
    ) -> PreparedCommand<'_, Self, i64>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg> { ... }
    fn hincrbyfloat<K, F>(
        &mut self,
        key: K,
        field: F,
        increment: f64,
    ) -> PreparedCommand<'_, Self, f64>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg> { ... }
    fn hkeys<K, F, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             F: FromValue,
             A: FromSingleValueArray<F> { ... }
    fn hlen<K>(&mut self, key: K) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg> { ... }
    fn hmget<K, F, V, C, A>(
        &mut self,
        key: K,
        fields: C,
    ) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg>,
             C: SingleArgOrCollection<F>,
             V: FromValue,
             A: FromSingleValueArray<V> { ... }
    fn hrandfield<K, F>(&mut self, key: K) -> PreparedCommand<'_, Self, F>
       where Self: Sized,
             K: Into<CommandArg>,
             F: FromValue { ... }
    fn hrandfields<K, F, A>(
        &mut self,
        key: K,
        count: isize,
    ) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             F: FromValue,
             A: FromSingleValueArray<F> { ... }
    fn hrandfields_with_values<K, F, V, A>(
        &mut self,
        key: K,
        count: isize,
    ) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             F: FromValue,
             V: FromValue,
             A: FromKeyValueValueArray<F, V> { ... }
    fn hscan<K, F, V>(
        &mut self,
        key: K,
        cursor: u64,
        options: HScanOptions,
    ) -> PreparedCommand<'_, Self, (u64, Vec<(F, V)>)>
       where Self: Sized,
             K: Into<CommandArg>,
             F: FromValue,
             V: FromValue { ... }
    fn hset<K, F, V, I>(
        &mut self,
        key: K,
        items: I,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg>,
             V: Into<CommandArg>,
             I: KeyValueArgOrCollection<F, V> { ... }
    fn hsetnx<K, F, V>(
        &mut self,
        key: K,
        field: F,
        value: V,
    ) -> PreparedCommand<'_, Self, bool>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg>,
             V: Into<CommandArg> { ... }
    fn hstrlen<K, F>(
        &mut self,
        key: K,
        field: F,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg>,
             F: Into<CommandArg> { ... }
    fn hvals<K, V, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             V: FromValue,
             A: FromSingleValueArray<V> { ... }

}
Expand description

A group of Redis commands related to Hashes

§See Also

Redis Hash Commands

Provided Methods§

Source

fn hdel<K, F, C>( &mut self, key: K, fields: C, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>, C: SingleArgOrCollection<F>,

Removes the specified fields from the hash stored at key.

§Return

the number of fields that were removed from the hash, not including specified but non existing fields.

§See Also

https://redis.io/commands/hdel/

Source

fn hexists<K, F>(&mut self, key: K, field: F) -> PreparedCommand<'_, Self, bool>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>,

Returns if field is an existing field in the hash stored at key.

§Return
  • true - if the hash contains field.
  • false - if the hash does not contain field, or key does not exist.
§See Also

https://redis.io/commands/hexists/

Source

fn hget<K, F, V>(&mut self, key: K, field: F) -> PreparedCommand<'_, Self, V>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>, V: FromValue,

Returns the value associated with field in the hash stored at key.

§Return

The value associated with field, or nil when field is not present in the hash or key does not exist.

§See Also

https://redis.io/commands/hget/

Source

fn hgetall<K, F, V, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, F: FromValue, V: FromValue, A: FromKeyValueValueArray<F, V>,

Returns all fields and values of the hash stored at key.

§Return

The list of fields and their values stored in the hash, or an empty list when key does not exist.

§See Also

https://redis.io/commands/hgetall/

Source

fn hincrby<K, F>( &mut self, key: K, field: F, increment: i64, ) -> PreparedCommand<'_, Self, i64>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>,

Increments the number stored at field in the hash stored at key by increment.

§Return

The value at field after the increment operation.

§See Also

https://redis.io/commands/hincrby/

Source

fn hincrbyfloat<K, F>( &mut self, key: K, field: F, increment: f64, ) -> PreparedCommand<'_, Self, f64>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>,

Increment the specified field of a hash stored at key, and representing a floating point number, by the specified increment.

§Return

The value at field after the increment operation.

§See Also

https://redis.io/commands/hincrbyfloat/

Source

fn hkeys<K, F, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, F: FromValue, A: FromSingleValueArray<F>,

Returns all field names in the hash stored at key.

§Return

The list of fields in the hash, or an empty list when key does not exist.

§See Also

https://redis.io/commands/hkeys/

Source

fn hlen<K>(&mut self, key: K) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>,

Returns the number of fields contained in the hash stored at key.

§Return

The number of fields in the hash, or 0 when key does not exist.

§See Also

https://redis.io/commands/hlen/

Source

fn hmget<K, F, V, C, A>( &mut self, key: K, fields: C, ) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>, C: SingleArgOrCollection<F>, V: FromValue, A: FromSingleValueArray<V>,

Returns the values associated with the specified fields in the hash stored at key.

§Return

The list of values associated with the given fields, in the same order as they are requested.

§See Also

https://redis.io/commands/hmget/

Source

fn hrandfield<K, F>(&mut self, key: K) -> PreparedCommand<'_, Self, F>
where Self: Sized, K: Into<CommandArg>, F: FromValue,

return random fields from the hash value stored at key.

§Return
  • When called with just the key argument, return a random field from the hash value stored at key.
§See Also

https://redis.io/commands/hrandfield/

Source

fn hrandfields<K, F, A>( &mut self, key: K, count: isize, ) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, F: FromValue, A: FromSingleValueArray<F>,

return random fields from the hash value stored at key.

§Return
  • If the provided count argument is positive, return an array of distinct fields. The array’s length is either count or the hash’s number of fields (HLEN), whichever is lower.
  • If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count.
§See Also

https://redis.io/commands/hrandfield/

Source

fn hrandfields_with_values<K, F, V, A>( &mut self, key: K, count: isize, ) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, F: FromValue, V: FromValue, A: FromKeyValueValueArray<F, V>,

return random fields from the hash value stored at key.

§Return
  • If the provided count argument is positive, return an array of distinct fields. The array’s length is either count or the hash’s number of fields (HLEN), whichever is lower.
  • If called with a negative count, the behavior changes and the command is allowed to return the same field multiple times. In this case, the number of returned fields is the absolute value of the specified count. The optional WITHVALUES modifier changes the reply so it includes the respective values of the randomly selected hash fields.
§See Also

https://redis.io/commands/hrandfield/

Source

fn hscan<K, F, V>( &mut self, key: K, cursor: u64, options: HScanOptions, ) -> PreparedCommand<'_, Self, (u64, Vec<(F, V)>)>
where Self: Sized, K: Into<CommandArg>, F: FromValue, V: FromValue,

Iterates fields of Hash types and their associated values.

§Return

array of elements contain two elements, a field and a value, for every returned element of the Hash.

§See Also

https://redis.io/commands/hlen/

Source

fn hset<K, F, V, I>( &mut self, key: K, items: I, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>, V: Into<CommandArg>, I: KeyValueArgOrCollection<F, V>,

Sets field in the hash stored at key to value.

§Return

The number of fields that were added.

§See Also

https://redis.io/commands/hset/

Source

fn hsetnx<K, F, V>( &mut self, key: K, field: F, value: V, ) -> PreparedCommand<'_, Self, bool>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>, V: Into<CommandArg>,

Sets field in the hash stored at key to value, only if field does not yet exist.

§Return
  • true - if field is a new field in the hash and value was set.
  • false - if field already exists in the hash and no operation was performed.
§See Also

https://redis.io/commands/hsetnx/

Source

fn hstrlen<K, F>( &mut self, key: K, field: F, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>, F: Into<CommandArg>,

Returns the string length of the value associated with field in the hash stored at key.

§Return

the string length of the value associated with field, or zero when field is not present in the hash or key does not exist at all.

§See Also

https://redis.io/commands/hstrlen/

Source

fn hvals<K, V, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, V: FromValue, A: FromSingleValueArray<V>,

list of values in the hash, or an empty list when key does not exist.

§Return

The list of values in the hash, or an empty list when key does not exist.

§See Also

https://redis.io/commands/hvals/

Implementors§