Struct ClientConfig 

pub struct ClientConfig {
    pub connect_timeout: Duration,
    pub call_timeout: Duration,
    pub credentials: Option<Credentials>,
    pub client_name: Option<String>,
}

Client configuration: connect timeout default 10 s (CLT-001), per-call timeout default 30 s (CLT-020), optional credentials and client name for the handshake (CLT-002).

Fields

connect_timeout: Duration

TCP connect timeout (CLT-001). Default 10 s.

call_timeout: Duration

Default per-call timeout (CLT-020); override per call with Client::call_with_timeout. Default 30 s.

credentials: Option<Credentials>

Handshake credentials, when the configured handshake wants them.

client_name: Option<String>

Client identifier sent in the HELLO map (HelloMandatory).

Implementations

impl ClientConfig

pub fn new() -> Self

Defaults: 10 s connect, 30 s per call, no credentials.

pub fn connect_timeout(self, timeout: Duration) -> Self

Set the connect timeout (CLT-001).

pub fn call_timeout(self, timeout: Duration) -> Self

Set the default per-call timeout (CLT-020).

pub fn token(self, token: impl Into<String>) -> Self

Authenticate with a bearer token.

pub fn api_key(self, api_key: impl Into<String>) -> Self

Authenticate with an API key.

pub fn user_pass(self, user: impl Into<String>, pass: impl Into<String>) -> Self

Authenticate with user + password (AuthCommand handshakes).

pub fn client_name(self, name: impl Into<String>) -> Self

Set the client name announced in the HELLO map.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.