Skip to main content

Command

Trait Command 

Source
pub trait Command: Send + 'static {
    type Response: Send + 'static;

    // Required methods
    fn to_frame(&self) -> Frame;
    fn parse_response(&self, frame: Frame) -> Result<Self::Response, RedisError>;
    fn name(&self) -> &str;

    // Provided methods
    fn idempotent(&self) -> bool { ... }
    fn is_blocking(&self) -> bool { ... }
    fn deadline(&self) -> Option<Instant> { ... }
}
Expand description

A typed Redis command.

Each Redis command is represented as a struct that implements this trait. The associated Response type ensures compile-time type safety for command results.

§Example

use redis_tower_core::{Command, Frame, RedisError};
use redis_tower_protocol::helpers::{array, bulk};

pub struct Ping;

impl Command for Ping {
    type Response = String;

    fn to_frame(&self) -> Frame {
        array(vec![bulk("PING")])
    }

    fn parse_response(&self, frame: Frame) -> Result<String, RedisError> {
        match frame {
            Frame::SimpleString(s) => Ok(String::from_utf8_lossy(&s).into_owned()),
            _ => Err(RedisError::UnexpectedResponse {
                expected: "simple string",
                actual: format!("{frame:?}"),
            }),
        }
    }

    fn name(&self) -> &str { "PING" }
}

Required Associated Types§

Source

type Response: Send + 'static

The typed response this command produces.

Required Methods§

Source

fn to_frame(&self) -> Frame

Serialize this command into a RESP frame for the wire.

Source

fn parse_response(&self, frame: Frame) -> Result<Self::Response, RedisError>

Parse a RESP response frame into the typed response.

Takes &self so that parsing can depend on command configuration (e.g., optional flags that change the response shape).

Source

fn name(&self) -> &str

The Redis command name, for observability (metrics, tracing spans).

Provided Methods§

Source

fn idempotent(&self) -> bool

Whether this command is safe to retry on connection errors.

Returns true for read-only commands (GET, HGET, LRANGE, etc.) and commands where re-execution produces the same result (e.g. SET without side-effect sub-commands). Returns false (the default) for all other write commands where retrying may cause silent data duplication.

Override this method in command implementations to declare idempotency.

Source

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.

Returns false by default. This matters for multiplexed clients: a blocking command holds the single shared pipeline worker for its entire duration, stalling every other concurrent caller on that connection. Run blocking commands on a dedicated RedisConnection or a pooled connection instead. The flag lets callers and middleware detect such commands.

Source

fn deadline(&self) -> Option<Instant>

Return the absolute deadline attached to this command, if any.

Most commands have no deadline. WithDeadline overrides this method so deadline-aware middleware and resource acquisition can share one end-to-end budget instead of starting a fresh timeout at each stage. Implementations that wrap another command should propagate the wrapped command’s deadline.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§

Source§

impl Command for AclCat

Source§

impl Command for AclDelUser

Source§

impl Command for AclDryRun

Source§

impl Command for AclGenPass

Source§

impl Command for AclGetUser

Source§

impl Command for AclHelp

Source§

impl Command for AclList

Source§

impl Command for AclLoad

Source§

impl Command for AclLog

Source§

impl Command for AclLogReset

Source§

impl Command for AclSave

Source§

impl Command for AclSetUser

Source§

impl Command for AclUsers

Source§

impl Command for AclWhoAmI

Source§

impl Command for Append

Source§

impl Command for ArCount

Source§

impl Command for ArDel

Source§

impl Command for ArDelRange

Source§

impl Command for ArGet

Source§

impl Command for ArGetRange

Source§

impl Command for ArGrep

Source§

impl Command for ArInfo

Source§

impl Command for ArInsert

Source§

impl Command for ArLastItems

Source§

impl Command for ArLen

Source§

impl Command for ArMGet

Source§

impl Command for ArMSet

Source§

impl Command for ArNext

