Struct pd_client::config::Config

pub struct Config {
    pub endpoints: Vec<String>,
    pub retry_interval: ReadableDuration,
    pub retry_max_count: isize,
    pub retry_log_every: usize,
    pub update_interval: ReadableDuration,
    pub enable_forwarding: bool,
}

The configuration for a PD Client.

By default during initialization the client will attempt to reconnect every 300s for infinity, logging only every 10th duplicate error.

Fields

endpoints: Vec<String>

The PD endpoints for the client.

Default is "127.0.0.1:2379".

retry_interval: ReadableDuration

The interval at which to retry a PD connection initialization.

Default is 300ms.

retry_max_count: isize

The maximum number of times to retry a PD connection initialization.

Default is isize::MAX, represented by -1.

retry_log_every: usize

If the client observes the same error message on retry, it can repeat the message only every n times.

Default is 10. Set to 1 to disable this feature.

update_interval: ReadableDuration

The interval at which to update PD information.

Default is 10m.

enable_forwarding: bool

The switch to support forwarding requests to follower when the network partition problem happens.

Default is false.

Implementations

impl Config

pub fn new(endpoints: Vec<String>) -> Self

pub fn validate(&self) -> Result<(), Box<dyn Error>>

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config where
    Config: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config