Struct CommandDoc

pub struct CommandDoc {
    pub summary: String,
    pub since: String,
    pub group: String,
    pub complexity: String,
    pub doc_flags: Vec<CommandDocFlag>,
    pub deprecated_since: String,
    pub replaced_by: String,
    pub history: Vec<HistoricalNote>,
    pub arguments: Vec<CommandArgument>,
}

Command doc result for the command_docs command

Fields

summary: String

short command description.

since: String

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

group: String

he functional group to which the command belongs.

complexity: String

a short explanation about the command’s time complexity.

doc_flags: Vec<CommandDocFlag>

an array of documentation flags. Possible values are:

• deprecated: the command is deprecated.
• syscmd: a system command that isn’t meant to be called by users.

deprecated_since: String

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

replaced_by: String

the alternative for a deprecated command.

history: Vec<HistoricalNote>

an array of historical notes describing changes to the command’s behavior or arguments.

arguments: Vec<CommandArgument>

an array of command arguments

Trait Implementations

impl Debug for CommandDoc

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

Formats the value using the given formatter.

impl Default for CommandDoc

fn default() -> CommandDoc

Returns the “default value” for a type.

impl FromValue for CommandDoc

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