Source§

impl Command for ArOp

Source§

impl Command for ArRing

Source§

impl Command for ArScan

Source§

impl Command for ArSeek

Source§

impl Command for ArSet

Source§

impl Command for Auth

Source§

impl Command for BLMove

Source§

impl Command for BLPop

Source§

impl Command for BRPop

Source§

impl Command for BZMPop

Source§

impl Command for BZPopMax

Source§

impl Command for BZPopMin

Source§

impl Command for BfAdd

Source§

impl Command for BfCard

Source§

impl Command for BfExists

Source§

impl Command for BfInfo

Source§

impl Command for BfInsert

Source§

impl Command for BfLoadChunk

Source§

impl Command for BfMAdd

Source§

impl Command for BfMExists

Source§

impl Command for BfReserve

Source§

impl Command for BfScanDump

Source§

impl Command for BgRewriteAof

Source§

impl Command for BgSave

Source§

impl Command for BitCount

Source§

impl Command for BitOp

Source§

impl Command for BitPos

Source§

impl Command for Bitfield

Source§

impl Command for BitfieldRo

Source§

impl Command for BlMPop

Source§

impl Command for CfAdd

Source§

impl Command for CfAddNx

Source§

impl Command for CfCount

Source§

impl Command for CfDel

Source§

impl Command for CfExists

Source§

impl Command for CfInfo

Source§

impl Command for CfInsert

Source§

impl Command for CfInsertNx

Source§

impl Command for CfLoadChunk

Source§

impl Command for CfMExists

Source§

impl Command for CfReserve

Source§

impl Command for CfScanDump

Source§

impl Command for ClientCaching

Source§

impl Command for ClientGetName

Source§

impl Command for ClientGetRedir

Source§

impl Command for ClientHelp

Source§

impl Command for ClientId

Source§

impl Command for ClientInfo

Source§

impl Command for ClientKill

Source§

impl Command for ClientList

Source§

impl Command for ClientNoEvict

Source§

impl Command for ClientNoTouch

Source§

impl Command for ClientPause

Source§

impl Command for ClientReply

Source§

impl Command for ClientSetInfoLibName

Source§

impl Command for ClientSetInfoLibVer

Source§

impl Command for ClientSetName

Source§

impl Command for ClientTracking

Source§

impl Command for ClientTrackingInfo

Source§

impl Command for ClientUnblock

Source§

impl Command for ClientUnpause

Source§

impl Command for ClusterAddSlots

Source§

impl Command for ClusterAddSlotsRange

Source§

impl Command for ClusterBumpEpoch

Source§

impl Command for ClusterCountKeysInSlot

Source§

impl Command for ClusterDelSlots

Source§

impl Command for ClusterDelSlotsRange

Source§

impl Command for ClusterFailover

Source§

impl Command for ClusterFlushSlots

Source§

impl Command for ClusterForget

Source§

impl Command for ClusterGetKeysInSlot

Source§

impl Command for ClusterHelp

Source§

impl Command for ClusterInfo

Source§

impl Command for ClusterKeySlot

Source§

impl Command for ClusterMeet

Source§

impl Command for ClusterMyId

Source§

impl Command for ClusterNodes

Source§

impl Command for ClusterReplicas

Source§

impl Command for ClusterReplicate

Source§

impl Command for ClusterReset

Source§

impl Command for ClusterSaveConfig

Source§

impl Command for ClusterSetConfigEpoch

Source§

impl Command for ClusterSetSlot

Source§

impl Command for ClusterShards

Source§

impl Command for ClusterSlaves

Source§

impl Command for ClusterSlots

Source§

impl Command for CmsIncrBy

Source§

impl Command for CmsInfo

Source§

impl Command for CmsInitByDim

Source§

impl Command for CmsInitByProb

Source§

impl Command for CmsMerge

Source§

impl Command for CmsQuery

Source§

impl Command for CommandCount

