Struct Config

pub struct Config { /* private fields */ }

Configuration for server connection, including: strictness, notifications, query_timeout, transaction_timeout

Implementations

impl Config

pub fn new() -> Self

Create a default config that can be modified to configure a connection

pub fn set_strict(self, strict: bool) -> Self

Set the strict value of the config to the supplied value

pub fn strict(self) -> Self

Enables strict server mode

pub fn set_ast_payload(self, ast_payload: bool) -> Self

Whether to send queries as AST

pub fn ast_payload(self) -> Self

Send queries as AST

pub fn query_timeout(self, timeout: impl Into<Option<Duration>>) -> Self

Set the query timeout of the config

pub fn transaction_timeout(self, timeout: impl Into<Option<Duration>>) -> Self

Set the transaction timeout of the config

pub fn user(self, user: Root<'_>) -> Self

Set the default user

pub fn rustls(self, config: ClientConfig) -> Self

Available on crate feature rustls only.

Use Rustls to configure TLS connections

WARNING: rustls is not stable yet. As we may need to upgrade this dependency from time to time to keep up with its security fixes, this method is excluded from our stability guarantee.

pub fn native_tls(self, config: TlsConnector) -> Self

Available on crate feature native-tls only.

Use native TLS to configure TLS connections

WARNING: native-tls is not stable yet. As we may need to upgrade this dependency from time to time to keep up with its security fixes, this method is excluded from our stability guarantee.

pub fn capabilities(self, capabilities: Capabilities) -> Self

Set the capabilities for the database

pub fn temporary_directory(self, path: Option<PathBuf>) -> Self

pub fn node_membership_refresh_interval( self, interval: impl Into<Option<Duration>>, ) -> Self

Set the interval at which the database should run node maintenance tasks

pub fn node_membership_check_interval( self, interval: impl Into<Option<Duration>>, ) -> Self

Set the interval at which the database should run node maintenance tasks

pub fn node_membership_cleanup_interval( self, interval: impl Into<Option<Duration>>, ) -> Self

Set the interval at which the database should run node maintenance tasks

pub fn changefeed_gc_interval( self, interval: impl Into<Option<Duration>>, ) -> Self

Set the interval at which the database should run node maintenance tasks

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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() -> Config

Returns the “default value” for a type.

impl IntoEndpoint<Mem> for Config

type Client = Db

The client implied by this scheme and address combination

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object