Struct pg_embed::postgres::PgEmbed[][src]

pub struct PgEmbed {
    pub pg_settings: PgSettings,
    pub fetch_settings: FetchSettings,
    pub process: Option<Child>,
    pub db_uri: String,
}

Embedded postgresql database

If the PgEmbed instance is dropped / goes out of scope and postgresql is still running, the postgresql process will be killed and depending on the PgSettings::persistent setting, file and directories will be cleaned up.

Fields

pg_settings: PgSettings

Postgresql settings

fetch_settings: FetchSettings

Download settings

process: Option<Child>

The postgresql process

Some(process) if process is running, otherwise None

db_uri: String

Implementations

impl PgEmbed[src]

pub fn new(pg_settings: PgSettings, fetch_settings: FetchSettings) -> Self[src]

Create a new PgEmbed instance

pub fn clean(&self) -> Result<(), PgEmbedError>[src]

Clean up created files and directories.

Remove created directories containing the postgresql executables, the database and the password file.

pub async fn setup(&self) -> Result<(), PgEmbedError>[src]

Setup postgresql for execution

Download, unpack, create password file and database

pub async fn aquire_postgres(&self) -> Result<(), PgEmbedError>[src]

Download and unpack postgres binaries

pub async fn init_db(&self) -> Result<bool, PgEmbedError>[src]

Initialize postgresql database

Returns Ok(bool) on success (false if the database directory already exists, true if it needed to be created), otherwise returns an error.

pub async fn start_db(&mut self) -> Result<(), PgEmbedError>[src]

Start postgresql database

Returns Ok(()) on success, otherwise returns an error.

pub fn stop_db(&mut self) -> Result<(), PgEmbedError>[src]

Stop postgresql database

Returns Ok(()) on success, otherwise returns an error.

pub async fn create_password_file(&self) -> Result<(), PgEmbedError>[src]

Create a database password file

Returns Ok(()) on success, otherwise returns an error.

pub async fn create_database(&self, db_name: &str) -> Result<(), PgEmbedError>[src]

Create a database

pub fn full_db_uri(&self, db_name: &str) -> String[src]

Trait Implementations

impl Drop for PgEmbed[src]

Auto Trait Implementations

impl RefUnwindSafe for PgEmbed

impl Send for PgEmbed

impl Sync for PgEmbed

impl Unpin for PgEmbed

impl UnwindSafe for PgEmbed

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Conv for T

impl<T> Conv for T

impl<T> FmtForward for T

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pipe for T where
    T: ?Sized

impl<T> Pipe for T

impl<T> PipeAsRef for T

impl<T> PipeBorrow for T

impl<T> PipeDeref for T

impl<T> PipeRef for T

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

impl<T> Tap for T

impl<T, U> TapAsRef<U> for T where
    U: ?Sized

impl<T, U> TapBorrow<U> for T where
    U: ?Sized

impl<T> TapDeref for T

impl<T> TryConv for T

impl<T> TryConv for T

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,