Struct CommandArgument

pub struct CommandArgument {
    pub name: String,
    pub display_text: String,
    pub type_: CommandArgumentType,
    pub key_spec_index: usize,
    pub token: String,
    pub summary: String,
    pub since: String,
    pub deprecated_since: String,
    pub flags: Vec<ArgumentFlag>,
    pub value: Vec<String>,
}

command argument

Fields

name: String

the argument’s name, always present.

display_text: String

the argument’s display string, present in arguments that have a displayable representation

type_: CommandArgumentType

the argument’s type, always present.

key_spec_index: usize

this value is available for every argument of the key type. t is a 0-based index of the specification in the command’s key specifications that corresponds to the argument.

token: String

a constant literal that precedes the argument (user input) itself.

summary: String

a short description of the argument.

since: String

the debut Redis version of the argument (or for module commands, the module version).

deprecated_since: String

the Redis version that deprecated the command (or for module commands, the module version).

flags: Vec<ArgumentFlag>

an array of argument flags.

value: Vec<String>

the argument’s value.

Trait Implementations

impl Debug for CommandArgument

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

Formats the value using the given formatter.

impl FromValue for CommandArgument

fn from_value(value: Value) -> Result<Self>

Used to do Value to user type conversion

fn from_value_with_command(value: Value, _command: &Command) -> Result<Self>

fn next_functor<I: Iterator<Item = Value>>() -> Box<dyn FnMut(&mut I) -> Option<Result<Self>>>