Struct reool::config::Config

pub struct Config {
    pub desired_pool_size: usize,
    pub checkout_timeout: Option<Duration>,
    pub backoff_strategy: BackoffStrategy,
    pub reservation_limit: Option<usize>,
    pub stats_interval: Duration,
    pub activation_order: ActivationOrder,
    pub min_required_nodes: usize,
    pub connect_to_nodes: Vec<String>,
    pub node_pool_strategy: NodePoolStrategy,
    pub pool_per_node_multiplier: u32,
}

A configuration for creating a MultiNodePool.

You should prefer using the MultiNodePool::builder() function.

Fields

desired_pool_size: usize

The number of connections the pool should initially have and try to maintain

checkout_timeout: Option<Duration>

The timeout for a checkout if no specific timeout is given with a checkout.

backoff_strategy: BackoffStrategy

The BackoffStrategy to use when retrying on failures to create new connections

reservation_limit: Option<usize>

The maximum length of the queue for waiting checkouts when no idle connections are available

stats_interval: Duration

The interval in which the pool will send statistics to the instrumentation

activation_order: ActivationOrder

Defines the ActivationOrder in which idle connections are activated.

Default is ActivationOrder::FiFo

min_required_nodes: usize

The minimum required nodes to start

connect_to_nodes: Vec<String>

The nodes to connect To

node_pool_strategy: NodePoolStrategy

Sets the NodePoolStrategy to be used when creating the pool.

pool_per_node_multiplier: u32

When pool per node is created, sets a multiplier for the amount of pools per node to be created.

Other values will be adjusted if the multiplier is > 1:

• reservation_limit: Stays zero if zero, otherwise (reservation_limit/multiplier) +1
• desired_pool_size: (desired_pool_size/multiplier) +1

Methods

impl Config

pub fn desired_pool_size(self, v: usize) -> Self

Sets the number of connections the pool should initially have and try to maintain

pub fn checkout_timeout(self, v: Option<Duration>) -> Self

Sets the timeout for a checkout if no specific timeout is given with a checkout.

pub fn backoff_strategy(self, v: BackoffStrategy) -> Self

Sets the BackoffStrategy to use when retrying on failures to create new connections

pub fn reservation_limit(self, v: Option<usize>) -> Self

Sets the maximum length of the queue for waiting checkouts when no idle connections are available

pub fn stats_interval(self, v: Duration) -> Self

The interval in which the pool will send statistics to the instrumentation

pub fn activation_order(self, v: ActivationOrder) -> Self

Defines the ActivationOrder in which idle connections are activated.

Default is ActivationOrder::FiFo

pub fn min_required_nodes(self, v: usize) -> Self

Sets the maximum length of the queue for waiting checkouts when no idle connections are available

pub fn connect_to_nodes(self, v: Vec<String>) -> Self

The Redis nodes to connect to

pub fn connect_to_node<T: Into<String>>(self, v: T) -> Self

The Redis node to connect to

pub fn node_pool_strategy(self, v: NodePoolStrategy) -> Self

Sets the NodePoolStrategy to be used when creating the pool.

pub fn pool_per_node_multiplier(self, v: u32) -> Self

When pool per node is created, sets a multiplier for the amount of pools per node to be created.

Other values will be adjusted if the multiplier is > 1:

• reservation_limit: Stays zero if zero, otherwise (reservation_limit/multiplier) +1
• desired_pool_size: (desired_pool_size/multiplier) +1

pub fn update_from_environment(
    &mut self,
    prefix: Option<&str>
) -> Result<(), InitializationError>

Updates this configuration from the environment.

If no prefix is set all the given env key start with REOOL_. Otherwise the prefix is used with an automatically appended _.

• DESIRED_POOL_SIZE: usize. Omit if you do not want to update the value
• CHECKOUT_TIMEOUT_MS: u64 or "NONE". Omit if you do not want to update the value
• RESERVATION_LIMIT: usize or "NONE". Omit if you do not want to update the value
• STATS_INTERVAL_MS: u64. Omit if you do not want to update the value
• ACTIVATION_ORDER: string. Omit if you do not want to update the value
• MIN_REQUIRED_NODES: usize. Omit if you do not want to update the value
• CONNECT_TO: [String]. Separated by ;. Omit if you do not want to update the value
• NODE_POOL_STRATEGY: Omit if you do not want to update the value
• POOL_PER_NODE_MULTIPLIER: Omit if you do not want to update the value

pub fn builder(&self) -> Builder

Create a Builder initialized with the values from this Config

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Config

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

Formats the value using the given formatter.