Crate pg_embedded_setup_unpriv 

Facilitates preparing an embedded PostgreSQL instance while dropping root privileges.

The library owns the lifecycle for configuring paths, permissions, and process identity so the bundled PostgreSQL binaries can initialize safely under an unprivileged account.

Modules

cache

Shared binary cache for PostgreSQL downloads.

extensions

Prebuilt extension installation for embedded PostgreSQL trees.

observability

Shared tracing configuration and metric recording for observability.

Structs

BootstrapError

Captures bootstrap-specific failures.

ClusterGuard

Lifecycle guard for a running PostgreSQL cluster.

ClusterHandle

Send-safe handle providing read-only access to a running PostgreSQL cluster.

ConnectionMetadata

Provides ergonomic accessors for connection-oriented cluster metadata.

DatabaseName

A strongly-typed database name for use with lifecycle operations.

PgEnvCfg

Captures PostgreSQL settings supplied via environment variables.

PrivilegeError

Captures privilege-management failures.

TemporaryDatabase

RAII guard that drops a database when it goes out of scope.

TestBootstrapEnvironment

Holds filesystem and time zone settings used by the bootstrap tests.

TestBootstrapSettings

Structured settings returned from bootstrap_for_tests.

TestCluster

Embedded PostgreSQL instance whose lifecycle follows Rust’s drop semantics.

TestClusterConnection

Accessor for connection helpers derived from a TestCluster.

Enums

BootstrapErrorKind

Categorizes bootstrap failures so callers can branch on structured errors.

CleanupMode

Controls cleanup behaviour when a cluster is dropped.

Error

Top-level error exposed by the crate.

ExecutionMode

Selects how PostgreSQL lifecycle commands run when privileged execution is required.

ExecutionPrivileges

Represents the privileges the process is running with when bootstrapping PostgreSQL.

PasswordReuseOutcome

Why the bootstrap did or did not adopt a stored password; a bounded label for the password_reuse tracing event.

PgEmbeddedError

Top-level error exposed by the crate.

Constants

MIN_MAX_CONNECTIONS

Smallest PG_MAX_CONNECTIONS the helper accepts: one ordinary slot above PostgreSQL’s default of three reserved superuser connections.

Functions

ambient_dir_and_path

Resolves a path to an ambient directory handle paired with the relative path component.

bootstrap_for_tests

Bootstraps PostgreSQL for integration tests and surfaces the prepared settings.

default_paths_for

Computes default installation and data directories for a given uid.

default_paths_under

Derives the default install and data directories under root.

default_root_for

Returns the per-user base directory used when PG_EMBED_ROOT is unset.

detect_execution_privileges

Detects whether the process is running with root privileges.

find_timezone_dir

Probes common Unix paths for the time zone database directory.

make_data_dir_private

Ensures dir exists, is owned by user, and has PostgreSQL-compatible 0700 permissions.

make_dir_accessible

Ensures dir exists, is owned by user, and grants world-readable access.

nobody_uid

Retrieves the UID of the nobody account, defaulting to 65534 when absent.

reuse_existing_password

Aligns settings.password with the cluster already present in data_dir, unless the caller supplied an explicit password.

run

Bootstraps an embedded PostgreSQL instance, downloads the distribution, and initializes the data directory via initdb.

stored_cluster_password

Reads the password an existing cluster in data_dir was initialized with.

Type Aliases

PrivilegeResult

Result alias for privilege-management fallible operations.

Result

Result alias for operations that may return a PgEmbeddedError.