Struct Config 

pub struct Config { /* private fields */ }

Configuration for a Hyper database connection.

Use the builder pattern to construct a configuration:

// Marked `no_run` to dodge a Windows Defender heuristic that intermittently
// refuses to launch this specific compiled doctest binary with
// `ERROR_ACCESS_DENIED`. The same builder chain is exercised by
// `tests::test_config_builder` so coverage is preserved.
use hyperdb_api_core::client::Config;
use std::time::Duration;

let config = Config::new()
    .with_host("localhost")
    .with_port(7483)
    .with_database("test.hyper")
    .with_user("myuser")
    .with_password("mypass")
    .with_connect_timeout(Duration::from_secs(30));

Implementations

impl Config

pub fn new() -> Self

Creates a new configuration with default settings.

By default, this sets result_format_code=HyperBinary for optimal performance with Hyper’s native binary format.

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

Sets the host.

pub fn with_port(self, port: u16) -> Self

Sets the port.

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

Sets the database name.

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

Sets the username.

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

Sets the password.

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

Sets the connection timeout.

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

Sets the application name.

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

Adds a custom connection option.

pub fn host(&self) -> &str

Returns the host.

pub fn port(&self) -> u16

Returns the port.

pub fn database(&self) -> Option<&str>

Returns the database name.

pub fn user(&self) -> Option<&str>

Returns the username.

pub fn password(&self) -> Option<&str>

Returns the password.

pub fn connect_timeout(&self) -> Option<Duration>

Returns the connection timeout.

pub fn application_name(&self) -> Option<&str>

Returns the application name.

pub fn options(&self) -> &[(String, String)]

Returns the connection options.

pub fn startup_params(&self) -> Vec<(&str, &str)>

Returns the startup parameters for the connection.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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() -> Self

Returns the “default value” for a type.

impl FromStr for Config

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

Parses a connection string into a Config.

Format: host:port/database?user=xxx&password=xxx

type Err = String

The associated error which can be returned from parsing.