Fred

An async client for Valkey and Redis

Example

use fred::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Error> {
  let config = Config::from_url("redis://localhost:6379/1")?;
  let client = Builder::from_config(config)
    .with_connection_config(|config| {
      config.connection_timeout = Duration::from_secs(5);
      config.tcp = TcpConfig {
        nodelay: Some(true),
        ..Default::default()
      };
    })
    .build()?;
  client.init().await?;

  client.on_error(|(error, server)| async move {
    println!("{:?}: Connection error: {:?}", server, error);
    Ok(())
  });

  // 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 or rustls.
• 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

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.

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.

Redis Features

Features currently specific to Redis, typically versions >=7.2.5:

Debugging Features