Enum Storage 

pub enum Storage {
    FileSystem {
        path: PathBuf,
    },
    S3Compatible {
        endpoint: String,
        bucket: String,
    },
    Gcs {
        endpoint: Option<String>,
        bucket: String,
    },
    BigTable {
        endpoint: Option<String>,
        project_id: String,
        instance_name: String,
        table_name: String,
        connections: Option<usize>,
    },
}

Storage backend configuration.

The type field in YAML or __TYPE in environment variables determines which variant is used.

Used in: Config::high_volume_storage, Config::long_term_storage

Variants

FileSystem

Local filesystem storage backend (type "filesystem").

Stores objects as files on the local filesystem. Suitable for development, testing, and single-server deployments.

Example

long_term_storage:
  type: filesystem
  path: /data

Fields

path: PathBuf

Directory path for storing objects.

The directory will be created if it doesn’t exist. Relative paths are resolved from the server’s working directory.

Default

"data" (relative to the server’s working directory)

Environment Variables

• OS__HIGH_VOLUME_STORAGE__TYPE=filesystem
• OS__HIGH_VOLUME_STORAGE__PATH=/path/to/storage

Or for long-term storage:

• OS__LONG_TERM_STORAGE__TYPE=filesystem
• OS__LONG_TERM_STORAGE__PATH=/path/to/storage

S3Compatible

S3-compatible storage backend (type "s3compatible").

Supports Amazon S3 and other S3-compatible services. Authentication is handled via environment variables (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY) or IAM roles.

Example

long_term_storage:
  type: s3compatible
  endpoint: https://s3.amazonaws.com
  bucket: my-bucket

Fields

endpoint: String

S3 endpoint URL.

Examples: https://s3.amazonaws.com, http://localhost:9000 (for MinIO)

Environment Variables

• OS__HIGH_VOLUME_STORAGE__TYPE=s3compatible
• OS__HIGH_VOLUME_STORAGE__ENDPOINT=https://s3.amazonaws.com

Or for long-term storage:

• OS__LONG_TERM_STORAGE__TYPE=s3compatible
• OS__LONG_TERM_STORAGE__ENDPOINT=https://s3.amazonaws.com

bucket: String

S3 bucket name.

The bucket must exist before starting the server.

Environment Variables

• OS__HIGH_VOLUME_STORAGE__BUCKET=my-bucket
• OS__LONG_TERM_STORAGE__BUCKET=my-bucket

Gcs

Google Cloud Storage backend (type "gcs").

Stores objects in Google Cloud Storage (GCS). Authentication uses Application Default Credentials (ADC), which can be provided via the GOOGLE_APPLICATION_CREDENTIALS environment variable or GCE/GKE metadata service.

Note: The bucket must be pre-created with the following lifecycle policy:

• daysSinceCustomTime: 1 day
• action: delete

Example

long_term_storage:
  type: gcs
  bucket: objectstore-bucket

Fields

endpoint: Option<String>

Optional custom GCS endpoint URL.

Useful for testing with emulators. If None, uses the default GCS endpoint.

Default

None (uses default GCS endpoint)

Environment Variables

• OS__HIGH_VOLUME_STORAGE__TYPE=gcs
• OS__HIGH_VOLUME_STORAGE__ENDPOINT=http://localhost:9000 (optional)

Or for long-term storage:

• OS__LONG_TERM_STORAGE__TYPE=gcs
• OS__LONG_TERM_STORAGE__ENDPOINT=http://localhost:9000 (optional)

bucket: String

GCS bucket name.

The bucket must exist before starting the server.

Environment Variables

• OS__HIGH_VOLUME_STORAGE__BUCKET=my-gcs-bucket
• OS__LONG_TERM_STORAGE__BUCKET=my-gcs-bucket

BigTable

Google Bigtable backend (type "bigtable").

Stores objects in Google Cloud Bigtable, a NoSQL wide-column database. This backend is optimized for high-throughput, low-latency workloads with small objects. Authentication uses Application Default Credentials (ADC).

Note: The table must be pre-created with appropriate column families. Ensure to have the following column families:

• fg: timestamp-based garbage collection (maxage=1s)
• fm: manual garbage collection (no GC policy)

Example

high_volume_storage:
  type: bigtable
  project_id: my-project
  instance_name: objectstore
  table_name: objectstore

Fields

endpoint: Option<String>

Optional custom Bigtable endpoint.

Useful for testing with emulators. If None, uses the default Bigtable endpoint.

Default

None (uses default Bigtable endpoint)

Environment Variables

• OS__HIGH_VOLUME_STORAGE__TYPE=bigtable
• OS__HIGH_VOLUME_STORAGE__ENDPOINT=localhost:8086 (optional)

Or for long-term storage:

• OS__LONG_TERM_STORAGE__TYPE=bigtable
• OS__LONG_TERM_STORAGE__ENDPOINT=localhost:8086 (optional)

project_id: String

GCP project ID.

The Google project ID (not project number) containing the Bigtable instance.

Environment Variables

• OS__HIGH_VOLUME_STORAGE__PROJECT_ID=my-project
• OS__LONG_TERM_STORAGE__PROJECT_ID=my-project

instance_name: String

Bigtable instance name.

Environment Variables

• OS__HIGH_VOLUME_STORAGE__INSTANCE_NAME=my-instance
• OS__LONG_TERM_STORAGE__INSTANCE_NAME=my-instance

table_name: String

Bigtable table name.

The table must exist before starting the server.

Environment Variables

• OS__HIGH_VOLUME_STORAGE__TABLE_NAME=objectstore
• OS__LONG_TERM_STORAGE__TABLE_NAME=objectstore

connections: Option<usize>

Optional number of connections to maintain to Bigtable.

Default

None (infers connection count based on CPU count)

Environment Variables

• OS__HIGH_VOLUME_STORAGE__CONNECTIONS=16 (optional)
• OS__LONG_TERM_STORAGE__CONNECTIONS=16 (optional)

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Storage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Storage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Storage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.