Source§

impl Command for CommandDocs

Source§

impl Command for CommandGetKeys

Source§

impl Command for CommandGetKeysAndFlags

Source§

impl Command for CommandHelp

Source§

impl Command for CommandInfo

Source§

impl Command for CommandList

Source§

impl Command for CommandOverview

Source§

impl Command for ConfigGet

Source§

impl Command for ConfigHelp

Source§

impl Command for ConfigResetStat

Source§

impl Command for ConfigRewrite

Source§

impl Command for ConfigSet

Source§

impl Command for Copy

Source§

impl Command for DbSize

Source§

impl Command for DebugHelp

Source§

impl Command for Decr

Source§

impl Command for DecrBy

Source§

impl Command for Del

Source§

impl Command for DelEx

Source§

impl Command for Digest

Source§

impl Command for Discard

Source§

impl Command for Dump

Source§

impl Command for Echo

Source§

impl Command for Eval

Source§

impl Command for EvalRo

Source§

impl Command for EvalSha

Source§

impl Command for EvalShaRo

Source§

impl Command for Exec

Source§

impl Command for Exists

Source§

impl Command for Expire

Source§

impl Command for ExpireAt

Source§

impl Command for ExpireTime

Source§

impl Command for FCall

Source§

impl Command for FCallRo

Source§

impl Command for Failover

Source§

impl Command for FlushAll

Source§

impl Command for FlushDb

Source§

impl Command for FtAggregate

Source§

impl Command for FtAliasAdd

Source§

impl Command for FtAliasDel

Source§

impl Command for FtAliasUpdate

Source§

impl Command for FtAlter

Source§

impl Command for FtConfigGet

Source§

impl Command for FtConfigSet

Source§

impl Command for FtCreate

Source§

impl Command for FtCursorDel

Source§

impl Command for FtCursorRead

Source§

impl Command for FtDictAdd

Source§

impl Command for FtDictDel

Source§

impl Command for FtDictDump

Source§

impl Command for FtDropIndex

Source§

impl Command for FtExplain

Source§

impl Command for FtExplainCli

Source§

impl Command for FtHybrid

Source§

impl Command for FtInfo

Source§

impl Command for FtList

Source§

impl Command for FtProfile

Source§

impl Command for FtSearch

Source§

impl Command for FtSpellCheck

Source§

impl Command for FtSugAdd

Source§

impl Command for FtSugDel

Source§

impl Command for FtSugGet

Source§

impl Command for FtSugLen

Source§

impl Command for FtSynDump

Source§

impl Command for FtSynUpdate

Source§

impl Command for FtTagVals

Source§

impl Command for FunctionDelete

Source§

impl Command for FunctionDump

Source§

impl Command for FunctionFlush

Source§

impl Command for FunctionHelp

Source§

impl Command for FunctionKill

Source§

impl Command for FunctionList

Source§

impl Command for FunctionLoad

Source§

impl Command for FunctionRestore

Source§

impl Command for FunctionStats

Source§

impl Command for GeoAdd

Source§

impl Command for GeoDist

Source§

impl Command for GeoHash

Source§

impl Command for GeoPos

Source§

impl Command for GeoSearch

Source§

impl Command for GeoSearchStore

Source§

impl Command for Get

Source§

impl Command for GetBit

Source§

impl Command for GetDel

Source§

impl Command for GetEx

Source§

impl Command for GetRange

Source§

impl Command for GetSet

Source§

impl Command for HDel

Source§

impl Command for HExists

Source§

impl Command for HExpire

Source§

impl Command for HExpireAt

Source§

impl Command for HExpireTime

Source§

impl Command for HGet

Source§

impl Command for HGetAll

Source§

impl Command for HGetDel

Source§

impl Command for HGetEx

Source§

impl Command for HIncrBy

Source§

impl Command for HIncrByFloat

Source§

impl Command for HKeys

Source§

impl Command for HLen

