Struct PostgresOutboxSettings 

#[non_exhaustive]
pub struct PostgresOutboxSettings {
    pub schema: String,
    pub enqueue_sets_search_path: bool,
    pub statement_timeout: Duration,
}

What is provider-specific about the outbox. Everything portable lives in reliar_outbox::OutboxSettings.

Built from Self::default plus builder methods, never a struct literal (#[non_exhaustive] so a new field never breaks a caller outside this crate):

use reliar_store_postgres::PostgresOutboxSettings;
use std::time::Duration;

let settings = PostgresOutboxSettings::default()
    .schema("orders")
    .enqueue_sets_search_path(true)
    .statement_timeout(Duration::from_secs(2));

assert_eq!(settings.schema, "orders");
assert!(settings.enqueue_sets_search_path);
assert_eq!(settings.statement_timeout, Duration::from_secs(2));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: String

The schema PostgresOutboxStore::new/connect verifies outbox resolves to, and the same default crate::MigrateOptions::schema uses. The two SHALL agree — if migrate() used a different schema, outbox is absent here and construction fails with crate::PostgresStoreError::NotMigrated or, if a same-named table exists elsewhere on the path, crate::PostgresStoreError::SchemaResolution. SCHEMA. Default "reliar".

enqueue_sets_search_path: bool

When true, enqueue wraps its INSERT in a transaction-local set_config('search_path', …, true) and restores the caller’s previous value afterward — for hosts that can change neither the connection URL nor the role. Costs three extra statements per enqueue, which is why it defaults to false. ENQUEUE_SETS_SEARCH_PATH.

statement_timeout: Duration

Applied as SET LOCAL statement_timeout inside the short transaction Reliar opens for every statement it issues on its own pool — acquire, complete, fail, release, extend_lease, stats, purge (each of its three statements), list_dead, retry_dead, purge_dead — never the caller’s enqueue transaction, which is the caller’s own to bound. Duration::ZERO (the default) issues nothing and inherits the server/role setting; a non-zero value costs a BEGIN/SET LOCAL/statement(s)/COMMIT round trip on every call. STATEMENT_TIMEOUT_MS.

Implementations

impl PostgresOutboxSettings

pub fn schema(self, schema: impl Into<String>) -> Self

Sets Self::schema.

use reliar_store_postgres::PostgresOutboxSettings;
let settings = PostgresOutboxSettings::default().schema("orders");
assert_eq!(settings.schema, "orders");

pub const fn enqueue_sets_search_path(self, enabled: bool) -> Self

Sets Self::enqueue_sets_search_path.

use reliar_store_postgres::PostgresOutboxSettings;
let settings = PostgresOutboxSettings::default().enqueue_sets_search_path(true);
assert!(settings.enqueue_sets_search_path);

pub const fn statement_timeout(self, timeout: Duration) -> Self

Sets Self::statement_timeout.

use reliar_store_postgres::PostgresOutboxSettings;
use std::time::Duration;

let settings = PostgresOutboxSettings::default()
    .statement_timeout(Duration::from_millis(500));
assert_eq!(settings.statement_timeout, Duration::from_millis(500));

pub fn from_env(prefix: &str) -> Result<Self, SettingsError>

Opt-in. Starts from Self::default, overrides only the variables present under prefix, and returns Err for a present-but-unparseable or out-of-range value — never a silent fallback to the default.

use reliar_store_postgres::PostgresOutboxSettings;

// SAFETY: doctests run single-threaded per binary; no other code reads this var.
unsafe { std::env::set_var("EXAMPLE_OUTBOX_SCHEMA", "orders") };
let settings = PostgresOutboxSettings::from_env("EXAMPLE_OUTBOX_")?;
assert_eq!(settings.schema, "orders");

Errors

Returns SettingsError::Parse for a present variable that cannot be parsed as its declared type.

Trait Implementations

impl Clone for PostgresOutboxSettings

fn clone(&self) -> PostgresOutboxSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresOutboxSettings

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

Formats the value using the given formatter.

impl Default for PostgresOutboxSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PostgresOutboxSettings

where PostgresOutboxSettings: Default,

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PostgresOutboxSettings

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.