Expand description
A Redis client for Rust
Modules§
Structs§
- AclCat
Options - Options for the
acl_cat
command - AclDry
RunOptions - Options for the
acl_dryrun
command - AclGen
Pass Options - Options for the
acl_genpass
command - AclLog
Options - Options for the
acl_log
command - BitField
GetSub Command - BitRange
- Interval options for the
bitcount
command - 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_list
commands. - Client
Kill Options - Options for the
client-kill
command. - Client
List Options - Options for the client_list command.
- Client
List Result - Result for the
client_list
command. - Client
Tracking Info - Result for the
client_trackinginfo
command. - Client
Tracking Options - Options for the
client_tracking
command. - Cluster
Config - Configuration for connecting to a Redis Cluster
- Cluster
Info - Result for the
cluster_info
command - Cluster
Link Info - Result for the
cluster_links
command - Cluster
Node Result - Cluster node result for the
cluster_shards
command. - Cluster
Shard Result - Result for the
cluster_shards
command. - Command
Argument command argument
- Command
Doc - Command doc result for the
command_docs
command - Command
Histogram - Command Histogram for the
latency_histogram
commands. - Command
Info - Command info result for the
command
command. - Command
List Options - Options for the
command_list
command. - Config
- Database
Overhead - Dump
Result - Result for the
dump
command. - Engine
Stats - Fail
Over Options - Options for the
failover
command. - Function
Info - Function
List Options - Options for the
function_list
command - Function
Stats - GeoSearch
Options - Options for the
geosearch
command - GeoSearch
Result - Result of the
geosearch
command. - GeoSearch
Store Options - Options for the
geosearchstore
command - HScan
Options - Options for the
hscan
command - Hello
Options - Options for the
hello
command. - Hello
Result - Historical
Note - KeySpecification
- Key specifications of a command for the
command
command. - LcsResult
- Result for the
lcs
command - Library
Info - LolWut
Options - Options for the
lolwut
command - Memory
Stats - Result for the
memory_stats
command. - Memory
Usage Options - Options for the
memory_usage
command - Migrate
Options - Module
Info - Module information result for the
module_list
command. - Module
Load Options - Options for the
module_load
command - Monitor
Stream - Stream to get
MONITOR
command 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
ping
command. - Pipeline
- Prepared
Command - PubSub
Channels Options - Options for the
pub_sub_channels
command - PubSub
Stream - Stream to get messages from the channels or patterns
subscribed
to - Redis
Error - Error issued by the Redis server
- Replica
Info - Represents a connected replicas to a master
- Replica
OfOptions - options for the
replicaof
command. - Restore
Options - Options for the
restore
command - Running
Script - SScan
Options - Options for the
sscan
command - Scan
Options - Options for the
scan
command - Sentinel
Config - Configuration for connecting to a Redis via Sentinel
- Sentinel
Info - Sentinel
Master Info - Sentinel
Replica Info - Shutdown
Options - options for the
shutdown
command. - Slow
LogEntry - Result
slowlog_get
for the command. - Slow
LogOptions - options for the
slowlog_get
command. - Sort
Options - Options for the
sort
command - Stream
Entry - Transaction
- Represents an on-going
transaction
on a specific client instance. - XAdd
Options - Stream Add options for the
xadd
command. - XAuto
Claim Options - Options for the
xautoclaim
command - XAuto
Claim Result - XClaim
Options - Options for the
xclaim
command - XConsumer
Info - Result entry for the
xinfo_consumers
command. - XGroup
Create Options - Options for the
xgroup_create
command - XGroup
Info - Result entry for the
xinfo_groups
command. - XInfo
Stream Options - Options for the
xinfo_stream
command - XPending
Consumer - Customer info result for the
xpending
command - XPending
Message Result - Message result for the
xpending_with_options
command - XPending
Options - Options for the
xpending_with_options
command - XPending
Result - Result for the
xpending
command - XRead
Group Options - Options for the
xreadgroup
command - XRead
Options - Options for the
xread
command - XStream
Info - Stream info returned by the
xinfo_stream
command. - XTrim
Options - Stream Trim options for the
xadd
andxtrim
commands - ZAdd
Options - Options for the
zadd
command. - ZRange
Options - Options for the
zrange
andzrangestore
commands - ZScan
Options - Options for the
zscan
command
Enums§
- Argument
Flag - Flag for a command argument
- Begin
Search - BitField
Overflow - BitField
SubCommand - Sub-command for the
bitfield
command - BitOperation
- Bit operation for the
bitop
command. - BitUnit
- Client
Caching Mode - Client caching mode for the
client_caching
command. - Client
Pause Mode - Mode options for the
client_pause
command. - Client
Reply Mode - Mode options for the
client_reply
command. - Client
Tracking Status - Status options for the
client_tracking
command. - Client
Type - Client type options for the
client_list
command. - Client
Unblock Mode - Mode options for the
client_unblock
command. - Cluster
Bump Epoch Result - Result for the
cluster_bumpepoch
command - Cluster
Failover Option - Options for the
cluster_failover
command - Cluster
Health Status - Cluster health status for the
cluster_shards
command. - 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_setslot
command. - Cluster
State - Cluster state used in the
cluster_state
field 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
expire
command - Find
Keys - Flushing
Mode - Database flushing mode
- Function
Restore Policy - Policy option for the
function_restore
command. - GeoAdd
Condition - Condition for the
geoadd
command - 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
getex
command - Info
Section - Section for the
info
command. - LInsert
Where - LMove
Where - Latency
History Event - Latency history event for the
latency_graph
&latency_history
commands. - Migrate
Result - Result for the
migrate
command - 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
role
command. - Script
Debug Mode - Sentinel
Simulate Failure Mode - Different crash simulation scenario modes for
the
sentinel_simulate_failure
command - Server
Config - Configuration for connecting to a Redis server
- SetCondition
- Condition option for the
set_with_options
command - SetExpiration
- Expiration option for the
set_with_options
command - Sort
Order - Order option of the
sort
command - XTrim
Operator - Stream Trim operator for the
xadd
andxtrim
commands - ZAdd
Comparison - Comparison option for the
zadd
command - ZAdd
Condition - Condition option for the
zadd
command - ZAggregate
- Option that specify how results of an union or intersection are aggregated
- ZRange
Sort By - sort by option of the
zrange
command - ZWhere
- Where option of the
zmpop
command
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
Geospatial
indices - 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