Trait 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 num_of_args(&self) -> usize { ... }
}

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 num_of_args(&self) -> usize

Returns the number of arguments this value will generate.

This is used in some high level functions to intelligently switch between GET and MGET variants. Also, for some commands like HEXPIREDAT which require a specific number of arguments, this method can be used to know the number of arguments.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl ToRedisArgs for &str

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

where W: ?Sized + RedisWrite,

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 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, T> ToRedisArgs for Cow<'a, T>

where T: ToOwned + ?Sized, &'a T: ToRedisArgs, for<'b> &'b T::Owned: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

impl<'a, T> ToRedisArgs for &'a T

where T: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

fn describe_numeric_behavior(&self) -> NumericBehavior

impl<'a, T> ToRedisArgs for &'a mut T

where T: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

fn describe_numeric_behavior(&self) -> NumericBehavior

impl<K, V> ToRedisArgs for BTreeMap<K, V>

where K: ToRedisArgs + Hash + Eq + Ord, V: ToRedisArgs,

this flattens BTreeMap into something that goes well with HMSET

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

impl<K, V> ToRedisArgs for HashMap<K, V>

where K: ToRedisArgs + Hash + Eq + Ord, V: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

impl<T> ToRedisArgs for Box<T>

where T: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

fn describe_numeric_behavior(&self) -> NumericBehavior

impl<T> ToRedisArgs for BTreeSet<T>

where T: ToRedisArgs + Hash + Eq + Ord,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

impl<T> ToRedisArgs for Rc<T>

where T: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

fn describe_numeric_behavior(&self) -> NumericBehavior

impl<T> ToRedisArgs for Arc<T>

where T: ToRedisArgs,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

fn describe_numeric_behavior(&self) -> NumericBehavior

impl<T, S> ToRedisArgs for HashSet<T, S>

where T: ToRedisArgs + Hash + Eq, S: BuildHasher + Default,

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

impl<T: ToRedisArgs> ToRedisArgs for &[T]

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

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 num_of_args(&self) -> usize

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

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

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

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

where W: ?Sized + RedisWrite,

fn num_of_args(&self) -> usize

Implementors

impl ToRedisArgs for Direction

impl ToRedisArgs for ExpireOption

impl ToRedisArgs for FlushAllOptions

impl ToRedisArgs for LposOptions

impl ToRedisArgs for ScanOptions

impl ToRedisArgs for SetOptions