Struct BackupConfig 

pub struct BackupConfig {
    pub s3_url: String,
    pub wal_interval_ms: u64,
    pub manifest_interval_s: u64,
    pub retain_n: usize,
    pub sse: Option<String>,
    pub lease_ttl_s: u64,
    pub lease_conditional: bool,
    pub op_timeout_ms: u64,
    pub shutdown_grace_ms: u64,
}

Backup settings, read from the environment by BackupConfig::from_env.

Fields

s3_url: String

MUSHROOMDB_BACKUP_S3_URL: s3://bucket/prefix, r2://bucket/prefix or minio://bucket/prefix.

wal_interval_ms: u64

MUSHROOMDB_BACKUP_WAL_INTERVAL_MS: how often new WAL bytes ship.

manifest_interval_s: u64

MUSHROOMDB_BACKUP_MANIFEST_INTERVAL_S: how often a manifest is written while segments accumulate between snapshots.

retain_n: usize

MUSHROOMDB_BACKUP_RETAIN_N: manifests kept; 0 keeps every one.

sse: Option<String>

MUSHROOMDB_BACKUP_SSE: server-side encryption (AES256, aws:kms, aws:kms:dsse), or None for the bucket’s default.

lease_ttl_s: u64

MUSHROOMDB_BACKUP_LEASE_TTL: bucket-lease TTL in seconds (at least 1). The holder renews every third of it and stops writing two thirds in; another instance may take the lease over once it is this old.

lease_conditional: bool

MUSHROOMDB_BACKUP_LEASE_CONDITIONAL: on (the default) takes and renews the lease with conditional PUTs (If-None-Match / If-Match), which AWS S3, R2 and MinIO honor; off for a service that rejects those headers, leaving the lease best-effort (see crate::lease).

op_timeout_ms: u64

MUSHROOMDB_BACKUP_OP_TIMEOUT_MS: the most one object-store request (one PUT, one part, one GET, one LIST, one DELETE) may take before the worker gives up on it and counts a failure. The client’s own retries can otherwise hold a black-holed bucket for minutes.

shutdown_grace_ms: u64

MUSHROOMDB_BACKUP_SHUTDOWN_GRACE_MS: how long the shutdown flush may take before the in-flight upload is abandoned and the worker stops.

Implementations

impl BackupConfig

pub fn from_env() -> Result<Option<Self>, BackupError>

Read the configuration from the process environment. Ok(None) when MUSHROOMDB_BACKUP_S3_URL is unset or empty: backup is off.

Errors

A set but malformed value — a backup the operator asked for is never silently turned off by a typo.

pub fn from_lookup( get: impl Fn(&str) -> Option<String>, ) -> Result<Option<Self>, BackupError>

from_env over any variable lookup.

pub fn new(s3_url: impl Into<String>) -> Self

A configuration for s3_url with every other setting at its default.

pub fn shutdown_budget(&self) -> Duration

The longest a shutdown can keep the process alive on account of the backup: the flush’s grace, then the lease release (one request, one op_timeout_ms), plus SHUTDOWN_MARGIN for scheduling. The serve loop waits this long for the worker, so a platform’s stop timeout must exceed it by whatever the HTTP drain and the shutdown snapshot take (see the deployment guide).

pub fn fit_shutdown_within(&mut self, within: Duration)

Shrink the flush grace and the request deadline until they, plus a margin of at most SHUTDOWN_MARGIN, fit in within, keeping their ratio. Does nothing when shutdown_budget already fits. For a serve whose whole shutdown window is shorter than the configured bounds: the lease release still gets a request deadline of its own.

pub fn location(&self) -> Result<S3Location, BackupError>

The bucket and prefix s3_url names.

Trait Implementations

impl Clone for BackupConfig

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 BackupConfig

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

Formats the value using the given formatter.

impl Eq for BackupConfig

impl PartialEq for BackupConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BackupConfig