Struct UploaderConfig 

pub struct UploaderConfig {
    pub endpoint: String,
    pub region: String,
    pub bucket: String,
    pub public_base_url: String,
    pub key_prefix: Option<String>,
    pub access_key_id: String,
    pub secret_access_key: String,
    pub download_timeout: Duration,
    pub max_file_size: u64,
    pub max_buffered_bytes: u64,
}

Configuration for the Garage uploader.

Use UploaderConfigBuilder to construct this.

Fields

endpoint: String

S3-compatible endpoint URL (e.g., “https://s3.example.com”)

region: String

S3 region (e.g., “garage” or “us-east-1”)

bucket: String

Target bucket name

public_base_url: String

Public CDN base URL for constructing public URLs

key_prefix: Option<String>

Optional prefix for all uploaded keys (e.g., “uploads/”)

access_key_id: String

AWS/Garage access key ID

secret_access_key: String

AWS/Garage secret access key

download_timeout: Duration

HTTP client timeout for downloads

max_file_size: u64

Maximum file size in bytes (default: 100MB)

max_buffered_bytes: u64

Maximum size in bytes to buffer in memory when downloading (default: 8MB).

Responses larger than this (or with unknown Content-Length) are streamed and still capped by max_file_size.

Implementations

impl UploaderConfig

pub fn builder() -> UploaderConfigBuilder

Create a new configuration builder.

pub fn from_env() -> Result<Self>

Create a configuration from environment variables.

Reads the following environment variables:

• GARAGE_ENDPOINT or S3_ENDPOINT
• GARAGE_REGION or S3_REGION (optional, defaults to “garage”)
• GARAGE_BUCKET or S3_BUCKET
• GARAGE_PUBLIC_URL or S3_PUBLIC_URL
• GARAGE_KEY_PREFIX or S3_KEY_PREFIX (optional)
• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY

pub fn from_secret_dir(path: impl AsRef<Path>) -> Result<Self>

Create a configuration from a directory of secret files.

Expected filenames:

• endpoint
• region (optional, defaults to “garage”)
• bucket
• public_url
• key_prefix (optional)
• access_key_id
• secret_access_key

pub fn from_secret_dir_with_names( path: impl AsRef<Path>, names: &SecretFileNames, ) -> Result<Self>

Create a configuration from a directory of secret files with custom filenames.

pub fn from_env_or_secret_dir(path: impl AsRef<Path>) -> Result<Self>

Create a configuration from environment variables, falling back to a secret directory.

Trait Implementations

impl Clone for UploaderConfig

fn clone(&self) -> UploaderConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UploaderConfig

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

Formats the value using the given formatter.