[−][src]Struct trezm_redis::Cmd
Represents redis commands.
Methods
impl Cmd
[src]
A command acts as a builder interface to creating encoded redis requests. This allows you to easiy assemble a packed command by chaining arguments together.
Basic example:
redis::Cmd::new().arg("SET").arg("my_key").arg(42);
There is also a helper function called cmd
which makes it a
tiny bit shorter:
redis::cmd("SET").arg("my_key").arg(42);
Because currently rust's currently does not have an ideal system for lifetimes of temporaries, sometimes you need to hold on to the initially generated command:
let mut cmd = redis::cmd("SMEMBERS"); let mut iter : redis::Iter<i32> = cmd.arg("my_set").clone().iter(&mut con).unwrap();
pub fn new() -> Cmd
[src]
Creates a new empty command.
pub fn arg<T: ToRedisArgs>(&mut self, arg: T) -> &mut Cmd
[src]
Appends an argument to the command. The argument passed must
be a type that implements ToRedisArgs
. Most primitive types as
well as vectors of primitive types implement it.
For instance all of the following are valid:
redis::cmd("SET").arg(&["my_key", "my_value"]); redis::cmd("SET").arg("my_key").arg(42); redis::cmd("SET").arg("my_key").arg(b"my_value");
pub fn cursor_arg(&mut self, cursor: u64) -> &mut Cmd
[src]
Works similar to arg
but adds a cursor argument. This is always
an integer and also flips the command implementation to support a
different mode for the iterators where the iterator will ask for
another batch of items when the local data is exhausted.
let mut cmd = redis::cmd("SSCAN"); let mut iter : redis::Iter<isize> = cmd.arg("my_set").cursor_arg(0).clone().iter(&mut con).unwrap(); for x in iter { // do something with the item }
pub fn get_packed_command(&self) -> Vec<u8>
[src]
Returns the packed command as a byte vector.
pub fn in_scan_mode(&self) -> bool
[src]
Returns true if the command is in scan mode.
pub fn query<T: FromRedisValue>(
&self,
con: &mut dyn ConnectionLike
) -> RedisResult<T>
[src]
&self,
con: &mut dyn ConnectionLike
) -> RedisResult<T>
Sends the command as query to the connection and converts the result to the target redis value. This is the general way how you can retrieve data.
pub async fn query_async<'_, '_, C, T: FromRedisValue>(
&'_ self,
con: &'_ mut C
) -> RedisResult<T> where
C: ConnectionLike,
[src]
&'_ self,
con: &'_ mut C
) -> RedisResult<T> where
C: ConnectionLike,
Async version of query
.
pub fn iter<'a, T: FromRedisValue>(
self,
con: &'a mut dyn ConnectionLike
) -> RedisResult<Iter<'a, T>>
[src]
self,
con: &'a mut dyn ConnectionLike
) -> RedisResult<Iter<'a, T>>
Similar to query()
but returns an iterator over the items of the
bulk result or iterator. In normal mode this is not in any way more
efficient than just querying into a Vec<T>
as it's internally
implemented as buffering into a vector. This however is useful when
cursor_arg
was used in which case the iterator will query for more
items until the server side cursor is exhausted.
This is useful for commands such as SSCAN
, SCAN
and others.
One speciality of this function is that it will check if the response
looks like a cursor or not and always just looks at the payload.
This way you can use the function the same for responses in the
format of KEYS
(just a list) as well as SSCAN
(which returns a
tuple of cursor and list).
pub fn execute(&self, con: &mut dyn ConnectionLike)
[src]
This is a shortcut to query()
that does not return a value and
will fail the task if the query fails because of an error. This is
mainly useful in examples and for simple commands like setting
keys.
This is equivalent to a call of query like this:
let _ : () = redis::cmd("PING").query(&mut con).unwrap();
pub fn args_iter(
&self
) -> impl Iterator<Item = Arg<&[u8]>> + Clone + ExactSizeIterator
[src]
&self
) -> impl Iterator<Item = Arg<&[u8]>> + Clone + ExactSizeIterator
Returns an iterator over the arguments in this command (including the command name itself)
impl Cmd
[src]
pub fn get<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get the value of a key. If key is a vec this becomes an MGET
.
pub fn keys<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Gets all keys matching pattern
pub fn set<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, value: V) -> Self
[src]
Set the string value of a key.
pub fn set_multiple<'a, K: ToRedisArgs, V: ToRedisArgs>(
items: &'a [(K, V)]
) -> Self
[src]
items: &'a [(K, V)]
) -> Self
Sets multiple keys to their values.
pub fn set_ex<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
value: V,
seconds: usize
) -> Self
[src]
key: K,
value: V,
seconds: usize
) -> Self
Set the value and expiration of a key.
pub fn pset_ex<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
value: V,
milliseconds: usize
) -> Self
[src]
key: K,
value: V,
milliseconds: usize
) -> Self
Set the value and expiration in milliseconds of a key.
pub fn set_nx<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, value: V) -> Self
[src]
Set the value of a key, only if the key does not exist
pub fn mset_nx<'a, K: ToRedisArgs, V: ToRedisArgs>(items: &'a [(K, V)]) -> Self
[src]
Sets multiple keys to their values failing if at least one already exists.
pub fn getset<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, value: V) -> Self
[src]
Set the string value of a key and return its old value.
pub fn getrange<'a, K: ToRedisArgs>(key: K, from: isize, to: isize) -> Self
[src]
Get a range of bytes/substring from the value of a key. Negative values provide an offset from the end of the value.
pub fn setrange<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
offset: isize,
value: V
) -> Self
[src]
key: K,
offset: isize,
value: V
) -> Self
Overwrite the part of the value stored in key at the specified offset.
pub fn del<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Delete one or more keys.
pub fn exists<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Determine if a key exists.
pub fn expire<'a, K: ToRedisArgs>(key: K, seconds: usize) -> Self
[src]
Set a key's time to live in seconds.
pub fn expire_at<'a, K: ToRedisArgs>(key: K, ts: usize) -> Self
[src]
Set the expiration for a key as a UNIX timestamp.
pub fn pexpire<'a, K: ToRedisArgs>(key: K, ms: usize) -> Self
[src]
Set a key's time to live in milliseconds.
pub fn pexpire_at<'a, K: ToRedisArgs>(key: K, ts: usize) -> Self
[src]
Set the expiration for a key as a UNIX timestamp in milliseconds.
pub fn persist<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Remove the expiration from a key.
pub fn ttl<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get the expiration time of a key.
pub fn pttl<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get the expiration time of a key in milliseconds.
pub fn rename<'a, K: ToRedisArgs>(key: K, new_key: K) -> Self
[src]
Rename a key.
pub fn rename_nx<'a, K: ToRedisArgs>(key: K, new_key: K) -> Self
[src]
Rename a key, only if the new key does not exist.
pub fn append<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, value: V) -> Self
[src]
Append a value to a key.
pub fn incr<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, delta: V) -> Self
[src]
Increment the numeric value of a key by the given amount. This
issues a INCRBY
or INCRBYFLOAT
depending on the type.
pub fn setbit<'a, K: ToRedisArgs>(key: K, offset: usize, value: bool) -> Self
[src]
Sets or clears the bit at offset in the string value stored at key.
pub fn getbit<'a, K: ToRedisArgs>(key: K, offset: usize) -> Self
[src]
Returns the bit value at offset in the string value stored at key.
pub fn bitcount<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Count set bits in a string.
pub fn bitcount_range<'a, K: ToRedisArgs>(
key: K,
start: usize,
end: usize
) -> Self
[src]
key: K,
start: usize,
end: usize
) -> Self
Count set bits in a string in a range.
pub fn bit_and<'a, K: ToRedisArgs>(dstkey: K, srckeys: K) -> Self
[src]
Perform a bitwise AND between multiple keys (containing string values) and store the result in the destination key.
pub fn bit_or<'a, K: ToRedisArgs>(dstkey: K, srckeys: K) -> Self
[src]
Perform a bitwise OR between multiple keys (containing string values) and store the result in the destination key.
pub fn bit_xor<'a, K: ToRedisArgs>(dstkey: K, srckeys: K) -> Self
[src]
Perform a bitwise XOR between multiple keys (containing string values) and store the result in the destination key.
pub fn bit_not<'a, K: ToRedisArgs>(dstkey: K, srckey: K) -> Self
[src]
Perform a bitwise NOT of the key (containing string values) and store the result in the destination key.
pub fn strlen<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get the length of the value stored in a key.
pub fn hget<'a, K: ToRedisArgs, F: ToRedisArgs>(key: K, field: F) -> Self
[src]
Gets a single (or multiple) fields from a hash.
pub fn hdel<'a, K: ToRedisArgs, F: ToRedisArgs>(key: K, field: F) -> Self
[src]
Deletes a single (or multiple) fields from a hash.
pub fn hset<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs>(
key: K,
field: F,
value: V
) -> Self
[src]
key: K,
field: F,
value: V
) -> Self
Sets a single field in a hash.
pub fn hset_nx<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs>(
key: K,
field: F,
value: V
) -> Self
[src]
key: K,
field: F,
value: V
) -> Self
Sets a single field in a hash if it does not exist.
pub fn hset_multiple<'a, K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs>(
key: K,
items: &'a [(F, V)]
) -> Self
[src]
key: K,
items: &'a [(F, V)]
) -> Self
Sets a multiple fields in a hash.
pub fn hincr<'a, K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs>(
key: K,
field: F,
delta: D
) -> Self
[src]
key: K,
field: F,
delta: D
) -> Self
Increments a value.
pub fn hexists<'a, K: ToRedisArgs, F: ToRedisArgs>(key: K, field: F) -> Self
[src]
Checks if a field in a hash exists.
pub fn hkeys<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Gets all the keys in a hash.
pub fn hvals<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Gets all the values in a hash.
pub fn hgetall<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Gets all the fields and values in a hash.
pub fn hlen<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Gets the length of a hash.
pub fn blpop<'a, K: ToRedisArgs>(key: K, timeout: usize) -> Self
[src]
Remove and get the first element in a list, or block until one is available.
pub fn brpop<'a, K: ToRedisArgs>(key: K, timeout: usize) -> Self
[src]
Remove and get the last element in a list, or block until one is available.
pub fn brpoplpush<'a, K: ToRedisArgs>(
srckey: K,
dstkey: K,
timeout: usize
) -> Self
[src]
srckey: K,
dstkey: K,
timeout: usize
) -> Self
Pop a value from a list, push it to another list and return it; or block until one is available.
pub fn lindex<'a, K: ToRedisArgs>(key: K, index: isize) -> Self
[src]
Get an element from a list by its index.
pub fn linsert_before<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs>(
key: K,
pivot: P,
value: V
) -> Self
[src]
key: K,
pivot: P,
value: V
) -> Self
Insert an element before another element in a list.
pub fn linsert_after<'a, K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs>(
key: K,
pivot: P,
value: V
) -> Self
[src]
key: K,
pivot: P,
value: V
) -> Self
Insert an element after another element in a list.
pub fn llen<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Returns the length of the list stored at key.
pub fn lpop<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Removes and returns the first element of the list stored at key.
pub fn lpush<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, value: V) -> Self
[src]
Insert all the specified values at the head of the list stored at key.
pub fn lpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
value: V
) -> Self
[src]
key: K,
value: V
) -> Self
Inserts a value at the head of the list stored at key, only if key already exists and holds a list.
pub fn lrange<'a, K: ToRedisArgs>(key: K, start: isize, stop: isize) -> Self
[src]
Returns the specified elements of the list stored at key.
pub fn lrem<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
count: isize,
value: V
) -> Self
[src]
key: K,
count: isize,
value: V
) -> Self
Removes the first count occurrences of elements equal to value from the list stored at key.
pub fn ltrim<'a, K: ToRedisArgs>(key: K, start: isize, stop: isize) -> Self
[src]
Trim an existing list so that it will contain only the specified range of elements specified.
pub fn lset<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
index: isize,
value: V
) -> Self
[src]
key: K,
index: isize,
value: V
) -> Self
Sets the list element at index to value
pub fn rpop<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Removes and returns the last element of the list stored at key.
pub fn rpoplpush<'a, K: ToRedisArgs>(key: K, dstkey: K) -> Self
[src]
Pop a value from a list, push it to another list and return it.
pub fn rpush<'a, K: ToRedisArgs, V: ToRedisArgs>(key: K, value: V) -> Self
[src]
Insert all the specified values at the tail of the list stored at key.
pub fn rpush_exists<'a, K: ToRedisArgs, V: ToRedisArgs>(
key: K,
value: V
) -> Self
[src]
key: K,
value: V
) -> Self
Inserts value at the tail of the list stored at key, only if key already exists and holds a list.
pub fn sadd<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, member: M) -> Self
[src]
Add one or more members to a set.
pub fn scard<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get the number of members in a set.
pub fn sdiff<'a, K: ToRedisArgs>(keys: K) -> Self
[src]
Subtract multiple sets.
pub fn sdiffstore<'a, K: ToRedisArgs>(dstkey: K, keys: K) -> Self
[src]
Subtract multiple sets and store the resulting set in a key.
pub fn sinter<'a, K: ToRedisArgs>(keys: K) -> Self
[src]
Intersect multiple sets.
pub fn sinterstore<'a, K: ToRedisArgs>(dstkey: K, keys: K) -> Self
[src]
Intersect multiple sets and store the resulting set in a key.
pub fn sismember<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, member: M) -> Self
[src]
Determine if a given value is a member of a set.
pub fn smembers<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get all the members in a set.
pub fn smove<'a, K: ToRedisArgs, M: ToRedisArgs>(
srckey: K,
dstkey: K,
member: M
) -> Self
[src]
srckey: K,
dstkey: K,
member: M
) -> Self
Move a member from one set to another.
pub fn spop<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Remove and return a random member from a set.
pub fn srandmember<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get one random member from a set.
pub fn srandmember_multiple<'a, K: ToRedisArgs>(key: K, count: usize) -> Self
[src]
Get multiple random members from a set.
pub fn srem<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, member: M) -> Self
[src]
Remove one or more members from a set.
pub fn sunion<'a, K: ToRedisArgs>(keys: K) -> Self
[src]
Add multiple sets.
pub fn sunionstore<'a, K: ToRedisArgs>(dstkey: K, keys: K) -> Self
[src]
Add multiple sets and store the resulting set in a key.
pub fn zadd<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs>(
key: K,
member: M,
score: S
) -> Self
[src]
key: K,
member: M,
score: S
) -> Self
Add one member to a sorted set, or update its score if it already exists.
pub fn zadd_multiple<'a, K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs>(
key: K,
items: &'a [(S, M)]
) -> Self
[src]
key: K,
items: &'a [(S, M)]
) -> Self
Add multiple members to a sorted set, or update its score if it already exists.
pub fn zcard<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Get the number of members in a sorted set.
pub fn zcount<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM
) -> Self
[src]
key: K,
min: M,
max: MM
) -> Self
Count the members in a sorted set with scores within the given values.
pub fn zincr<'a, K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs>(
key: K,
member: M,
delta: D
) -> Self
[src]
key: K,
member: M,
delta: D
) -> Self
Increments the member in a sorted set at key by delta. If the member does not exist, it is added with delta as its score.
pub fn zinterstore<'a, K: ToRedisArgs>(dstkey: K, keys: &'a [K]) -> Self
[src]
Intersect multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function.
pub fn zinterstore_min<'a, K: ToRedisArgs>(dstkey: K, keys: &'a [K]) -> Self
[src]
Intersect multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function.
pub fn zinterstore_max<'a, K: ToRedisArgs>(dstkey: K, keys: &'a [K]) -> Self
[src]
Intersect multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function.
pub fn zlexcount<'a, K: ToRedisArgs, L: ToRedisArgs>(
key: K,
min: L,
max: L
) -> Self
[src]
key: K,
min: L,
max: L
) -> Self
Count the number of members in a sorted set between a given lexicographical range.
pub fn zrange<'a, K: ToRedisArgs>(key: K, start: isize, stop: isize) -> Self
[src]
Return a range of members in a sorted set, by index
pub fn zrange_withscores<'a, K: ToRedisArgs>(
key: K,
start: isize,
stop: isize
) -> Self
[src]
key: K,
start: isize,
stop: isize
) -> Self
Return a range of members in a sorted set, by index with scores.
pub fn zrangebylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM
) -> Self
[src]
key: K,
min: M,
max: MM
) -> Self
Return a range of members in a sorted set, by lexicographical range.
pub fn zrangebylex_limit<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM,
offset: isize,
count: isize
) -> Self
[src]
key: K,
min: M,
max: MM,
offset: isize,
count: isize
) -> Self
Return a range of members in a sorted set, by lexicographical range with offset and limit.
pub fn zrevrangebylex<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs>(
key: K,
max: MM,
min: M
) -> Self
[src]
key: K,
max: MM,
min: M
) -> Self
Return a range of members in a sorted set, by lexicographical range.
pub fn zrevrangebylex_limit<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs>(
key: K,
max: MM,
min: M,
offset: isize,
count: isize
) -> Self
[src]
key: K,
max: MM,
min: M,
offset: isize,
count: isize
) -> Self
Return a range of members in a sorted set, by lexicographical range with offset and limit.
pub fn zrangebyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM
) -> Self
[src]
key: K,
min: M,
max: MM
) -> Self
Return a range of members in a sorted set, by score.
pub fn zrangebyscore_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM
) -> Self
[src]
key: K,
min: M,
max: MM
) -> Self
Return a range of members in a sorted set, by score with scores.
pub fn zrangebyscore_limit<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM,
offset: isize,
count: isize
) -> Self
[src]
key: K,
min: M,
max: MM,
offset: isize,
count: isize
) -> Self
Return a range of members in a sorted set, by score with limit.
pub fn zrangebyscore_limit_withscores<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM,
offset: isize,
count: isize
) -> Self
[src]
key: K,
min: M,
max: MM,
offset: isize,
count: isize
) -> Self
Return a range of members in a sorted set, by score with limit with scores.
pub fn zrank<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, member: M) -> Self
[src]
Determine the index of a member in a sorted set.
pub fn zrem<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, members: M) -> Self
[src]
Remove one or more members from a sorted set.
pub fn zrembylex<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM
) -> Self
[src]
key: K,
min: M,
max: MM
) -> Self
Remove all members in a sorted set between the given lexicographical range.
pub fn zremrangebyrank<'a, K: ToRedisArgs>(
key: K,
start: isize,
stop: isize
) -> Self
[src]
key: K,
start: isize,
stop: isize
) -> Self
Remove all members in a sorted set within the given indexes.
pub fn zrembyscore<'a, K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs>(
key: K,
min: M,
max: MM
) -> Self
[src]
key: K,
min: M,
max: MM
) -> Self
Remove all members in a sorted set within the given scores.
pub fn zrevrange<'a, K: ToRedisArgs>(key: K, start: isize, stop: isize) -> Self
[src]
Return a range of members in a sorted set, by index, with scores ordered from high to low.
pub fn zrevrange_withscores<'a, K: ToRedisArgs>(
key: K,
start: isize,
stop: isize
) -> Self
[src]
key: K,
start: isize,
stop: isize
) -> Self
Return a range of members in a sorted set, by index, with scores ordered from high to low.
pub fn zrevrangebyscore<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs>(
key: K,
max: MM,
min: M
) -> Self
[src]
key: K,
max: MM,
min: M
) -> Self
Return a range of members in a sorted set, by score.
pub fn zrevrangebyscore_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs>(
key: K,
max: MM,
min: M
) -> Self
[src]
key: K,
max: MM,
min: M
) -> Self
Return a range of members in a sorted set, by score with scores.
pub fn zrevrangebyscore_limit<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs>(
key: K,
max: MM,
min: M,
offset: isize,
count: isize
) -> Self
[src]
key: K,
max: MM,
min: M,
offset: isize,
count: isize
) -> Self
Return a range of members in a sorted set, by score with limit.
pub fn zrevrangebyscore_limit_withscores<'a, K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs>(
key: K,
max: MM,
min: M,
offset: isize,
count: isize
) -> Self
[src]
key: K,
max: MM,
min: M,
offset: isize,
count: isize
) -> Self
Return a range of members in a sorted set, by score with limit with scores.
pub fn zrevrank<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, member: M) -> Self
[src]
Determine the index of a member in a sorted set, with scores ordered from high to low.
pub fn zscore<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, member: M) -> Self
[src]
Get the score associated with the given member in a sorted set.
pub fn zunionstore<'a, K: ToRedisArgs>(dstkey: K, keys: &'a [K]) -> Self
[src]
Unions multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function.
pub fn zunionstore_min<'a, K: ToRedisArgs>(dstkey: K, keys: &'a [K]) -> Self
[src]
Unions multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function.
pub fn zunionstore_max<'a, K: ToRedisArgs>(dstkey: K, keys: &'a [K]) -> Self
[src]
Unions multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function.
pub fn pfadd<'a, K: ToRedisArgs, E: ToRedisArgs>(key: K, element: E) -> Self
[src]
Adds the specified elements to the specified HyperLogLog.
pub fn pfcount<'a, K: ToRedisArgs>(key: K) -> Self
[src]
Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
pub fn pfmerge<'a, K: ToRedisArgs>(dstkey: K, srckeys: K) -> Self
[src]
Merge N different HyperLogLogs into a single one.
pub fn publish<'a, K: ToRedisArgs, E: ToRedisArgs>(
channel: K,
message: E
) -> Self
[src]
channel: K,
message: E
) -> Self
Posts a message to the given channel.
pub fn geo_add<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, members: M) -> Self
[src]
Adds the specified geospatial items to the specified key.
Every member has to be written as a tuple of (longitude, latitude, member_name)
. It can be a single tuple, or a vector of tuples.
longitude, latitude
can be set using redis::geo::Coord
.
Returns the number of elements added to the sorted set, not including elements already existing for which the score was updated.
Example
use redis::{Commands, Connection, RedisResult}; use redis::geo::Coord; fn add_point(con: &mut Connection) -> RedisResult<isize> { con.geo_add("my_gis", (Coord::lon_lat(13.361389, 38.115556), "Palermo")) } fn add_point_with_tuples(con: &mut Connection) -> RedisResult<isize> { con.geo_add("my_gis", ("13.361389", "38.115556", "Palermo")) } fn add_many_points(con: &mut Connection) -> RedisResult<isize> { con.geo_add("my_gis", &[ ("13.361389", "38.115556", "Palermo"), ("15.087269", "37.502669", "Catania") ]) }
pub fn geo_dist<'a, K: ToRedisArgs, M1: ToRedisArgs, M2: ToRedisArgs>(
key: K,
member1: M1,
member2: M2,
unit: Unit
) -> Self
[src]
key: K,
member1: M1,
member2: M2,
unit: Unit
) -> Self
Return the distance between two members in the geospatial index represented by the sorted set.
If one or both the members are missing, the command returns NULL, so
it may be convenient to parse its response as either Option<f64>
or
Option<String>
.
Example
use redis::{Commands, RedisResult}; use redis::geo::Unit; fn get_dists(con: &mut redis::Connection) { let x: RedisResult<f64> = con.geo_dist( "my_gis", "Palermo", "Catania", Unit::Kilometers ); // x is Ok(166.2742) let x: RedisResult<Option<f64>> = con.geo_dist( "my_gis", "Palermo", "Atlantis", Unit::Meters ); // x is Ok(None) }
pub fn geo_hash<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, members: M) -> Self
[src]
Return valid Geohash strings representing the position of one or more members of the geospatial index represented by the sorted set at key.
Example
use redis::{Commands, RedisResult}; fn get_hash(con: &mut redis::Connection) { let x: RedisResult<Vec<String>> = con.geo_hash("my_gis", "Palermo"); // x is vec!["sqc8b49rny0"] let x: RedisResult<Vec<String>> = con.geo_hash("my_gis", &["Palermo", "Catania"]); // x is vec!["sqc8b49rny0", "sqdtr74hyu0"] }
pub fn geo_pos<'a, K: ToRedisArgs, M: ToRedisArgs>(key: K, members: M) -> Self
[src]
Return the positions of all the specified members of the geospatial index represented by the sorted set at key.
Every position is a pair of (longitude, latitude)
. redis::geo::Coord
can be used to convert these value in a struct.
Example
use redis::{Commands, RedisResult}; use redis::geo::Coord; fn get_position(con: &mut redis::Connection) { let x: RedisResult<Vec<Vec<f64>>> = con.geo_pos("my_gis", &["Palermo", "Catania"]); // x is [ [ 13.361389, 38.115556 ], [ 15.087269, 37.502669 ] ]; let x: Vec<Coord<f64>> = con.geo_pos("my_gis", "Palermo").unwrap(); // x[0].longitude is 13.361389 // x[0].latitude is 38.115556 }
pub fn geo_radius<'a, K: ToRedisArgs>(
key: K,
longitude: f64,
latitude: f64,
radius: f64,
unit: Unit,
options: RadiusOptions
) -> Self
[src]
key: K,
longitude: f64,
latitude: f64,
radius: f64,
unit: Unit,
options: RadiusOptions
) -> Self
Return the members of a sorted set populated with geospatial information
using geo_add
, which are within the borders of the area
specified with the center location and the maximum distance from the center
(the radius).
Every item in the result can be read with redis::geo::RadiusSearchResult
,
which support the multiple formats returned by GEORADIUS
.
use redis::{Commands, RedisResult}; use redis::geo::{RadiusOptions, RadiusSearchResult, RadiusOrder, Unit}; fn radius(con: &mut redis::Connection) -> Vec<RadiusSearchResult> { let opts = RadiusOptions::default().with_dist().order(RadiusOrder::Asc); con.geo_radius("my_gis", 15.90, 37.21, 51.39, Unit::Kilometers, opts).unwrap() }
pub fn geo_radius_by_member<'a, K: ToRedisArgs, M: ToRedisArgs>(
key: K,
member: M,
radius: f64,
unit: Unit,
options: RadiusOptions
) -> Self
[src]
key: K,
member: M,
radius: f64,
unit: Unit,
options: RadiusOptions
) -> Self
Retrieve members selected by distance with the center of member
. The
member itself is always contained in the results.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Cmd
impl Send for Cmd
impl Sync for Cmd
impl Unpin for Cmd
impl UnwindSafe for Cmd
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,