Struct PostgresStateStoreConfig 

pub struct PostgresStateStoreConfig { /* private fields */ }

PostgreSQL StateStore configuration.

PostgreSQL StateStore support requires the postgres feature and is intended for remote durable control-plane state. This always-available config stays pure data until it is passed to crate::state::config::StateStoreConfig::postgres and opened through crate::StateStore::connect. Password bytes are only exposed at the final authentication boundary inside the private PostgreSQL backend.

Examples

let password = storage_kit::state::config::Password::from_string("state-store-secret")?;
let config = storage_kit::state::config::PostgresStateStoreConfig::localhost(
    "storage_kit_state",
    "storage_kit",
)
.with_password(password)
.with_port(15432)
.with_operation_timeout(std::time::Duration::from_secs(2))?;
let state_config = storage_kit::state::config::StateStoreConfig::postgres(config.clone());

assert_eq!(config.host(), "127.0.0.1");
assert_eq!(config.port(), 15432);
assert_eq!(config.tls_mode(), storage_kit::state::config::PostgresStateStoreTlsMode::Disable);
assert!(!format!("{config:?}").contains("state-store-secret"));
assert_eq!(state_config.validate(), Ok(()));

Implementations

impl PostgresStateStoreConfig

pub fn new( host: impl Into<String>, database: impl Into<String>, username: impl Into<String>, ) -> Self

Builds a PostgreSQL StateStore config.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::new(
    "127.0.0.1",
    "storage_kit_state",
    "storage_kit",
);
if config.host() != "127.0.0.1" {
    return Err("unexpected host".into());
}

pub fn localhost( database: impl Into<String>, username: impl Into<String>, ) -> Self

Builds a PostgreSQL StateStore config for 127.0.0.1.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost(
    "storage_kit_state",
    "storage_kit",
);
if config.host() != "127.0.0.1" {
    return Err("unexpected host".into());
}

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

Replaces the PostgreSQL server port.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_port(15432);
if config.port() != 15432 {
    return Err("unexpected port".into());
}

pub fn with_password(self, password: Password) -> Self

Sets the password used by PostgreSQL authentication.

Examples

let password = storage_kit::state::config::Password::from_string("secret")?;
let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_password(password);
if config.password().is_none() {
    return Err("expected password".into());
}

pub fn without_password(self) -> Self

Clears any configured password.

Examples

let password = storage_kit::state::config::Password::from_string("secret")?;
let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_password(password)
    .without_password();
if config.password().is_some() {
    return Err("unexpected password".into());
}

pub fn with_operation_timeout( self, timeout: Duration, ) -> Result<Self, StateStoreError>

Replaces the per-operation timeout.

Errors

Returns an invalid-config error when the timeout cannot be represented as milliseconds.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_operation_timeout(std::time::Duration::from_millis(250))?;
if config.operation_timeout().as_millis() != 250 {
    return Err("unexpected timeout".into());
}

pub fn host(&self) -> &str

Returns the configured host.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::new(
    "db.internal",
    "storage_kit_state",
    "storage_kit",
);
assert_eq!(config.host(), "db.internal");

pub fn port(&self) -> u16

Returns the configured port.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_port(15432);
assert_eq!(config.port(), 15432);

pub fn database(&self) -> &str

Returns the configured database name.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost(
    "storage_kit_state",
    "storage_kit",
);
assert_eq!(config.database(), "storage_kit_state");

pub fn username(&self) -> &str

Returns the configured username.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost(
    "storage_kit_state",
    "storage_kit",
);
assert_eq!(config.username(), "storage_kit");

pub fn password(&self) -> Option<&Password>

Returns the configured password, if present.

Examples

let password = storage_kit::state::config::Password::from_string("secret")?;
let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_password(password);
assert!(config.password().is_some());

pub fn tls_mode(&self) -> PostgresStateStoreTlsMode

Returns the configured TLS mode.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user");
assert_eq!(
    config.tls_mode(),
    storage_kit::state::config::PostgresStateStoreTlsMode::Disable
);

pub fn operation_timeout(&self) -> Duration

Returns the configured operation timeout.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user")
    .with_operation_timeout(std::time::Duration::from_millis(750))?;
assert_eq!(config.operation_timeout().as_millis(), 750);

pub fn validate(&self) -> Result<(), StateStoreError>

Validates PostgreSQL StateStore configuration.

Errors

Returns an invalid-config error when text fields, port, or operation timeout are unusable.

Examples

let config = storage_kit::state::config::PostgresStateStoreConfig::localhost("db", "user");
config.validate()?;
let invalid = storage_kit::state::config::PostgresStateStoreConfig::new("", "db", "user");
assert!(matches!(
    invalid.validate(),
    Err(storage_kit::StateStoreError::InvalidConfig(_))
));

Trait Implementations

impl Clone for PostgresStateStoreConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresStateStoreConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PostgresStateStoreConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PostgresStateStoreConfig> for StateStoreConfig

fn from(config: PostgresStateStoreConfig) -> Self

Converts to this type from the input type.

impl Serialize for PostgresStateStoreConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.