Struct StorageConfig 

#[non_exhaustive]
pub struct StorageConfig {
    pub disk: DiskDriver,
    pub bucket: Option<String>,
    pub region: Option<String>,
    pub endpoint: Option<String>,
    pub access_key_id: Option<String>,
    pub secret_access_key: Option<String>,
    pub url: Option<String>,
    pub root: Option<PathBuf>,
}

Settings for state.storage, from STORAGE_DISK and S3_*.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

disk: DiskDriver

A local folder or an S3 bucket.

bucket: Option<String>

The S3 bucket, from S3_BUCKET.

region: Option<String>

The S3 region, from S3_REGION.

endpoint: Option<String>

An S3-compatible endpoint, from S3_ENDPOINT (AWS when unset).

access_key_id: Option<String>

The S3 access key id, from S3_ACCESS_KEY_ID.

secret_access_key: Option<String>

The S3 secret key, from S3_SECRET_ACCESS_KEY.

url: Option<String>

Public base URL for keys under public/ (bucket URL or CDN), for S3.

root: Option<PathBuf>

Where a local disk keeps its files. None: STORAGE_PATH/app for state.storage, STORAGE_PATH/<name> for a named disk.

Implementations

impl StorageConfig

pub fn from_env(config: &Config, prefix: &str) -> Result<Self>

A disk’s settings from variables starting with prefix, for App::disk: <PREFIX>_DISK (local or s3, default local), <PREFIX>_PATH (a local disk’s folder), <PREFIX>_BUCKET, <PREFIX>_URL, and <PREFIX>_REGION, <PREFIX>_ENDPOINT, <PREFIX>_ACCESS_KEY_ID, <PREFIX>_SECRET_ACCESS_KEY, which fall back to the S3_* ones.

Trait Implementations

impl Clone for StorageConfig

fn clone(&self) -> Self

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.