Crate redis_driver

Source
Expand description

A Redis client for Rust

Modules§

resp
Defines types related to the RESP protocol and their encoding/decoding

Structs§

AclCatOptions
Options for the acl_cat command
AclDryRunOptions
Options for the acl_dryrun command
AclGenPassOptions
Options for the acl_genpass command
AclLogOptions
Options for the acl_log command
BitFieldGetSubCommand
BitRange
Interval options for the bitcount command
Cache
CallBuilder
Builder for calling a script/function for the following commands:
Client
Client with a unique connection to a Redis server.
ClientInfo
Client info results for the client_info & client_list commands.
ClientKillOptions
Options for the client-kill command.
ClientListOptions
Options for the client_list command.
ClientListResult
Result for the client_list command.
ClientTrackingInfo
Result for the client_trackinginfo command.
ClientTrackingOptions
Options for the client_tracking command.
ClusterConfig
Configuration for connecting to a Redis Cluster
ClusterInfo
Result for the cluster_info command
ClusterLinkInfo
Result for the cluster_links command
ClusterNodeResult
Cluster node result for the cluster_shards command.
ClusterShardResult
Result for the cluster_shards command.
CommandArgument
command argument
CommandDoc
Command doc result for the command_docs command
CommandHistogram
Command Histogram for the latency_histogram commands.
CommandInfo
Command info result for the command command.
CommandListOptions
Options for the command_list command.
Config
DatabaseOverhead
DumpResult
Result for the dump command.
EngineStats
FailOverOptions
Options for the failover command.
FunctionInfo
FunctionListOptions
Options for the function_list command
FunctionStats
GeoSearchOptions
Options for the geosearch command
GeoSearchResult
Result of the geosearch command.
GeoSearchStoreOptions
Options for the geosearchstore command
HScanOptions
Options for the hscan command
HelloOptions
Options for the hello command.
HelloResult
HistoricalNote
KeySpecification
Key specifications of a command for the command command.
LcsResult
Result for the lcs command
LibraryInfo
LolWutOptions
Options for the lolwut command
MemoryStats
Result for the memory_stats command.
MemoryUsageOptions
Options for the memory_usage command
MigrateOptions
ModuleInfo
Module information result for the module_list command.
ModuleLoadOptions
Options for the module_load command
MonitorStream
Stream to get MONITOR command events when the stream is dropped or closed, a reset command is sent to the Redis server
MonitoredCommandInfo
MultiplexedClient
A multiplexed client that can be cloned, allowing requests to be be sent concurrently on the same underlying connection.
PingOptions
Options for the ping command.
Pipeline
PreparedCommand
PubSubChannelsOptions
Options for the pub_sub_channels command
PubSubStream
Stream to get messages from the channels or patterns subscribed to
RedisError
Error issued by the Redis server
ReplicaInfo
Represents a connected replicas to a master
ReplicaOfOptions
options for the replicaof command.
RestoreOptions
Options for the restore command
RunningScript
SScanOptions
Options for the sscan command
ScanOptions
Options for the scan command
SentinelConfig
Configuration for connecting to a Redis via Sentinel
SentinelInfo
SentinelMasterInfo
SentinelReplicaInfo
ShutdownOptions
options for the shutdown command.
SlowLogEntry
Result slowlog_get for the command.
SlowLogOptions
options for the slowlog_get command.
SortOptions
Options for the sort command
StreamEntry
Transaction
Represents an on-going transaction on a specific client instance.
XAddOptions
Stream Add options for the xadd command.
XAutoClaimOptions
Options for the xautoclaim command
XAutoClaimResult
XClaimOptions
Options for the xclaim command
XConsumerInfo
Result entry for the xinfo_consumers command.
XGroupCreateOptions
Options for the xgroup_create command
XGroupInfo
Result entry for the xinfo_groups command.
XInfoStreamOptions
Options for the xinfo_stream command
XPendingConsumer
Customer info result for the xpending command
XPendingMessageResult
Message result for the xpending_with_options command
XPendingOptions
Options for the xpending_with_options command
XPendingResult
Result for the xpending command
XReadGroupOptions
Options for the xreadgroup command
XReadOptions
Options for the xread command
XStreamInfo
Stream info returned by the xinfo_stream command.
XTrimOptions
Stream Trim options for the xadd and xtrim commands
ZAddOptions
Options for the zadd command.
ZRangeOptions
Options for the zrange and zrangestore commands
ZScanOptions
Options for the zscan command

