Struct reool::config::Builder

pub struct Builder { /* fields omitted */ }

A builder for a MultiNodePool

Methods

impl Builder

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

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

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

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

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

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

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

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

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

The minimum required nodes to start

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.

Increasing this values reduces the contention on each created pool

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 task_executor(self, executor: TaskExecutor) -> Self

The executor to use for spawning tasks. If not set it is assumed that the pool is created on the default runtime.

pub fn instrumented<I>(self, instrumentation: I) -> Self where
    I: Instrumentation + Send + Sync + 'static, 

Adds instrumentation to the pool

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

Sets values in this builder 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 updated_from_environment(
    self,
    prefix: Option<&str>
) -> Result<Self, InitializationError>

Updates this builder from the environment and returns Self.

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 finish_redis_rs(self) -> Result<RedisPool, InitializationError>

Build a new RedisPool

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the "default value" for a type.