Struct hdbconnect::ConnectParamsBuilder

pub struct ConnectParamsBuilder { /* fields omitted */ }

A builder for ConnectParams.

Example

use hdbconnect::ConnectParams;

let connect_params = ConnectParams::builder()
    .hostname("abcd123")
    .port(2222)
    .dbuser("MEIER")
    .password("schlau")
    .build()
    .unwrap();

Instantiating a ConnectParamsBuilder from a URL

The URL is supposed to have the same form as for ConnectParams (i.e. <scheme>://<username>:<password>@<host>:<port>[<options>], see Using a URL), but only scheme and host are mandatory.

Example

use hdbconnect::IntoConnectParamsBuilder;

let conn_params = "hdbsql://abcd123:2222"
    .into_connect_params_builder()
    .unwrap()
    .dbuser("MEIER")
    .password("schlau")
    .build()
    .unwrap();

Methods

impl ConnectParamsBuilder

pub fn new() -> Self

Creates a new builder.

pub fn hostname<H: AsRef<str>>(&mut self, hostname: H) -> &mut Self

Sets the hostname.

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

Sets the port.

pub fn dbuser<D: AsRef<str>>(&mut self, dbuser: D) -> &mut Self

Sets the database user.

pub fn password<P: AsRef<str>>(&mut self, pw: P) -> &mut Self

Sets the password.

pub fn unset_password(&mut self) -> &mut Self

Unsets the password.

pub fn clientlocale<P: AsRef<str>>(&mut self, cl: P) -> &mut Self

Sets the client locale.

pub fn clientlocale_from_env_lang(&mut self) -> &mut Self

Sets the client locale from the value of the environment variable LANG

pub fn tls_with(&mut self, server_certs: ServerCerts) -> &mut Self

Makes the driver use TLS for the connection to the database.

Requires that the server's certificate is provided with one of the enum variants of ServerCerts.

If needed, you can call this function multiple times with different ServerCert variants.

Example:

let mut conn_params = ConnectParams::builder()
   // ...more settings required...
   .tls_with(ServerCerts::Direct(string_with_certificate))
   .build();

pub fn option(&mut self, name: &str, value: &str) -> &mut Self

Adds a runtime parameter.

pub fn build(&self) -> HdbResult<ConnectParams>

Constructs a ConnectParams from the builder.

Errors

HdbError::Usage if the builder was not yet configured to create a meaningful ConnectParams

pub fn to_url(&self) -> HdbResult<String>

Returns the url for this connection

Errors

HdbError::Usage if the builder was not yet configured to build a correct url

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

Getter

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

Getter

pub fn get_password(&self) -> Option<&SecStr>

Getter

pub fn get_port(&self) -> Option<u16>

Getter

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

Getter

pub fn get_server_certs(&self) -> &Vec<ServerCerts>

Getter

pub fn get_options(&self) -> &Vec<(String, String)>

Getter

Trait Implementations

impl Clone for ConnectParamsBuilder

fn clone(&self) -> ConnectParamsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectParamsBuilder

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

Formats the value using the given formatter.

impl Default for ConnectParamsBuilder

fn default() -> ConnectParamsBuilder

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ConnectParamsBuilder

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Into<String> for ConnectParamsBuilder

fn into(self) -> String

Performs the conversion.

impl IntoConnectParams for ConnectParamsBuilder

fn into_connect_params(self) -> HdbResult<ConnectParams>

Converts the value of self into a ConnectParams.

impl<'_> IntoConnectParams for &'_ ConnectParamsBuilder

fn into_connect_params(self) -> HdbResult<ConnectParams>

Converts the value of self into a ConnectParams.

impl IntoConnectParamsBuilder for ConnectParamsBuilder

fn into_connect_params_builder(self) -> HdbResult<ConnectParamsBuilder>

Converts the value of self into a ConnectParamsBuilder.

impl PartialEq<ConnectParamsBuilder> for ConnectParamsBuilder

fn eq(&self, other: &ConnectParamsBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConnectParamsBuilder) -> bool

This method tests for !=.

impl Serialize for ConnectParamsBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConnectParamsBuilder