Struct eventstore::ClientSettings

pub struct ClientSettings { /* private fields */ }

Gathers all the settings related to a gRPC client with an EventStoreDB database. ClientSettings can only be created when parsing a connection string.

let setts = "esdb://localhost:1234?tls=false".parse::<ClientSettings>()?;

You can declare a single-node or a cluster-mode client while only using a connection string. For example, you can define a cluster-mode client based on a fixed set of gossip seeds:

let setts = "esdb://localhost:1111,localhost:2222,localhost:3333".parse::<ClientSettings>()?;

Same example except we are using DNS discovery this time. The client will perform SRV queries to resolve all the node associated to that domain:

let setts = "esdb+discover://mydomain:1234".parse::<ClientSettings>()?;

ClientSettings supports a wide range of settings. If a setting is not mentioned in the connection string, that setting default value is used.

• maxDiscoverAttempts: default 3. Maximum number of DNS discovery attempts before the connection gives up.

• discoveryInterval: default 500ms. Waiting period between discovery attempts.

• gossipTimeout: default 3s: Waiting period before a gossip request timeout. TODO - Current behavior doesn’t timeout at all.

• tls: default true. Use a secure connection.

• tlsVerifyCert: default true. When using a secure connection, perform a certification verification.

• nodePreference: default random. When in a cluster connection, indicates what type of node a connection should pick. Keep in mind that’s best effort. Supported values are:

  • leader
  • random
  • follower
  • readOnlyReplica

• keepAliveInterval: default 10s

• keepAliveTimeout: default 10s

Implementations

impl ClientSettings

pub fn is_dns_discovery_enabled(&self) -> bool

pub fn hosts(&self) -> &Vec<Endpoint>

pub fn max_discover_attempts(&self) -> usize

pub fn discovery_interval(&self) -> Duration

pub fn gossip_timeout(&self) -> Duration

pub fn node_preference(&self) -> NodePreference

pub fn is_secure_mode_enabled(&self) -> bool

pub fn is_tls_certificate_verification_enabled(&self) -> bool

pub fn default_authenticated_user(&self) -> &Option<Credentials>

pub fn parse(input: &str) -> IResult<&str, Self>

pub fn parse_str(input: &str) -> Result<Self, ClientSettingsParseError>

pub fn to_uri(&self, endpoint: &Endpoint) -> Uri

Trait Implementations

impl Clone for ClientSettings

fn clone(&self) -> ClientSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientSettings

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

Formats the value using the given formatter.

impl Default for ClientSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientSettings

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

Deserialize this value from the given Serde deserializer.

impl FromStr for ClientSettings

type Err = ClientSettingsParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<ClientSettings> for ClientSettings

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

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

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

This method tests for !=.

impl Serialize for ClientSettings

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

Serialize this value into the given Serde serializer.

impl Eq for ClientSettings

impl StructuralEq for ClientSettings

impl StructuralPartialEq for ClientSettings