Source§

impl Command for HMGet

Source§

impl Command for HPExpire

Source§

impl Command for HPExpireAt

Source§

impl Command for HPExpireTime

Source§

impl Command for HPTtl

Source§

impl Command for HPersist

Source§

impl Command for HRandField

Source§

impl Command for HScan

Source§

impl Command for HSet

Source§

impl Command for HSetEx

Source§

impl Command for HSetNx

Source§

impl Command for HStrLen

Source§

impl Command for HTtl

Source§

impl Command for HVals

Source§

impl Command for Hello

Source§

impl Command for HotkeysGet

Source§

impl Command for HotkeysHelp

Source§

impl Command for HotkeysReset

Source§

impl Command for HotkeysStart

Source§

impl Command for HotkeysStop

Source§

impl Command for Incr

Source§

impl Command for IncrBy

Source§

impl Command for IncrByFloat

Source§

impl Command for IncrEx

Source§

impl Command for Info

Source§

impl Command for JsonArrAppend

Source§

impl Command for JsonArrIndex

Source§

impl Command for JsonArrInsert

Source§

impl Command for JsonArrLen

Source§

impl Command for JsonArrPop

Source§

impl Command for JsonArrTrim

Source§

impl Command for JsonClear

Source§

impl Command for JsonDebugMemory

Source§

impl Command for JsonDel

Source§

impl Command for JsonForget

Source§

impl Command for JsonGet

Source§

impl Command for JsonMGet

Source§

impl Command for JsonMSet

Source§

impl Command for JsonMerge

Source§

impl Command for JsonNumIncrBy

Source§

impl Command for JsonObjKeys

Source§

impl Command for JsonObjLen

Source§

impl Command for JsonSet

Source§

impl Command for JsonStrAppend

Source§

impl Command for JsonStrLen

Source§

impl Command for JsonToggle

Source§

impl Command for JsonType

Source§

impl Command for Keys

Source§

impl Command for LIndex

Source§

impl Command for LInsert

Source§

impl Command for LLen

Source§

impl Command for LMPop

Source§

impl Command for LMove

Source§

impl Command for LPop

Source§

impl Command for LPopCount

Source§

impl Command for LPos

Source§

impl Command for LPush

Source§

impl Command for LPushX

Source§

impl Command for LRange

Source§

impl Command for LRem

Source§

impl Command for LSet

Source§

impl Command for LTrim

Source§

impl Command for LastSave

Source§

impl Command for LatencyDoctor

Source§

impl Command for LatencyGraph

Source§

impl Command for LatencyHelp

Source§

impl Command for LatencyHistogram

Source§

impl Command for LatencyHistory

Source§

impl Command for LatencyLatest

Source§

impl Command for LatencyReset

Source§

impl Command for Lcs

Source§

impl Command for Lolwut

Source§

impl Command for MGet

Source§

impl Command for MSet

Source§

impl Command for MSetEx

Source§

impl Command for MSetNx

Source§

impl Command for MemoryDoctor

Source§

impl Command for MemoryHelp

Source§

impl Command for MemoryMallocStats

Source§

impl Command for MemoryPurge

Source§

impl Command for MemoryStats

Source§

impl Command for MemoryUsage

Source§

impl Command for Migrate

Source§

impl Command for ModuleHelp

Source§

impl Command for ModuleList

Source§

impl Command for ModuleLoad

Source§

impl Command for ModuleLoadEx

Source§

impl Command for ModuleUnload

Source§

impl Command for Monitor

Source§

impl Command for Move

Source§

impl Command for Multi

Source§

impl Command for ObjectEncoding

Source§

impl Command for ObjectFreq

Source§

impl Command for ObjectHelp

Source§

impl Command for ObjectIdleTime

Source§

impl Command for ObjectRefCount

Source§

impl Command for PExpire

Source§

impl Command for PExpireAt

Source§

impl Command for PExpireTime

