Expand description
A Redis client for Rust
Modules§
Structs§
- AclCat
Options - Options for the
acl_catcommand - AclDry
RunOptions - Options for the
acl_dryruncommand - AclGen
Pass Options - Options for the
acl_genpasscommand - AclLog
Options - Options for the
acl_logcommand - BitField
GetSub Command - BitRange
- Interval options for the
bitcountcommand - Cache
- Call
Builder - Builder for calling a script/function for the following commands:
- Client
- Client with a unique connection to a Redis server.
- Client
Info - Client info results for the
client_info&client_listcommands. - Client
Kill Options - Options for the
client-killcommand. - Client
List Options - Options for the client_list command.
- Client
List Result - Result for the
client_listcommand. - Client
Tracking Info - Result for the
client_trackinginfocommand. - Client
Tracking Options - Options for the
client_trackingcommand. - Cluster
Config - Configuration for connecting to a Redis Cluster
- Cluster
Info - Result for the
cluster_infocommand - Cluster
Link Info - Result for the
cluster_linkscommand - Cluster
Node Result - Cluster node result for the
cluster_shardscommand. - Cluster
Shard Result - Result for the
cluster_shardscommand. - Command
Argument command argument- Command
Doc - Command doc result for the
command_docscommand - Command
Histogram - Command Histogram for the
latency_histogramcommands. - Command
Info - Command info result for the
commandcommand. - Command
List Options - Options for the
command_listcommand. - Config
- Database
Overhead - Dump
Result - Result for the
dumpcommand. - Engine
Stats - Fail
Over Options - Options for the
failovercommand. - Function
Info - Function
List Options - Options for the
function_listcommand - Function
Stats - GeoSearch
Options - Options for the
geosearchcommand - GeoSearch
Result - Result of the
geosearchcommand. - GeoSearch
Store Options - Options for the
geosearchstorecommand - HScan
Options - Options for the
hscancommand - Hello
Options - Options for the
hellocommand. - Hello
Result - Historical
Note - KeySpecification
- Key specifications of a command for the
commandcommand. - LcsResult
- Result for the
lcscommand - Library
Info - LolWut
Options - Options for the
lolwutcommand - Memory
Stats - Result for the
memory_statscommand. - Memory
Usage Options - Options for the
memory_usagecommand - Migrate
Options - Module
Info - Module information result for the
module_listcommand. - Module
Load Options - Options for the
module_loadcommand - Monitor
Stream - Stream to get
MONITORcommand events when the stream is dropped or closed, a reset command is sent to the Redis server - Monitored
Command Info - Multiplexed
Client - A multiplexed client that can be cloned, allowing requests to be be sent concurrently on the same underlying connection.
- Ping
Options - Options for the
pingcommand. - Pipeline
- Prepared
Command - PubSub
Channels Options - Options for the
pub_sub_channelscommand - PubSub
Stream - Stream to get messages from the channels or patterns
subscribedto - Redis
Error - Error issued by the Redis server
- Replica
Info - Represents a connected replicas to a master
- Replica
OfOptions - options for the
replicaofcommand. - Restore
Options - Options for the
restorecommand - Running
Script - SScan
Options - Options for the
sscancommand - Scan
Options - Options for the
scancommand - Sentinel
Config - Configuration for connecting to a Redis via Sentinel
- Sentinel
Info - Sentinel
Master Info - Sentinel
Replica Info - Shutdown
Options - options for the
shutdowncommand. - Slow
LogEntry - Result
slowlog_getfor the command. - Slow
LogOptions - options for the
slowlog_getcommand. - Sort
Options - Options for the
sortcommand - Stream
Entry - Transaction
- Represents an on-going
transactionon a specific client instance. - XAdd
Options - Stream Add options for the
xaddcommand. - XAuto
Claim Options - Options for the
xautoclaimcommand - XAuto
Claim Result - XClaim
Options - Options for the
xclaimcommand - XConsumer
Info - Result entry for the
xinfo_consumerscommand. - XGroup
Create Options - Options for the
xgroup_createcommand - XGroup
Info - Result entry for the
xinfo_groupscommand. - XInfo
Stream Options - Options for the
xinfo_streamcommand - XPending
Consumer - Customer info result for the
xpendingcommand - XPending
Message Result - Message result for the
xpending_with_optionscommand - XPending
Options - Options for the
xpending_with_optionscommand - XPending
Result - Result for the
xpendingcommand - XRead
Group Options - Options for the
xreadgroupcommand - XRead
Options - Options for the
xreadcommand - XStream
Info - Stream info returned by the
xinfo_streamcommand. - XTrim
Options - Stream Trim options for the
xaddandxtrimcommands - ZAdd
Options - Options for the
zaddcommand. - ZRange
Options - Options for the
zrangeandzrangestorecommands - ZScan
Options - Options for the
zscancommand
Enums§
- Argument
Flag - Flag for a command argument
- Begin
Search - BitField
Overflow - BitField
SubCommand - Sub-command for the
bitfieldcommand - BitOperation
- Bit operation for the
bitopcommand. - BitUnit
- Client
Caching Mode - Client caching mode for the
client_cachingcommand. - Client
Pause Mode - Mode options for the
client_pausecommand. - Client
Reply Mode - Mode options for the
client_replycommand. - Client
Tracking Status - Status options for the
client_trackingcommand. - Client
Type - Client type options for the
client_listcommand. - Client
Unblock Mode - Mode options for the
client_unblockcommand. - Cluster
Bump Epoch Result - Result for the
cluster_bumpepochcommand - Cluster
Failover Option - Options for the
cluster_failovercommand - Cluster
Health Status - Cluster health status for the
cluster_shardscommand. - Cluster
Link Direction - This link is established by the local node to the peer, or accepted by the local node from the peer.
- Cluster
Reset Type - Type of
cluster reset - Cluster
SetSlot SubCommand - Subcommand for the
cluster_setslotcommand. - Cluster
State - Cluster state used in the
cluster_statefield ofClusterInfo - Command
Argument Type - An argument must have one of the following types:
- Command
DocFlag - Command documenation flag
- Command
Tip - Get additional information about a command
- Error
- All error kinds
- Expire
Option - Options for the
expirecommand - Find
Keys - Flushing
Mode - Database flushing mode
- Function
Restore Policy - Policy option for the
function_restorecommand. - GeoAdd
Condition - Condition for the
geoaddcommand - GeoSearch
By - The query’s shape is provided by one of these mandatory options:
- GeoSearch
From - The query’s center point is provided by one of these mandatory options:
- GeoSearch
Order - Matching items are returned unsorted by default. To sort them, use one of the following two options:
- GeoUnit
- Distance Unit
- GetEx
Options - Options for the
getexcommand - Info
Section - Section for the
infocommand. - LInsert
Where - LMove
Where - Latency
History Event - Latency history event for the
latency_graph&latency_historycommands. - Migrate
Result - Result for the
migratecommand - Redis
Error Kind - Redis server error kind
- Replication
State - The state of the replication from the point of view of the master,
- Request
Policy - This tip can help clients determine the shards to send the command in clustering mode.
- Response
Policy - This tip can help clients determine the aggregate they need to compute from the replies of multiple shards in a cluster.
- Retry
Reason Internal Use- Role
Result - Result for the
rolecommand. - Script
Debug Mode - Sentinel
Simulate Failure Mode - Different crash simulation scenario modes for
the
sentinel_simulate_failurecommand - Server
Config - Configuration for connecting to a Redis server
- SetCondition
- Condition option for the
set_with_optionscommand - SetExpiration
- Expiration option for the
set_with_optionscommand - Sort
Order - Order option of the
sortcommand - XTrim
Operator - Stream Trim operator for the
xaddandxtrimcommands - ZAdd
Comparison - Comparison option for the
zaddcommand - ZAdd
Condition - Condition option for the
zaddcommand - ZAggregate
- Option that specify how results of an union or intersection are aggregated
- ZRange
Sort By - sort by option of the
zrangecommand - ZWhere
- Where option of the
zmpopcommand
Traits§
- Bitmap
Commands - A group of Redis commands related to
Bitmaps&Bitfields - Blocking
Commands - A group of blocking commands
- Client
Prepared Command - Client
Trait - Cluster
Commands - A group of Redis commands related to
Cluster Management - Connection
Commands - A group of Redis commands related to connection management
- Generic
Commands - A group of generic Redis commands
- GeoCommands
- A group of Redis commands related to
Geospatialindices - Hash
Commands - A group of Redis commands related to
Hashes - Hyper
LogLog Commands - A group of Redis commands related to
HyperLogLog - Into
Config - List
Commands - A group of Redis commands related to
Lists - Multiplexed
Prepared Command - Pipeline
Prepared Command - PubSub
Commands - A group of Redis commands related to
Pub/Sub - Scripting
Commands - A group of Redis commands related to Scripting and Functions
- Sentinel
Commands - A group of Redis commands related to Sentinel
- Server
Commands - A group of Redis commands related to Server Management
- SetCommands
- A group of Redis commands related to
Sets - Sorted
SetCommands - A group of Redis commands related to
Sorted Sets - Stream
Commands - A group of Redis commands related to
Streams - String
Commands - A group of Redis commands related to
Strings - Transaction
Commands - A group of Redis commands related to Transactions
Type Aliases§
- BZpop
MinMax Result - Future
- Library general future type.
- LcsMatch
- Result
- Library general result type.
- ZMPop
Result