Trait redis::ToRedisArgs

pub trait ToRedisArgs: Sized {
    // Required method
    fn write_redis_args<W>(&self, out: &mut W)
       where W: ?Sized + RedisWrite;

    // Provided methods
    fn to_redis_args(&self) -> Vec<Vec<u8>> { ... }
    fn describe_numeric_behavior(&self) -> NumericBehavior { ... }
    fn is_single_arg(&self) -> bool { ... }
}

Used to convert a value into one or multiple redis argument strings. Most values will produce exactly one item but in some cases it might make sense to produce more than one.

Required Methods

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

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

The exception to this rule currently are vectors of items.

Provided Methods

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.

The exception to this rule currently are vectors of items.

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).

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.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl ToRedisArgs for bool

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for f32

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for f64

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for i8

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for i16

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for i32

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for i64

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for isize

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for u8

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for u16

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for u32

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for u64

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for usize

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for String

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for BigDecimal

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for BigInt

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for BigUint

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for Decimal

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for Uuid

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl ToRedisArgs for NonZeroI8

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroI16

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroI32

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroI64

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroIsize

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroU8

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroU16

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroU32

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroU64

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl ToRedisArgs for NonZeroUsize

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

impl<'a> ToRedisArgs for &'a str

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

impl<'a, T: ToRedisArgs> ToRedisArgs for &'a [T]

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs + Hash + Eq + Ord> ToRedisArgs for BTreeSet<T>

@note: Redis cannot store empty sets so the application has to check whether the set is empty and if so, not attempt to use that result

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs + Hash + Eq + Ord, V: ToRedisArgs> ToRedisArgs for BTreeMap<T, V>

this flattens BTreeMap into something that goes well with HMSET @note: Redis cannot store empty sets so the application has to check whether the set is empty and if so, not attempt to use that result

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs + Hash + Eq + Ord, V: ToRedisArgs> ToRedisArgs for HashMap<T, V>

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs + Hash + Eq, S: BuildHasher + Default> ToRedisArgs for HashSet<T, S>

@note: Redis cannot store empty sets so the application has to check whether the set is empty and if so, not attempt to use that result

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs + Hash + Eq, S: BuildHasher + Default> ToRedisArgs for AHashSet<T, S>

@note: Redis cannot store empty sets so the application has to check whether the set is empty and if so, not attempt to use that result

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs> ToRedisArgs for Option<T>

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn describe_numeric_behavior(&self) -> NumericBehavior

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs> ToRedisArgs for &T

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs> ToRedisArgs for Vec<T>

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

impl<T: ToRedisArgs, const N: usize> ToRedisArgs for &[T; N]

fn write_redis_args<W>(&self, out: &mut W)

where W: ?Sized + RedisWrite,

fn is_single_arg(&self) -> bool

Implementors

impl ToRedisArgs for Rule

Available on crate feature acl only.

impl ToRedisArgs for Direction

impl ToRedisArgs for Unit

Available on crate feature geospatial only.

impl ToRedisArgs for StreamMaxlen

Available on crate feature streams only.

impl ToRedisArgs for RadiusOptions

Available on crate feature geospatial only.

impl ToRedisArgs for StreamClaimOptions

Available on crate feature streams only.

impl ToRedisArgs for StreamReadOptions

Available on crate feature streams only.

impl ToRedisArgs for LposOptions

impl ToRedisArgs for SetOptions

impl<T: ToRedisArgs> ToRedisArgs for Coord<T>

Available on crate feature geospatial only.