Struct ClientOptions 

pub struct ClientOptions {

    pub host: String,
    pub port: u16,
    pub endpoints: Vec<Endpoint>,
    pub database: String,
    pub user: String,
    pub password: String,
    pub compression: Option<CompressionMethod>,
    pub max_compression_chunk_size: usize,
    pub client_info: ClientInfo,
    pub connection_options: ConnectionOptions,
    pub send_retries: u32,
    pub retry_timeout: Duration,
    pub ping_before_query: bool,
    pub rethrow_exceptions: bool,
}

Client options

Fields

host: String

Server host (used if endpoints is empty)

port: u16

Server port (used if endpoints is empty)

endpoints: Vec<Endpoint>

Multiple endpoints for failover (if empty, uses host+port)

database: String

Database name

user: String

Username

password: String

Password

compression: Option<CompressionMethod>

Compression method

max_compression_chunk_size: usize

Maximum compression chunk size (default: 65535)

client_info: ClientInfo

Client information

connection_options: ConnectionOptions

Connection timeout and TCP options

send_retries: u32

Number of send retries (default: 1, no retry)

retry_timeout: Duration

Timeout between retry attempts (default: 5 seconds)

ping_before_query: bool

Send ping before each query (default: false)

rethrow_exceptions: bool

Rethrow server exceptions (default: true)

Implementations

impl ClientOptions

pub fn new(host: impl Into<String>, port: u16) -> Self

Create new client options with host and port

pub fn endpoints(self, endpoints: Vec<Endpoint>) -> Self

Set multiple endpoints for failover

pub fn add_endpoint(self, host: impl Into<String>, port: u16) -> Self

Add an endpoint for failover

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

Set the database

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

Set the username

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

Set the password

pub fn compression(self, method: Option<CompressionMethod>) -> Self

Set compression method

pub fn max_compression_chunk_size(self, size: usize) -> Self

Set maximum compression chunk size

pub fn connection_options(self, options: ConnectionOptions) -> Self

Set connection options (timeouts, TCP settings)

pub fn send_retries(self, retries: u32) -> Self

Set number of send retries

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

Set retry timeout

pub fn ping_before_query(self, enabled: bool) -> Self

Enable/disable ping before query

pub fn rethrow_exceptions(self, enabled: bool) -> Self

Enable/disable exception rethrowing

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> Self

Returns the “default value” for a type.