Struct reool::config::Builder

pub struct Builder { /* fields omitted */ }

A builder for a RedisPool

Implementations

impl Builder

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

The number of connections a pool should have. If a pool with multiple sub pools is created, this value applies to each sub pool.

The default is 50.

pub fn default_checkout_mode<T: Into<DefaultPoolCheckoutMode>>(
    self,
    v: T
) -> Self

Sets the behaviour of the pool on checkouts if no specific behaviour was requested by the user.

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: usize) -> Self

The maximum length of the queue for waiting checkouts when no idle connections are available. If a pool with multiple sub pools is created, this value applies to each sub pool.

The default is 50.

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 pool_multiplier(self, v: u32) -> Self

When the pool is created this is a multiplier for the amount of sub pools 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 checkout_queue_size(self, v: usize) -> Self

The number of checkouts that can be enqueued. If a pool with multiple sub pools is created, this value applies to each sub pool.

The default is 100.

pub fn retry_on_checkout_limit(self, v: bool) -> Self

Set to true if a retry on a checkout should be made if the queue was full. Otherwise do not retry.

The default is true.

pub fn default_command_timeout<T: Into<DefaultCommandTimeout>>(
    self,
    v: T
) -> Self

A timeout for commands which is applied to all commands on all connections.

pub fn task_executor(self, handle: Handle) -> 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>
) -> InitializationResult<()>

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
• DEFAULT_POOL_CHECKOUT_MODE: The default checkout mode to use. Omit if you do not want to update the value
• RESERVATION_LIMIT: usize. 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
• POOL_MULTIPLIER: Omit if you do not want to update the value
• CHECKOUT_QUEUE_SIZE: Omit if you do not want to update the value
• RETRY_ON_CHECKOUT_LIMIT: Omit if you do not want to update the value
• DEFAULT_COMMAND_TIMEOUT_MS: Omit if you do not want to update the value

pub fn updated_from_environment(
    self,
    prefix: Option<&str>
) -> InitializationResult<Self>

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
• DEFAULT_POOL_CHECKOUT_MODE: The default checkout mode to use. Omit if you do not want to update the value
• RESERVATION_LIMIT: usize. 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
• POOL_MULTIPLIER: Omit if you do not want to update the value
• CHECKOUT_QUEUE_SIZE: Omit if you do not want to update the value
• RETRY_ON_CHECKOUT_LIMIT: Omit if you do not want to update the value
• DEFAULT_COMMAND_TIMEOUT_MS: Omit if you do not want to update the value

pub fn finish<CF, F>(
    self,
    connection_factory: F
) -> InitializationResult<RedisPool<CF::Connection>> where
    F: Fn(String) -> InitializationResult<CF>,
    CF: ConnectionFactory + Send + Sync + 'static, 

Build a new RedisPool with the given connection factory

pub fn finish_redis_rs(self) -> InitializationResult<RedisPool>

Build a new RedisPool

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.