Struct PgCtlBuilder

pub struct PgCtlBuilder { /* private fields */ }

pg_ctl is a utility to initialize, start, stop, or control a PostgreSQL server.

Implementations

impl PgCtlBuilder

pub fn new() -> Self

Create a new PgCtlBuilder

pub fn from(settings: &dyn Settings) -> Self

Create a new PgCtlBuilder from Settings

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

Location of the program binary

pub fn mode(self, mode: Mode) -> Self

mode

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

location of the database storage area

pub fn silent(self) -> Self

only print errors, no informational messages

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

seconds to wait when using -w option

pub fn version(self) -> Self

output version information, then exit

pub fn wait(self) -> Self

wait until operation completes (default)

pub fn no_wait(self) -> Self

do not wait until operation completes

pub fn help(self) -> Self

show help, then exit

pub fn core_files(self) -> Self

allow postgres to produce core files

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

write (or append) server log to FILENAME

pub fn options<S: AsRef<OsStr>>(self, options: &[S]) -> Self

command line options to pass to postgres (PostgreSQL server executable) or initdb

pub fn path_to_postgres<S: AsRef<OsStr>>(self, path_to_postgres: S) -> Self

normally not necessary

pub fn shutdown_mode(self, shutdown_mode: ShutdownMode) -> Self

MODE can be “smart”, “fast”, or “immediate”

pub fn signal<S: AsRef<OsStr>>(self, signal: S) -> Self

SIGNALNAME

pub fn pid<S: AsRef<OsStr>>(self, pid: S) -> Self

PID

Trait Implementations

impl Clone for PgCtlBuilder

fn clone(&self) -> PgCtlBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for PgCtlBuilder

fn get_program(&self) -> &'static OsStr

Get the program name

fn get_program_dir(&self) -> &Option<PathBuf>

Location of the program binary

fn get_args(&self) -> Vec<OsString>

Get the arguments for the command

fn get_envs(&self) -> Vec<(OsString, OsString)>

Get the environment variables for the command

fn env<S: AsRef<OsStr>>(self, key: S, value: S) -> Self

Set an environment variable for the command

fn get_program_file(&self) -> PathBuf

Fully qualified path to the program binary

fn build(self) -> Command

where Self: Sized,

Build a standard Command

impl Debug for PgCtlBuilder

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

Formats the value using the given formatter.

impl Default for PgCtlBuilder

fn default() -> PgCtlBuilder

Returns the “default value” for a type.