fred 10.1.0

An async client for Redis and Valkey.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

#![allow(clippy::disallowed_names)]
#![allow(clippy::let_underscore_future)]

use fred::{prelude::*, types::config::UnresponsiveConfig};
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<(), Error> {
  let client = Builder::default_centralized()
    .with_performance_config(|config| {
      config.max_feed_count = 100;
      // change the buffer size behind the event interface functions (`on_message`, etc.)
      config.broadcast_channel_capacity = 48;
    })
    .with_connection_config(|config| {
      config.tcp = TcpConfig {
        nodelay: Some(true),
        ..Default::default()
      };
      config.max_command_attempts = 5;
      config.max_redirections = 5;
      config.internal_command_timeout = Duration::from_secs(2);
      config.connection_timeout = Duration::from_secs(10);
      // check every 3 seconds for connections that have been waiting on a response for more than 10 seconds
      config.unresponsive = UnresponsiveConfig {
        max_timeout: Some(Duration::from_secs(10)),
        interval: Duration::from_secs(3)
      };
      config.auto_client_setname = true;
      config.reconnect_on_auth_error = true;
    })
    // use exponential backoff, starting at 100 ms and doubling on each failed attempt up to 30 sec
    .set_policy(ReconnectPolicy::new_exponential(0, 100, 30_000, 2))
    .build()?;
  client.init().await?;

  // run all event listener functions in one task
  let _events_task = client.on_any(
    |error| async move {
      println!("Connection error: {:?}", error);
      Ok(())
    },
    |server| async move {
      println!("Reconnected to {:?}", server);
      Ok(())
    },
    |changes| async move {
      println!("Cluster changed: {:?}", changes);
      Ok(())
    },
  );

  // update performance config options
  let mut perf_config = client.perf_config();
  perf_config.max_feed_count = 1000;
  client.update_perf_config(perf_config);

  // overwrite configuration options on individual commands
  let options = Options {
    max_attempts: Some(5),
    max_redirections: Some(5),
    timeout: Some(Duration::from_secs(10)),
    ..Default::default()
  };
  let _: Option<String> = client.with_options(&options).get("foo").await?;

  // apply custom options to a pipeline
  let pipeline = client.pipeline().with_options(&options);
  let _: () = pipeline.get("foo").await?;
  let _: () = pipeline.get("bar").await?;
  let (_, _): (Option<i64>, Option<i64>) = pipeline.all().await?;

  // reuse pipelines
  let pipeline = client.pipeline();
  let _: () = pipeline.incr("foo").await?;
  let _: () = pipeline.incr("foo").await?;
  assert_eq!(pipeline.last::<i64>().await?, 2);
  assert_eq!(pipeline.last::<i64>().await?, 4);
  assert_eq!(pipeline.last::<i64>().await?, 6);

  // interact with specific cluster nodes without creating new connections
  if client.is_clustered() {
    // discover connections via the active connection map
    let _connections = client.active_connections();
    // or use the cached cluster state from `CLUSTER SLOTS`
    let connections = client
      .cached_cluster_state()
      .map(|state| state.unique_primary_nodes())
      .unwrap_or_default();

    for server in connections.into_iter() {
      let info: String = client.with_cluster_node(&server).client_info().await?;
      println!("Client info for {}: {}", server, info);
    }
  }

  // the `Value` type also works as quick way to discover the type signature of a complicated response:
  println!(
    "{:?}",
    client
      .xreadgroup::<Value, _, _, _, _>("foo", "bar", None, None, false, "baz", ">")
      .await?
  );

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