Struct IncrexResult 

#[non_exhaustive]
pub struct IncrexResult {
    pub value: Value,
    pub actual_increment: Value,
}

The two-element reply of the INCREX command.

Each field holds the raw Value returned by the server. For BYINT operations this is an integer, while for BYFLOAT it is a bulk string (RESP2) or double (RESP3). Decode a field into a concrete type with value_as / actual_increment_as

• e.g. i64 for BYINT or f64 (or a wider type such as bigdecimal::BigDecimal) for BYFLOAT.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: Value

The key’s value after the increment.

actual_increment: Value

The increment that was actually applied.

This is 0 when the default policy (when SATURATE is not set) rejected an out-of-bounds operation. In that case value holds the unchanged current value and the TTL is left untouched. When SATURATE is set, it clamps the result to a bound. This reflects the clamped delta, which may differ from the requested increment.

Implementations

impl IncrexResult

pub fn value_as<T: FromRedisValue>(&self) -> Result<T, ParsingError>

Decode value into the desired type.

• e.g. i64 for BYINT operations and f64 or a wider type for BYFLOAT operations.

pub fn actual_increment_as<T: FromRedisValue>(&self) -> Result<T, ParsingError>

Decode actual_increment into the desired type.

• e.g. i64 for BYINT operations and f64 or a wider type for BYFLOAT operations.

pub fn as_i64(&self) -> Result<(i64, i64), ParsingError>

Decode both fields as i64, the natural type for a BYINT result, returning (value, actual_increment).

pub fn as_f64(&self) -> Result<(f64, f64), ParsingError>

Decode both fields as f64, the natural type for a BYFLOAT result, returning (value, actual_increment).

Trait Implementations

impl Clone for IncrexResult

fn clone(&self) -> IncrexResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncrexResult

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

Formats the value using the given formatter.

impl FromRedisValue for IncrexResult

fn from_redis_value(v: Value) -> Result<Self, ParsingError>

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_value_ref(v: &Value) -> Result<Self, ParsingError>

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_value_refs(items: &[Value]) -> Result<Vec<Self>, ParsingError>

Similar to from_redis_value_ref 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_redis_values(items: Vec<Value>) -> Result<Vec<Self>, ParsingError>

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

fn from_each_redis_values(items: Vec<Value>) -> Vec<Result<Self, ParsingError>>

The same as from_redis_values, but returns a result for each conversion to make handling them case-by-case possible.

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

Convert bytes to a single element vector.

fn from_byte_vec(_vec: Vec<u8>) -> Result<Vec<Self>, ParsingError>

Convert bytes to a single element vector.

impl PartialEq for IncrexResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IncrexResult