94 releases (57 stable)
new 9.4.0 | Nov 7, 2024 |
---|---|
9.2.1 | Sep 5, 2024 |
9.0.3 | May 1, 2024 |
8.0.6 | Mar 31, 2024 |
0.0.6 | Nov 7, 2017 |
#21 in Database interfaces
203,350 downloads per month
Used in 29 crates
(20 directly)
1.5MB
36K
SLoC
Fred
An async client for Redis and Valkey
Example
use fred::prelude::*;
#[tokio::main]
async fn main() -> Result<(), RedisError> {
let client = RedisClient::default();
client.init().await?;
// convert responses to many common Rust types
let foo: Option<String> = client.get("foo").await?;
assert!(foo.is_none());
client.set("foo", "bar", None, None, false).await?;
// or use turbofish to declare response types
println!("Foo: {:?}", client.get::<String, _>("foo").await?);
client.quit().await?;
Ok(())
}
See the examples for more.
Features
- RESP2 and RESP3 protocol modes.
- Clustered, centralized, and sentinel server deployments.
- TLS via
native-tls
orrustls
. - Unix sockets.
- Automatic reconnection interfaces.
- Publish-Subscribe and keyspace events interfaces.
- A round-robin client pooling interface.
- A round-robin replica routing interface.
- Built-in mocking interfaces.
- Lua scripts or functions.
- Transactions
- Pipelining
- Client Tracking
- Automatic pipelining
- Zero-copy frame parsing
- Tracing
See the build features for more information.
Client Features
Name | Default | Description |
---|---|---|
transactions |
x | Enable a Transaction interface. |
enable-native-tls |
Enable TLS support via native-tls. | |
enable-rustls |
Enable TLS support via rustls with the default crypto backend features. | |
enable-rustls-ring |
Enable TLS support via rustls and the ring crypto backend. | |
vendored-openssl |
Enable the native-tls/vendored feature. |
|
metrics |
Enable the metrics interface to track overall latency, network latency, and request/response sizes. | |
full-tracing |
Enable full tracing support. This can emit a lot of data. | |
partial-tracing |
Enable partial tracing support, only emitting traces for top level commands and network latency. | |
blocking-encoding |
Use a blocking task for encoding or decoding frames. This can be useful for clients that send or receive large payloads, but requires a multi-thread Tokio runtime. | |
custom-reconnect-errors |
Enable an interface for callers to customize the types of errors that should automatically trigger reconnection logic. | |
monitor |
Enable an interface for running the MONITOR command. |
|
sentinel-client |
Enable an interface for communicating directly with Sentinel nodes. This is not necessary to use normal Redis clients behind a sentinel layer. | |
sentinel-auth |
Enable an interface for using different authentication credentials to sentinel nodes. | |
subscriber-client |
Enable a subscriber client interface that manages channel subscription state for callers. | |
serde-json |
Enable an interface to automatically convert Redis types to JSON via serde-json . |
|
mocks |
Enable a mocking layer interface that can be used to intercept and process commands in tests. | |
dns |
Enable an interface that allows callers to override the DNS lookup logic. | |
replicas |
Enable an interface that routes commands to replica nodes. | |
default-nil-types |
Enable a looser parsing interface for nil values. |
|
sha-1 |
Enable an interface for hashing Lua scripts. | |
unix-sockets |
Enable Unix socket support. | |
credential-provider |
Enable an interface that can dynamically load auth credentials at runtime. | |
specialize-into-bytes |
Specialize TryFrom<Vec<u8> for RedisValue> to use RedisValue::Bytes , disabling From<u8> for RedisValue . This is a temporary feature flag that will be made the default in the next major version. |
|
glommio |
Enable experimental Glommio support. |
Interface Features
The command interfaces have many functions and compile times can add up quickly. Interface features
begin with i-
and control which public interfaces are built.
Name | Default | Description |
---|---|---|
i-all |
Enable the interfaces included with a basic Redis or Valkey installation. This does not include i-redis-stack features. |
|
i-std |
x | Enable the common data structure interfaces (lists, sets, streams, keys, etc). |
i-acl |
Enable the ACL command interface. | |
i-client |
Enable the CLIENT command interface. | |
i-cluster |
Enable the CLUSTER command interface. | |
i-config |
Enable the CONFIG command interface. | |
i-geo |
Enable the GEO command interface. | |
i-hashes |
Enable the hashes (HGET, etc) command interface. | |
i-hyperloglog |
Enable the hyperloglog command interface. | |
i-keys |
Enable the main keys (GET, SET, etc) command interface. | |
i-lists |
Enable the lists (LPUSH, etc) command interface. | |
i-scripts |
Enable the scripting command interfaces. | |
i-memory |
Enable the MEMORY command interfaces. | |
i-pubsub |
Enable the publish-subscribe command interfaces. | |
i-server |
Enable the server control (SHUTDOWN, BGSAVE, etc) interfaces. | |
i-sets |
Enable the sets (SADD, etc) interface. | |
i-sorted-sets |
Enable the sorted sets (ZADD, etc) interface. | |
i-slowlog |
Enable the SLOWLOG interface. | |
i-streams |
Enable the streams (XADD, etc) interface. | |
i-tracking |
Enable a client tracking interface. | |
i-time-series |
Enable a Redis Timeseries interface. | |
i-redis-json |
Enable a RedisJSON interface. | |
i-redisearch |
Enable a RediSearch interface. | |
i-redis-stack |
Enable the Redis Stack interfaces (i-redis-json , i-time-series , etc). |
If a specific high level command function is not supported callers can use the custom
function as a workaround until
the higher level interface is added. See the custom
example for more info.
Debugging Features
Name | Default | Description |
---|---|---|
debug-ids |
Enable a global counter used to differentiate commands in logs. | |
network-logs |
Enable additional TRACE logs for all frames on all sockets. |
Dependencies
~8–31MB
~595K SLoC