Enums§

ArgumentFlag
Flag for a command argument
BeginSearch
BitFieldOverflow
BitFieldSubCommand
Sub-command for the bitfield command
BitOperation
Bit operation for the bitop command.
BitUnit
ClientCachingMode
Client caching mode for the client_caching command.
ClientPauseMode
Mode options for the client_pause command.
ClientReplyMode
Mode options for the client_reply command.
ClientTrackingStatus
Status options for the client_tracking command.
ClientType
Client type options for the client_list command.
ClientUnblockMode
Mode options for the client_unblock command.
ClusterBumpEpochResult
Result for the cluster_bumpepoch command
ClusterFailoverOption
Options for the cluster_failover command
ClusterHealthStatus
Cluster health status for the cluster_shards command.
ClusterLinkDirection
This link is established by the local node to the peer, or accepted by the local node from the peer.
ClusterResetType
Type of cluster reset
ClusterSetSlotSubCommand
Subcommand for the cluster_setslot command.
ClusterState
Cluster state used in the cluster_state field of ClusterInfo
CommandArgumentType
An argument must have one of the following types:
CommandDocFlag
Command documenation flag
CommandTip
Get additional information about a command
Error
All error kinds
ExpireOption
Options for the expire command
FindKeys
FlushingMode
Database flushing mode
FunctionRestorePolicy
Policy option for the function_restore command.
GeoAddCondition
Condition for the geoadd command
GeoSearchBy
The query’s shape is provided by one of these mandatory options:
GeoSearchFrom
The query’s center point is provided by one of these mandatory options:
GeoSearchOrder
Matching items are returned unsorted by default. To sort them, use one of the following two options:
GeoUnit
Distance Unit
GetExOptions
Options for the getex command
InfoSection
Section for the info command.
LInsertWhere
LMoveWhere
LatencyHistoryEvent
Latency history event for the latency_graph & latency_history commands.
MigrateResult
Result for the migrate command
RedisErrorKind
Redis server error kind
ReplicationState
The state of the replication from the point of view of the master,
RequestPolicy
This tip can help clients determine the shards to send the command in clustering mode.
ResponsePolicy
This tip can help clients determine the aggregate they need to compute from the replies of multiple shards in a cluster.
RetryReason
Internal Use
RoleResult
Result for the role command.
ScriptDebugMode
SentinelSimulateFailureMode
Different crash simulation scenario modes for the sentinel_simulate_failure command
ServerConfig
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
SortOrder
Order option of the sort command
XTrimOperator
Stream Trim operator for the xadd and xtrim commands
ZAddComparison
Comparison option for the zadd command
ZAddCondition
Condition option for the zadd command
ZAggregate
Option that specify how results of an union or intersection are aggregated
ZRangeSortBy
sort by option of the zrange command
ZWhere
Where option of the zmpop command

Traits§

BitmapCommands
A group of Redis commands related to Bitmaps & Bitfields
BlockingCommands
A group of blocking commands
ClientPreparedCommand
ClientTrait
ClusterCommands
A group of Redis commands related to Cluster Management
ConnectionCommands
A group of Redis commands related to connection management
GenericCommands
A group of generic Redis commands
GeoCommands
A group of Redis commands related to Geospatial indices
HashCommands
A group of Redis commands related to Hashes
HyperLogLogCommands
A group of Redis commands related to HyperLogLog
IntoConfig
ListCommands
A group of Redis commands related to Lists
MultiplexedPreparedCommand
PipelinePreparedCommand
PubSubCommands
A group of Redis commands related to Pub/Sub
ScriptingCommands
A group of Redis commands related to Scripting and Functions
SentinelCommands
A group of Redis commands related to Sentinel
ServerCommands
A group of Redis commands related to Server Management
SetCommands
A group of Redis commands related to Sets
SortedSetCommands
A group of Redis commands related to Sorted Sets
StreamCommands
A group of Redis commands related to Streams
StringCommands
A group of Redis commands related to Strings
TransactionCommands
A group of Redis commands related to Transactions

Type Aliases§

BZpopMinMaxResult
Future
Library general future type.
LcsMatch
Result
Library general result type.
ZMPopResult