Enum StoreConfig 

pub enum StoreConfig {
    LocalFs {
        root: String,
        key_prefix: Option<String>,
    },
    AwsS3 {
        bucket: String,
        region: String,
        endpoint_url: Option<String>,
        access_key_id: SecretString,
        secret_access_key: SecretString,
        session_token: Option<SecretString>,
        key_prefix: Option<String>,
        force_path_style: bool,
    },
    CloudflareR2 {
        bucket: String,
        account_id: String,
        endpoint_url: String,
        access_key_id: SecretString,
        secret_access_key: SecretString,
        key_prefix: Option<String>,
    },
    GcpGcs {
        bucket: String,
        service_account_key_path: String,
        key_prefix: Option<String>,
    },
    AzureAbs {
        account_name: String,
        container_name: String,
        access_key: SecretString,
        endpoint_url: Option<String>,
        key_prefix: Option<String>,
    },
}

Provider selection plus credentials, as written in config files.

Serialization is transparent for secret fields and therefore writes the real credentials; only serialize a StoreConfig::redacted copy into display output.

Credential precedence

The S3-compatible credential fields may be left out of the file and supplied through the standard environment instead — see StoreConfig::apply_env_credentials. A non-blank value in the file always wins; blank environment values are ignored. Loading a config is what decides whether that fallback applies, so each caller says for itself: the server’s loader applies it, the CLI’s profile loader does not (a profile stores what it was created with).

Variants

LocalFs

Stores objects beneath a Unix-family directory using atomic filesystem replacement.

Fields

root: String

Directory created or opened as the physical store root.

key_prefix: Option<String>

Logical prefix applied inside root, or None to expose it directly.

AwsS3

Connects to AWS S3 or an explicitly configured S3-compatible endpoint.

Fields

bucket: String

Bucket that acts as the physical store root.

region: String

SigV4 signing region.

endpoint_url: Option<String>

Service endpoint override, or None to derive the regional AWS endpoint.

access_key_id: SecretString

Access-key id used for provider requests and direct-upload signing. Absent here means AWS_ACCESS_KEY_ID, for loaders that apply the environment fallback.

secret_access_key: SecretString

Secret access key used for provider requests and direct-upload signing. Absent here means AWS_SECRET_ACCESS_KEY, for loaders that apply the environment fallback.

session_token: Option<SecretString>

Temporary credential token, or None for long-lived credentials.

key_prefix: Option<String>

Logical prefix applied inside the bucket, or None to expose its root.

force_path_style: bool

Uses path-style bucket addressing when true; defaults to virtual-hosted style.

CloudflareR2

Connects to Cloudflare R2 through its S3-compatible endpoint.

Fields

bucket: String

R2 bucket that acts as the physical store root.

account_id: String

Cloudflare account identity used to validate provider configuration.

endpoint_url: String

Account-level R2 S3 endpoint used with path-style bucket addressing.

access_key_id: SecretString

S3-compatible access-key id used for requests and direct-upload signing. R2 speaks the S3 API, so an absent value here means AWS_ACCESS_KEY_ID too.

secret_access_key: SecretString

S3-compatible secret used for requests and direct-upload signing. Absent here means AWS_SECRET_ACCESS_KEY.

key_prefix: Option<String>

Logical prefix applied inside the bucket, or None to expose its root.

GcpGcs

Connects to Google Cloud Storage through its native generation-aware API.

Fields

bucket: String

GCS bucket that acts as the physical store root.

service_account_key_path: String

Filesystem path to the service-account JSON used for authentication.

key_prefix: Option<String>

Logical prefix applied inside the bucket, or None to expose its root.

AzureAbs

Connects to Azure Blob Storage through its native shared-key API.

Fields

account_name: String

Azure storage account used for addressing and signing.

container_name: String

Blob container that acts as the physical store root.

access_key: SecretString

Shared account key used for request authentication.

endpoint_url: Option<String>

Azure-compatible endpoint override, or None for the public service.

key_prefix: Option<String>

Logical prefix applied inside the container, or None to expose its root.

Implementations

impl StoreConfig

pub fn kind(&self) -> ConfiguredObjectStoreKind

The provider kind this configuration selects.

pub fn direct_put_is_proven(&self) -> bool

Whether this endpoint is one whose direct-put preconditions the live conformance suite has actually proven.

direct_put hands a client a presigned URL and then trusts the provider to have enforced the signed checksum and create-only preconditions — completion never reads the bytes back. Only first-party AWS S3 and Cloudflare R2 endpoints have been run against that suite, so only they earn the trust. An endpoint override outside the provider’s own domain family is some other implementation of the S3 API and is not covered by those runs.

Providers without a presigner at all (local filesystem, GCS, Azure) never reach this question: direct_put is unavailable for them because ConfiguredObjectStore::transfer_issuer returns None.

pub fn configured_object_store(&self) -> Result<ConfiguredObjectStore>

Builds the configured runtime object store for this provider.

pub fn apply_env_credentials(&mut self)

Fills blank S3-compatible credential fields from the standard environment variables, so a config file need not carry secrets at all.

A non-blank value in the file always wins, and a blank environment value is ignored rather than stored and later rejected. Providers with no standard variable of their own — local filesystem, GCS, Azure — are untouched: inventing a name for them would be a guess.

Call this after decoding and before Self::validate, so a config that relies on the environment passes validation and one that does not is reported against the field it actually lacks.

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

Checks required fields and URL shapes, reporting store.-rooted field paths.

pub fn redacted(&self) -> Self

Returns a copy whose secret fields hold the redaction placeholder, for serialization into show-style display output.

Trait Implementations

impl Clone for StoreConfig

fn clone(&self) -> StoreConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoreConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StoreConfig

impl PartialEq for StoreConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StoreConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StoreConfig