Struct SettingsBuilder 

pub struct SettingsBuilder { /* private fields */ }

Builder for constructing Settings with a fluent API.

Examples

use postgresql_embedded::SettingsBuilder;

let settings = SettingsBuilder::new()
    .host("127.0.0.1")
    .port(5433)
    .username("admin")
    .password("secret")
    .temporary(false)
    .build();

To configure a Unix socket:

use postgresql_embedded::SettingsBuilder;
use std::path::PathBuf;

let settings = SettingsBuilder::new()
    .socket_dir(PathBuf::from("/tmp/pg_socket"))
    .build();

Implementations

impl SettingsBuilder

pub fn new() -> Self

Create a new SettingsBuilder starting from the default Settings.

pub fn releases_url<S: Into<String>>(self, releases_url: S) -> Self

Set the releases URL for downloading PostgreSQL archives.

pub fn version(self, version: VersionReq) -> Self

Set the PostgreSQL version requirement.

pub fn installation_dir<P: Into<PathBuf>>(self, dir: P) -> Self

Set the installation directory.

pub fn password_file<P: Into<PathBuf>>(self, path: P) -> Self

Set the password file path.

pub fn data_dir<P: Into<PathBuf>>(self, dir: P) -> Self

Set the data directory.

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

Set the host name or IP address.

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

Set the TCP port number.

pub fn username<S: Into<String>>(self, username: S) -> Self

Set the database username.

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

Set the database password.

pub fn temporary(self, temporary: bool) -> Self

Set whether the database is temporary (cleaned up on drop).

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

Set the command execution timeout.

pub fn configuration(self, configuration: HashMap<String, String>) -> Self

Set server configuration options.

pub fn config<K: Into<String>, V: Into<String>>(self, key: K, value: V) -> Self

Add a single server configuration option.

pub fn trust_installation_dir(self, trust: bool) -> Self

Set whether to trust the installation directory as-is.

pub fn socket_dir<P: Into<PathBuf>>(self, dir: P) -> Self

Set the Unix socket directory. When set, the server will listen on a Unix socket in this directory. This is only supported on Unix platforms.

pub fn build(self) -> Settings

Consume the builder and return the configured Settings.

Trait Implementations

impl Clone for SettingsBuilder

fn clone(&self) -> SettingsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsBuilder

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

Formats the value using the given formatter.

impl Default for SettingsBuilder

fn default() -> Self

Returns the “default value” for a type.