Source§

impl Command for PSetEx

Source§

impl Command for Persist

Source§

impl Command for PfAdd

Source§

impl Command for PfCount

Source§

impl Command for PfMerge

Source§

impl Command for Ping

Source§

impl Command for Pttl

Source§

impl Command for PubSubChannels

Source§

impl Command for PubSubHelp

Source§

impl Command for PubSubNumPat

Source§

impl Command for PubSubNumSub

Source§

impl Command for PubSubShardChannels

Source§

impl Command for PubSubShardNumSub

Source§

impl Command for Publish

Source§

impl Command for RPop

Source§

impl Command for RPopCount

Source§

impl Command for RPush

Source§

impl Command for RPushX

Source§

impl Command for RandomKey

Source§

impl Command for RawCommand

Source§

impl Command for Rename

Source§

impl Command for RenameNx

Source§

impl Command for ReplicaOf

Source§

impl Command for Reset

Source§

impl Command for Restore

Source§

impl Command for Role

Source§

impl Command for SAdd

Source§

impl Command for SCard

Source§

impl Command for SDiff

Source§

impl Command for SDiffStore

Source§

impl Command for SInter

Source§

impl Command for SInterCard

Source§

impl Command for SInterStore

Source§

impl Command for SIsMember

Source§

impl Command for SMembers

Source§

impl Command for SMisMember

Source§

impl Command for SMove

Source§

impl Command for SPop

Source§

impl Command for SPublish

Source§

impl Command for SRandMember

Source§

impl Command for SRem

Source§

impl Command for SScan

Source§

impl Command for SUnion

Source§

impl Command for SUnionStore

Source§

impl Command for Save

Source§

impl Command for Scan

Source§

impl Command for ScriptDebug

Source§

impl Command for ScriptExists

Source§

impl Command for ScriptFlush

Source§

impl Command for ScriptHelp

Source§

impl Command for ScriptKill

Source§

impl Command for ScriptLoad

Source§

impl Command for Select

Source§

impl Command for Set

Source§

impl Command for SetBit

Source§

impl Command for SetEx

Source§

impl Command for SetNx

Source§

impl Command for SetRange

Source§

impl Command for SetWithOutcome

Source§

impl Command for Shutdown

Source§

impl Command for SlowlogGet

Source§

impl Command for SlowlogHelp

Source§

impl Command for SlowlogLen

Source§

impl Command for SlowlogReset

Source§

impl Command for Sort

Source§

impl Command for SortRo

Source§

impl Command for StrLen

Source§

impl Command for SwapDb

Source§

impl Command for TdigestAdd

Source§

impl Command for TdigestByRank

Source§

impl Command for TdigestByRevRank

Source§

impl Command for TdigestCdf

Source§

impl Command for TdigestCreate

Source§

impl Command for TdigestInfo

Source§

impl Command for TdigestMax

Source§

impl Command for TdigestMerge

Source§

impl Command for TdigestMin

Source§

impl Command for TdigestQuantile

Source§

impl Command for TdigestRank

Source§

impl Command for TdigestReset

Source§

impl Command for TdigestRevRank

Source§

impl Command for TdigestTrimmedMean

Source§

impl Command for Time

Source§

impl Command for TopkAdd

Source§

impl Command for TopkCount

Source§

impl Command for TopkIncrBy

Source§

impl Command for TopkInfo

Source§

impl Command for TopkList

Source§

impl Command for TopkQuery

Source§

impl Command for TopkReserve

Source§

impl Command for Touch

Source§

impl Command for TsAdd

Source§

impl Command for TsAlter

Source§

impl Command for TsCreate

Source§

impl Command for TsCreateRule

Source§

impl Command for TsDecrBy

Source§

impl Command for TsDel

Source§

impl Command for TsDeleteRule

Source§

impl Command for TsGet

Source§

impl Command for TsIncrBy

Source§

impl Command for TsInfo

Source§

impl Command for TsMAdd

Source§

impl Command for TsMGet

Source§

impl Command for TsMRange

Source§

impl Command for TsMRevRange

Source§

impl Command for TsQueryIndex

Source§

impl Command for TsRange

Source§

impl Command for TsRevRange

Source§

impl Command for Ttl

Source§

impl Command for Type

Source§

impl Command for Unwatch

Source§

impl Command for VAdd

Source§

impl Command for VCard

Source§

impl Command for VDelAttr

Source§

impl Command for VDim

Source§

impl Command for VEmb

Source§

impl Command for VGetAttr

Source§

impl Command for VInfo

Source§

impl Command for VIsMember

Source§

impl Command for VRandMember

Source§

impl Command for VRange

Source§

impl Command for VRem

Source§

impl Command for VSetAttr

Source§

impl Command for VSim

Source§

impl Command for Wait

Source§

impl Command for WaitAof

Source§

impl Command for Watch

Source§

impl Command for XAck

Source§

impl Command for XAckDel

Source§

impl Command for XAdd

Source§

impl Command for XAutoClaim

Source§

impl Command for XCfgSet

Source§

impl Command for XClaim

Source§

impl Command for XDel

Source§

impl Command for XDelEx

Source§

impl Command for XGroupCreate

Source§

impl Command for XGroupCreateConsumer

Source§

impl Command for XGroupDelConsumer

Source§

impl Command for XGroupDestroy

Source§

impl Command for XGroupHelp

Source§

impl Command for XGroupSetId

Source§

impl Command for XIdmpRecord

Source§

impl Command for XInfoConsumers

Source§

impl Command for XInfoGroups

Source§

impl Command for XInfoHelp

Source§

impl Command for XInfoStream

Source§

impl Command for XLen

Source§

impl Command for XNack

Source§

impl Command for XPendingRange

Source§

impl Command for XPendingSummary

Source§

impl Command for XRange

Source§

impl Command for XRead

Source§

impl Command for XReadGroup

Source§

impl Command for XRevRange

Source§

impl Command for XSetId

Source§

impl Command for XTrim

Source§

impl Command for ZAdd

Source§

impl Command for ZAddIncr

Source§

impl Command for ZCard

Source§

impl Command for ZCount

Source§

impl Command for ZDiff

Source§

impl Command for ZDiffStore

Source§

impl Command for ZDiffWithScores

Source§

impl Command for ZIncrBy

Source§

impl Command for ZInter

Source§

impl Command for ZInterCard

Source§

impl Command for ZInterStore

Source§

impl Command for ZInterWithScores

Source§

impl Command for ZLexCount

Source§

impl Command for ZMPop

Source§

impl Command for ZMScore

Source§

impl Command for ZPopMax

Source§

impl Command for ZPopMin

Source§

impl Command for ZRandMember

Source§

impl Command for ZRange

Source§

impl Command for ZRangeByLex

Source§

impl Command for ZRangeByScore

Source§

impl Command for ZRangeStore

Source§

impl Command for ZRank

Source§

impl Command for ZRem

Source§

impl Command for ZRemRangeByLex

Source§

impl Command for ZRemRangeByRank

Source§

impl Command for ZRemRangeByScore

Source§

impl Command for ZRevRange

Source§

impl Command for ZRevRangeByLex

Source§

impl Command for ZRevRangeByScore

Source§

impl Command for ZRevRangeByScoreWithScores

Source§

impl Command for ZRevRangeWithScores

Source§

impl Command for ZRevRank

Source§

impl Command for ZScan

Source§

impl Command for ZScore

Source§

impl Command for ZUnion

Source§

impl Command for ZUnionStore

Source§

impl Command for ZUnionWithScores

Source§

impl<C> Command for WithDeadline<C>
where C: Command,

Source§

impl<T> Command for TypedRawCommand<T>
where T: FromFrame + Send + 'static,