Struct rustis::commands::CommandDoc
source · 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>,
}
Expand description
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§
source§impl Debug for CommandDoc
impl Debug for CommandDoc
source§impl Default for CommandDoc
impl Default for CommandDoc
source§fn default() -> CommandDoc
fn default() -> CommandDoc
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for CommandDoc
impl<'de> Deserialize<'de> for CommandDoc
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for CommandDoc
impl RefUnwindSafe for CommandDoc
impl Send for CommandDoc
impl Sync for CommandDoc
impl Unpin for CommandDoc
impl UnwindSafe for CommandDoc
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more