Struct pgdb::PostgresBuilder

pub struct PostgresBuilder { /* private fields */ }

Builder for a postgres instance.

Usually constructed via Postgres::build.

Implementations

impl PostgresBuilder

pub fn data_dir<T: Into<PathBuf>>(&mut self, data_dir: T) -> &mut Self

Sets the postgres data directory.

If not set, a temporary directory will be used.

pub fn initdb_binary<T: Into<PathBuf>>(&mut self, initdb_binary: T) -> &mut Self

Sets the location of the initdb binary.

pub fn host(&mut self, host: String) -> &mut Self

Sets the bind address.

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

Sets listening port.

Note that by default, ports will not be reused, every subsequently created database in the same process will attempt to use a different port number. If this behavior is not desired, call reuse_port().

pub fn postgres_binary<T: Into<PathBuf>>( &mut self, postgres_binary: T ) -> &mut Self

Sets the location of the postgres binary.

pub fn probe_delay(&mut self, probe_delay: Duration) -> &mut Self

Sets the startup probe delay.

Between two startup probes, waits this long.

pub fn psql_binary<T: Into<PathBuf>>(&mut self, psql_binary: T) -> &mut Self

Sets the location of the psql binary.

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

Reuse port when spawning multiple databases.

By default, the builder checks if any given port has been previously used, and if so, tries to find the next available adjacent port instead.

pub fn startup_timeout(&mut self, startup_timeout: Duration) -> &mut Self

Sets the maximum time to probe for startup.

pub fn superuser_pw<T: Into<String>>(&mut self, superuser_pw: T) -> &mut Self

Sets the password for the superuser.

pub fn start(&self) -> Result<Postgres, Error>

Starts the Postgres server.

Postgres will start using a newly created temporary directory as its data dir. The function will only return once a TCP connection to postgres has been made successfully.

Trait Implementations

impl Debug for PostgresBuilder

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

Formats the value using the given formatter.

impl Default for PostgresBuilder

fn default() -> PostgresBuilder

Returns the “default value” for a type.