Expand description
The structs and enums used by the Redis client.
Structs§
- Configuration options for backpressure features in the client.
- A client and pool builder interface.
- ClusterInfo
i-cluster
A parsed response from theCLUSTER INFO
command. - The cached view of the cluster used by the client to route commands to the correct cluster nodes.
- Configuration options related to the creation or management of TCP connection.
- Configuration for custom redis commands, primarily used for interacting with third party modules or extensions.
- DatabaseMemoryStats
i-memory
The parsed result of the MEMORY STATS command for a specific database. - Function
i-scripts
An individual function within a Library. - GeoPosition
i-geo
A struct describing the longitude and latitude coordinates of a GEO command. - GeoRadiusInfo
i-geo
A typed struct representing the full output of the GEORADIUS (or similar) command. - GeoValue
i-geo
A struct describing the value inside a GEO data structure. - GroupBy
i-time-series
A struct representingGROUPBY label REDUCE reducer
in commands such asTS.MRANGE
. - The result of a HSCAN operation.
- Invalidation
i-client
andi-tracking
A client tracking invalidation message from the provided server. - An event on the publish-subscribe interface describing a keyspace notification.
- Library
i-scripts
A helper struct for interacting with libraries and functions. - MemoryStats
i-memory
The parsed result of the MEMORY STATS command. - A publish-subscribe message.
- MultipleGeoValues
i-geo
A convenience struct for commands that take one or more GEO values. - A convenience struct for functions that take one or more hash slot values.
- MultipleIDs
i-streams
One or more IDs for elements in a stream. - Convenience struct for commands that take 1 or more keys.
- MultipleOrderedPairs
i-streams
One or more ordered key-value pairs, typically used as an argument forXADD
. - MultipleWeights
i-sorted-sets
Convenience struct forZINTERSTORE
andZUNIONSTORE
when accepting 1 or moreweights
arguments. - MultipleZaddValues
i-sorted-sets
Convenience struct for theZADD
command to accept 1 or more(score, value)
arguments. - Options to configure or overwrite for individual commands.
- Configuration options that can affect the performance of the client.
- RangeAggregation
i-time-series
A struct representing[ALIGN align] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]
in commands such asTS.MRANGE
. - Configuration options for a
RedisClient
. - A key in Redis.
- A map of
(RedisKey, RedisValue)
pairs. - ReplicaConfig
replicas
Configuration options for replica node connections. - The result of a SSCAN operation.
- The result of a SCAN operation.
- Script
i-scripts
An interface for caching and running lua scripts. - SentinelConfig
sentinel-client
Configuration options for sentinel clients. - State necessary to identify or connect to a server.
- A slot range and associated cluster node information from the
CLUSTER SLOTS
command. - The output of an entry in the slow queries log.
- Stats
metrics
Stats describing a distribution of samples. - TCP configuration options.
- TlsConfig
enable-rustls
orenable-native-tls
orenable-rustls-ring
TLS configuration for a client. - TracingConfig
partial-tracing
Configuration options for tracing. - Configuration options used to detect potentially unresponsive connections.
- SemVer version as defined by https://semver.org.
- XCap
i-streams
Stream cap arguments forXADD
,XTRIM
, etc. - XPendingArgs
i-streams
A struct representing the trailing optional arguments to XPENDING. - ZRange
i-sorted-sets
A wrapper struct for a range bound in a sorted set command. - The result of a ZSCAN operation.
Enums§
- Aggregate options for the zinterstore (and related) commands.
- Aggregator
i-time-series
An aggregation policy to use with certain timeseries commands. - Backpressure policies to apply when the max number of in-flight commands is reached on a connection.
- Describes how the client should respond when a command is sent while the client is in a blocked state from a blocking command.
- BucketTimestamp
i-time-series
ABUCKETTIMESTAMP
argument in commands such asTS.MRANGE
. - ClientKillFilter
i-client
Filters provided to the CLIENT KILL command. - ClientKillType
i-client
The type of clients to close. - ClientPauseKind
i-client
Filters for the CLIENT PAUSE command. - ClientReplyFlag
i-client
Arguments for the CLIENT REPLY command. - The state of the underlying connection to the Redis server.
- Arguments to the CLIENT UNBLOCK command.
- A policy that determines how clustered clients initially connect to and discover other cluster nodes.
- ClusterFailoverFlag
i-cluster
Options for the CLUSTER FAILOVER command. - A cluster hashing policy.
- ClusterResetFlag
i-cluster
Flags for the CLUSTER RESET command. - ClusterSetSlotState
i-cluster
Flags for the CLUSTER SETSLOT command. - ClusterState
i-cluster
The state of the cluster from theCLUSTER INFO
command. - An enum describing the possible ways in which a Redis cluster can change state.
- DuplicatePolicy
i-time-series
The duplicate policy used with certain timeseries commands. - Encoding
i-time-series
Encoding arguments for certain timeseries commands. - Expiration options for the set command.
- The policy type for the FUNCTION RESTORE command.
- FunctionFlag
i-scripts
- GeoUnit
i-geo
Units for the GEO DIST command. - GetLabels
i-time-series
Arguments equivalent toWITHLABELS | SELECTED_LABELS label...
in various time series GET functions. - GetTimestamp
i-time-series
A timestamp query used in commands such asTS.MRANGE
. - Options for the info command.
- LMoveDirection
i-lists
The direction to move elements in a *LMOVE command. - ListLocation
i-lists
Location flag for theLINSERT
command. - The kind of pubsub message.
- Ordering
i-sorted-sets
Ordering options for the ZADD (and related) commands. - ReconnectError
custom-reconnect-errors
Special errors that can trigger reconnection logic, which can also retry the failing command if possible. - The type of reconnection policy to use. This will apply to every connection used by the client.
- A value used in a Redis command.
- The kind of value from Redis.
- Reducer
i-time-series
AREDUCER
argument in commands such asTS.MRANGE
. - The RESP version used in the
HELLO
request. - The types of values supported by the type command.
- Flags for the SCRIPT DEBUG command.
- SentinelFailureKind
sentinel-client
Arguments for theSENTINEL SIMULATE-FAILURE
command. - Connection configuration for the Redis server.
- Options for the set command.
- Arguments passed to the SHUTDOWN command.
- The sort order for redis commands that take or return a sorted list.
- An argument representing a string or number.
- Timestamp
i-time-series
A timestamp used in most timeseries commands. - TlsConnector
enable-rustls
orenable-native-tls
orenable-rustls-ring
An enum for interacting with various TLS libraries and interfaces. - TlsHostMapping
enable-rustls
orenable-native-tls
orenable-rustls-ring
An optional enum used to describe how the client should modify or map IP addresses and hostnames in a clustered deployment. - Toggle
i-client
andi-tracking
AnON|OFF
flag used with client tracking commands. - XCapKind
i-streams
The MAXLEN or MINID argument for a stream cap. - XCapTrim
i-streams
Representation for the “=” or “~” operator inXADD
, etc. - XID
i-streams
Stream ID arguments forXADD
,XREAD
, etc. - ZCmp
i-sorted-sets
MIN|MAX
arguments forBZMPOP
, etc. - ZRangeBound
i-sorted-sets
An index, score, lexicographical, or +|-|+inf|-inf range bound for the ZRANGE command. - ZRangeKind
i-sorted-sets
The type of range interval bound. - ZSort
i-sorted-sets
Options for the ZRANGE (and related) commands.
Constants§
- The default amount of jitter when waiting to reconnect.
Traits§
- A trait used to convert various forms of RedisValue into different types.
- A trait used to convert RedisKey values to various types.
- HostMapping
enable-rustls
orenable-native-tls
orenable-rustls-ring
A trait used for mapping IP addresses to hostnames when processing theCLUSTER SLOTS
response. - ReplicaFilter
replicas
An interface used to filter the list of available replica nodes. - Resolve
dns
A trait that can be used to override DNS resolution logic. - An interface for interacting with the results of a scan operation.
Type Aliases§
- The ANY flag used on certain GEO commands.
- The result from any of the
connect
functions showing the error that closed the connection, if any. - A tuple of
(offset, count)
values for commands that allow paging through results. - An argument type equivalent to “[LIMIT count]”.
- Convenience interface for commands that take 1 or more strings.
- Convenience interface for commands that take 1 or more values.
- Resp2TimeSeriesValues
i-time-series
Shorthand for the result of commands such asMGET
,MRANGE
, etc. - Resp3TimeSeriesValues
i-time-series
The RESP3 equivalent of Resp2TimeSeriesValues. - XReadResponse
i-streams
A generic helper type describing the top level response fromXREAD
orXREADGROUP
. - XReadValue
i-streams
A generic helper type describing the ID and associated map for each record in a stream.