Struct fred::types::Options

pub struct Options {
    pub max_attempts: Option<u32>,
    pub max_redirections: Option<u32>,
    pub timeout: Option<Duration>,
    pub cluster_node: Option<Server>,
    pub cluster_hash: Option<ClusterHash>,
    pub no_backpressure: bool,
    pub fail_fast: bool,
    pub caching: Option<bool>,
}

Options to configure or overwrite for individual commands.

Fields left as None will use the value from the corresponding client or global config option.

async fn example() -> Result<(), RedisError> {
  let options = Options {
    max_attempts: Some(10),
    max_redirections: Some(2),
    ..Default::default()
  };

  let client = RedisClient::default();
  client.init().await?;
  let _: () = client.with_options(&options).get("foo").await?;

  Ok(())
}

See WithOptions for more information.

Fields

max_attempts: Option<u32>

Set the max number of write attempts for a command.

max_redirections: Option<u32>

Set the max number of cluster redirections to follow for a command.

timeout: Option<Duration>

Set the timeout duration for a command.

This interface is more^* cancellation-safe than a simple timeout call.

^* But it’s not perfect. There’s no reliable mechanism to cancel a command once it has been written to the connection.

cluster_node: Option<Server>

The cluster node that should receive the command.

The caller will receive a RedisErrorKind::Cluster error if the provided server does not exist.

The client will still follow redirection errors via this interface. Callers may not notice this, but incorrect server arguments here could result in unnecessary calls to refresh the cached cluster routing table.

cluster_hash: Option<ClusterHash>

The cluster hashing policy to use, if applicable.

If cluster_node is also provided it will take precedence over this value.

no_backpressure: bool

Whether to skip backpressure checks for a command.

fail_fast: bool

Whether the command should fail quickly if the connection is not healthy or available for writes. This always takes precedence over max_attempts if true.

This can be useful for caching use cases where it’s preferable to fail fast with a fallback query to another storage layer rather than wait for a reconnection delay.

Default: false

caching: Option<bool>

Available on crate feature i-tracking only.

Whether to send CLIENT CACHING yes|no before the command.

Implementations

impl Options

pub fn extend(&mut self, other: &Self) -> &mut Self

Set the non-null values from other onto self.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Options

impl StructuralPartialEq for Options