Struct DriverOptions 

pub struct DriverOptions {
    pub tls_config: DriverTlsConfig,
    pub request_timeout: Duration,
    pub primary_failover_retries: usize,
}

TypeDB driver connection options. DriverOptions object can be used to override the default driver behavior while connecting to TypeDB.

Examples

let options = DriverOptions::new(DriverTlsConfig::default()).request_timeout(Duration::from_secs(30));

Fields

tls_config: DriverTlsConfig

Specifies the TLS configuration of the connection to TypeDB. WARNING: Disabled TLS settings will make the driver sending passwords as plaintext. Defaults to an enabled TLS configuration based on the system’s native trust roots.

request_timeout: Duration

Specifies the maximum time to wait for a response to a unary RPC request. This applies to operations like database creation, user management, and initial transaction opening. It does NOT apply to operations within transactions (queries, commits). Defaults to 2 hours.

primary_failover_retries: usize

Specifies the number of retries the driver performs to find and reach the cluster primary after a failed request, before giving up. Total attempts per user request = N + 1. Each retry either follows the server’s redirect address (fast path) or polls the known replicas with a 2-second sleep between polls (slow path). Set to 0 to disable failover. Defaults to 1.

Implementations

impl DriverOptions

pub fn new(tls_config: DriverTlsConfig) -> Self

Creates new DriverOptions to configure connections to TypeDB using custom TLS settings. WARNING: Disabled TLS settings will make the driver sending passwords as plaintext.

pub fn tls_config(self, tls_config: DriverTlsConfig) -> Self

Override the existing TLS configuration. WARNING: Disabled TLS settings will make the driver sending passwords as plaintext.

pub fn request_timeout(self, request_timeout: Duration) -> Self

Specifies the maximum time to wait for a response to a unary RPC request. This applies to operations like database creation, user management, and initial transaction opening. It does NOT apply to operations within transactions (queries, commits). Defaults to 2 hours.

pub fn primary_failover_retries(self, primary_failover_retries: usize) -> Self

Specifies the number of retries the driver performs to find and reach the cluster primary after a failed request, before giving up. Total attempts per user request = N + 1. Each retry either follows the server’s redirect address (fast path) or polls the known replicas with a 2-second sleep between polls (slow path). Set to 0 to disable failover. Defaults to 1.

Trait Implementations

impl Clone for DriverOptions

fn clone(&self) -> DriverOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DriverOptions

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

Formats the value using the given formatter.

impl Default for DriverOptions

fn default() -> Self

Returns the “default value” for a type.