Struct reool::multi_node_pool::Builder

pub struct Builder<T, I> { /* fields omitted */ }

A builder for a MultiNodePool

Methods

impl<T, I> Builder<T, I>

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 tinmeout 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 min_required_nodes(self, v: usize) -> Self

The minimum required nodes to start

pub fn connect_to<C: IntoConnectionInfo>(
    self,
    connect_to: Vec<C>
) -> Builder<C, I>

The Redis nodes to connect to

pub fn task_executor(self, executor: TaskExecutor) -> Self

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

pub fn update_config_from_environment(
    self,
    prefix: Option<&str>
) -> Result<Builder<T, I>, InitializationError>

Updates this builder's config(not connect_to) 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
• MIN_REQUIRED_NODES: usize. Omit if you do not want to update the value

pub fn instrumented<II>(self, instrumentation: II) -> Builder<T, II> where
    II: Instrumentation + Send + Sync + 'static, 

Adds instrumentation to the pool

impl<I> Builder<(), I> where
    I: Instrumentation + Send + Sync + 'static, 

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

Updates 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
• MIN_REQUIRED_NODES: usize. Omit if you do not want to update the value
• CONNECT_TO: [String]. Seperated by ;. MANDATORY

impl<T, I> Builder<T, I> where
    T: IntoConnectionInfo,
    I: Instrumentation + Send + Sync + 'static, 

pub fn finish(self) -> Result<MultiNodePool, InitializationError>

Build a new MultiNodePool

impl<I> Builder<String, I> where
    I: Instrumentation + Send + Sync + 'static, 

pub fn finish2(self) -> Result<MultiNodePool, InitializationError>

Build a new MultiNodePool

This is a due to a limitation that IntoConnectionInfo is not implemented for String

Trait Implementations

impl Default for Builder<(), NoInstrumentation>

fn default() -> Self

Returns the "default value" for a type.