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:

• AWS_ACCESS_KEY_ID: S3 access key
• AWS_SECRET_ACCESS_KEY: S3 secret key
• AWS_DEFAULT_REGION: S3 region (default: “us-east-1”)
• AWS_BUCKET: S3 bucket name
• AWS_URL: S3 URL base

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.