Enum redis::Value

pub enum Value {
    Nil,
    Int(i64),
    Data(Vec<u8>),
    Bulk(Vec<Value>),
    Status(String),
    Okay,
}

Internal low-level redis value enum.

Variants

Nil

A nil response from the server.

Int(i64)

An integer response. Note that there are a few situations in which redis actually returns a string for an integer which is why this library generally treats integers and strings the same for all numeric responses.

Data(Vec<u8>)

An arbitary binary data.

Bulk(Vec<Value>)

A bulk response of more data. This is generally used by redis to express nested structures.

Status(String)

A status response.

Okay

A status response which represents the string “OK”.

Implementations

impl Value

Values are generally not used directly unless you are using the more low level functionality in the library. For the most part this is hidden with the help of the FromRedisValue trait.

While on the redis protocol there is an error type this is already separated at an early point so the value only holds the remaining types.

pub fn looks_like_cursor(&self) -> bool

Checks if the return value looks like it fulfils the cursor protocol. That means the result is a bulk item of length two with the first one being a cursor and the second a bulk response.

pub fn as_sequence(&self) -> Option<&[Value]>

Returns an &[Value] if self is compatible with a sequence type

pub fn into_sequence(self) -> Result<Vec<Value>, Value>

Returns a Vec<Value> if self is compatible with a sequence type, otherwise returns Err(self).

pub fn as_map_iter(&self) -> Option<MapIter<'_>>

Returns an iterator of (&Value, &Value) if self is compatible with a map type

pub fn into_map_iter(self) -> Result<OwnedMapIter, Value>

Returns an iterator of (Value, Value) if self is compatible with a map type. If not, returns Err(self).

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Value

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRedisValue for Value

fn from_redis_value(v: &Value) -> RedisResult<Value>

Given a redis Value this attempts to convert it into the given destination type. If that fails because it’s not compatible an appropriate error is generated.

fn from_owned_redis_value(v: Value) -> RedisResult<Self>

Given a redis Value this attempts to convert it into the given destination type. If that fails because it’s not compatible an appropriate error is generated.

fn from_redis_values(items: &[Value]) -> RedisResult<Vec<Self>>

Similar to from_redis_value but constructs a vector of objects from another vector of values. This primarily exists internally to customize the behavior for vectors of tuples.

fn from_owned_redis_values(items: Vec<Value>) -> RedisResult<Vec<Self>>

The same as from_redis_values, but takes a Vec<Value> instead of a &[Value].

fn from_byte_vec(_vec: &[u8]) -> Option<Vec<Self>>

Convert bytes to a single element vector.

fn from_owned_byte_vec(_vec: Vec<u8>) -> RedisResult<Vec<Self>>

Convert bytes to a single element vector.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Routable for Value

fn arg_idx(&self, idx: usize) -> Option<&[u8]>

Returns a reference to the data for the argument at idx.

fn position(&self, candidate: &[u8]) -> Option<usize>

Returns index of argument that matches candidate, if it exists

fn command(&self) -> Option<Vec<u8>>

Convenience function to return ascii uppercase version of the the first argument (i.e., the command).

impl Eq for Value

impl StructuralPartialEq for Value