pub struct CommandDocs { /* private fields */ }Expand description
COMMAND DOCS [command-name …]
Returns documentary information about one or more commands. Each command’s documentation is returned as a nested array of key-value pairs.
Implementations§
Source§impl CommandDocs
impl CommandDocs
Sourcepub fn new() -> CommandDocs
pub fn new() -> CommandDocs
Request docs for all commands.
Sourcepub fn command(self, name: impl Into<String>) -> CommandDocs
pub fn command(self, name: impl Into<String>) -> CommandDocs
Request docs for a specific command.
Trait Implementations§
Source§impl Clone for CommandDocs
impl Clone for CommandDocs
Source§fn clone(&self) -> CommandDocs
fn clone(&self) -> CommandDocs
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Command for CommandDocs
impl Command for CommandDocs
Source§fn parse_response(
&self,
frame: Frame,
) -> Result<<CommandDocs as Command>::Response, RedisError>
fn parse_response( &self, frame: Frame, ) -> Result<<CommandDocs as Command>::Response, RedisError>
Parse a RESP response frame into the typed response. Read more
Source§fn idempotent(&self) -> bool
fn idempotent(&self) -> bool
Whether this command is safe to retry on connection errors. Read more
Source§fn is_blocking(&self) -> bool
fn is_blocking(&self) -> bool
Whether this command blocks the connection until data is available or a
timeout elapses –
BLPOP, BRPOP, BLMOVE, BZPOPMIN/BZPOPMAX, and
XREAD/XREADGROUP with BLOCK. Read moreSource§impl Default for CommandDocs
impl Default for CommandDocs
Source§fn default() -> CommandDocs
fn default() -> CommandDocs
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for CommandDocs
impl RefUnwindSafe for CommandDocs
impl Send for CommandDocs
impl Sync for CommandDocs
impl Unpin for CommandDocs
impl UnsafeUnpin for CommandDocs
impl UnwindSafe for CommandDocs
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<C> RequestDeadline for Cwhere
C: Command,
impl<C> RequestDeadline for Cwhere
C: Command,
Source§fn request_deadline(&self) -> Option<Instant>
fn request_deadline(&self) -> Option<Instant>
Return the request’s absolute deadline, if it carries one.