Enum RedisModuleCommandArgKind

#[repr(u32)]
pub enum RedisModuleCommandArgKind {
    String = 0,
    Integer = 1,
    Double = 2,
    Key = 3,
    Pattern = 4,
    UnixTime = 5,
    PureToken = 6,
    OneOf = 7,
    Block = 8,
}

Variants

String = 0

String argument.

Integer = 1

Integer argument.

Double = 2

Double-precision float argument.

Key = 3

String argument representing a keyname.

Pattern = 4

String, but regex pattern.

UnixTime = 5

Integer, but Unix timestamp.

PureToken = 6

Argument doesn’t have a placeholder. It’s just a token without a value. Example: the KEEPTTL option of the SET command.

OneOf = 7

Used when the user can choose only one of a few sub-arguments. Requires subargs. Example: the NX and XX options of SET.

Block = 8

Used when one wants to group together several sub-arguments, usually to apply something on all of them, like making the entire group “optional”. Requires subargs. Example: the LIMIT offset count parameters in ZRANGE.

Trait Implementations

impl Clone for RedisModuleCommandArgKind

fn clone(&self) -> RedisModuleCommandArgKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisModuleCommandArgKind

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

Formats the value using the given formatter.

impl Hash for RedisModuleCommandArgKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RedisModuleCommandArgKind

fn cmp(&self, other: &RedisModuleCommandArgKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RedisModuleCommandArgKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for RedisModuleCommandArgKind

fn partial_cmp(&self, other: &RedisModuleCommandArgKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RedisModuleCommandArgKind

impl Eq for RedisModuleCommandArgKind

impl StructuralPartialEq for RedisModuleCommandArgKind