87 releases (50 stable)

9.0.3 May 1, 2024
8.0.6 Mar 31, 2024
7.1.2 Jan 12, 2024
7.1.0 Dec 13, 2023
0.0.6 Nov 7, 2017

#1 in #cluster

Download history 36734/week @ 2024-01-29 35803/week @ 2024-02-05 33548/week @ 2024-02-12 45351/week @ 2024-02-19 48638/week @ 2024-02-26 44035/week @ 2024-03-04 50544/week @ 2024-03-11 50461/week @ 2024-03-18 52060/week @ 2024-03-25 53346/week @ 2024-04-01 53459/week @ 2024-04-08 58044/week @ 2024-04-15 60476/week @ 2024-04-22 46108/week @ 2024-04-29 54710/week @ 2024-05-06 49799/week @ 2024-05-13

212,231 downloads per month
Used in 21 crates (16 directly)

MIT license

1MB
32K SLoC

Fred

License License CircleCI Crates.io API docs

An async Redis client for Rust and Tokio.

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?);

  // or use a lower level interface for responses to defer parsing, etc
  let foo: RedisValue = client.get("foo").await?;
  assert_eq!(foo.as_str().unwrap(), "bar");

  client.quit().await?;
  Ok(())
}

See the examples for more.

Features

  • RESP2 and RESP3 protocol modes.
  • Clustered, centralized, and sentinel Redis deployments.
  • TLS via native-tls or rustls.
  • Unix sockets.
  • Efficient automatic pipelining
  • Zero-copy frame parsing
  • Optional reconnection features.
  • Publish-Subscribe and keyspace events interfaces.
  • A round-robin client pooling interface.
  • Lua scripts or functions.
  • Streaming results from the MONITOR command.
  • Custom commands.
  • Streaming interfaces for scanning functions.
  • Transactions
  • Pipelining
  • Client Tracking
  • A RedisJSON interface.
  • A round-robin cluster replica routing interface.
  • A subscriber client that will automatically manage channel subscriptions.
  • Tracing

Build 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.

Interface Features

The Redis interface has 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 installation. This does not include 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-redis-stack Enable the Redis Stack interfaces (i-redis-json, i-time-series, etc).

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–30MB
~579K SLoC