Struct StorageConfig 

pub struct StorageConfig {
    pub default: String,
    pub disks: HashMap<String, DiskConfig>,
}

Configuration for the storage system.

Fields

default: String

Default disk name.

disks: HashMap<String, DiskConfig>

Disk configurations.

Implementations

impl StorageConfig

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

Create a new storage config with a default disk.

pub fn from_env() -> Self

Create configuration from environment variables.

Reads the following environment variables:

• FILESYSTEM_DISK: Default disk name (default: “local”)
• FILESYSTEM_LOCAL_ROOT: Root path for local disk (default: “./storage”)
• FILESYSTEM_LOCAL_URL: Public URL for local files
• FILESYSTEM_PUBLIC_ROOT: Root path for public disk (default: “./storage/public”)
• FILESYSTEM_PUBLIC_URL: Public URL for public files (default: “/storage”)

With s3 feature (provider-agnostic — works for any S3-compatible backend):

• STORAGE_ACCESS_KEY_ID: access key (alias: AWS_ACCESS_KEY_ID, deprecated)
• STORAGE_SECRET_KEY: secret key (alias: AWS_SECRET_ACCESS_KEY, deprecated)
• STORAGE_REGION: region, default: "us-east-1" (alias: AWS_DEFAULT_REGION, deprecated)
• STORAGE_BUCKET: bucket name (alias: AWS_BUCKET, deprecated). When set, an s3 disk is registered.
• STORAGE_PUBLIC_URL: public base URL for generated file URLs; overrides STORAGE_ENDPOINT for URL building (alias: AWS_PUBLIC_URL, deprecated)
• STORAGE_ENDPOINT: S3 API endpoint; also used as public URL base if STORAGE_PUBLIC_URL is not set (alias: AWS_URL, deprecated)
• CDN_URL: CDN base URL fronting the bucket (used by cdn_url()). Legacy aliases AWS_CDN_URL, CF_CDN_URL, and BUNNY_CDN_URL are still accepted with a deprecation warning. Also reads CDN_PROVIDER / CDN_PURGE_TOKEN / CDN_PURGE_ZONE for cache-invalidation configuration; see crate::cdn::Config.

Example

use ferro_storage::{StorageConfig, Storage};

let config = StorageConfig::from_env();
let storage = Storage::with_storage_config(config);

pub fn disk(self, name: impl Into<String>, config: DiskConfig) -> Self

Add a disk configuration.

pub fn default_disk(self, name: impl Into<String>) -> Self

Set the default disk.

pub fn get_default(&self) -> &str

Get the default disk name.

pub fn get_disk(&self, name: &str) -> Option<&DiskConfig>

Get a disk configuration by name.

Trait Implementations

impl Clone for StorageConfig

fn clone(&self) -> StorageConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageConfig

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

Formats the value using the given formatter.

impl Default for StorageConfig

fn default() -> Self

Returns the “default value” for a type.