Struct redis::LposOptions

pub struct LposOptions { /* fields omitted */ }

Options for the [LPOS] command

https://redis.io/commands/lpos

Example

use redis::{Commands, RedisResult, LposOptions};
fn fetch_list_position(
    con: &mut redis::Connection,
    key: &str,
    value: &str,
    count: usize,
    rank: isize,
    maxlen: usize,
) -> RedisResult<Vec<usize>> {
    let opts = LposOptions::default()
        .count(count)
        .rank(rank)
        .maxlen(maxlen);
    con.lpos(key, value, opts)
}

Implementations

impl LposOptions

pub fn count(self, n: usize) -> Self

Limit the results to the first N matching items.

pub fn rank(self, n: isize) -> Self

Return the value of N from the matching items.

pub fn maxlen(self, n: usize) -> Self

Limit the search to N items in the list.

Trait Implementations

impl Default for LposOptions

pub fn default() -> LposOptions

Returns the "default value" for a type.

impl ToRedisArgs for LposOptions

pub fn write_redis_args<W: ?Sized>(&self, out: &mut W) where
    W: RedisWrite, 

This writes the value into a vector of bytes. Each item is a single argument. Most items generate a single item.

pub fn is_single_arg(&self) -> bool

Returns an indiciation if the value contained is exactly one argument. It returns false if it's zero or more than one. This is used in some high level functions to intelligently switch between GET and MGET variants.

pub fn to_redis_args(&self) -> Vec<Vec<u8>>

This converts the value into a vector of bytes. Each item is a single argument. Most items generate a vector of a single item.

pub fn describe_numeric_behavior(&self) -> NumericBehavior

Returns an information about the contained value with regards to it's numeric behavior in a redis context. This is used in some high level concepts to switch between different implementations of redis functions (for instance INCR vs INCRBYFLOAT).