Skip to main content

CloudStorageConfig

Enum CloudStorageConfig 

Source
pub enum CloudStorageConfig {
    S3 {
        bucket: String,
        region: Option<String>,
        endpoint: Option<String>,
        access_key_id: Option<String>,
        secret_access_key: Option<String>,
        session_token: Option<String>,
        virtual_hosted_style: bool,
    },
    Gcs {
        bucket: String,
        service_account_path: Option<String>,
        service_account_key: Option<String>,
    },
    Azure {
        container: String,
        account: String,
        access_key: Option<String>,
        sas_token: Option<String>,
    },
}
Expand description

Cloud storage backend configuration.

Supports Amazon S3, Google Cloud Storage, and Azure Blob Storage. Each variant contains the credentials and connection parameters for its respective cloud provider.

§Examples

// Create S3 configuration from environment variables
let config = CloudStorageConfig::s3_from_env("my-bucket");

// Create explicit S3 configuration for LocalStack testing
let config = CloudStorageConfig::S3 {
    bucket: "test-bucket".to_string(),
    region: Some("us-east-1".to_string()),
    endpoint: Some("http://localhost:4566".to_string()),
    access_key_id: Some("test".to_string()),
    secret_access_key: Some("test".to_string()),
    session_token: None,
    virtual_hosted_style: false,
};

Variants§

§

S3

Amazon S3 storage configuration.

Fields

§bucket: String

S3 bucket name.

§region: Option<String>

AWS region (e.g., “us-east-1”). Uses AWS_REGION env var if None.

§endpoint: Option<String>

Custom endpoint URL for S3-compatible services (MinIO, LocalStack).

§access_key_id: Option<String>

AWS access key ID. Uses AWS_ACCESS_KEY_ID env var if None.

§secret_access_key: Option<String>

AWS secret access key. Uses AWS_SECRET_ACCESS_KEY env var if None.

§session_token: Option<String>

AWS session token for temporary credentials.

§virtual_hosted_style: bool

Use virtual-hosted-style requests (bucket.s3.region.amazonaws.com).

§

Gcs

Google Cloud Storage configuration.

Fields

§bucket: String

GCS bucket name.

§service_account_path: Option<String>

Path to service account JSON key file.

§service_account_key: Option<String>

Service account JSON key content (alternative to path).

§

Azure

Azure Blob Storage configuration.

Fields

§container: String

Azure container name.

§account: String

Azure storage account name.

§access_key: Option<String>

Azure storage account access key.

§sas_token: Option<String>

Azure SAS token for limited access.

Implementations§

Source§

impl CloudStorageConfig

Source

pub fn s3_from_env(bucket: &str) -> Self

Creates an S3 configuration using environment variables.

Reads credentials from standard AWS environment variables:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_SESSION_TOKEN (optional)
  • AWS_REGION or AWS_DEFAULT_REGION
  • AWS_ENDPOINT_URL (optional, for S3-compatible services)
Source

pub fn gcs_from_env(bucket: &str) -> Self

Creates a GCS configuration using environment variables.

Reads service account path from GOOGLE_APPLICATION_CREDENTIALS.

Source

pub fn azure_from_env(container: &str) -> Self

Creates an Azure configuration using environment variables.

Reads credentials from Azure environment variables:

  • AZURE_STORAGE_ACCOUNT
  • AZURE_STORAGE_ACCESS_KEY (optional)
  • AZURE_STORAGE_SAS_TOKEN (optional)
§Panics

Panics if AZURE_STORAGE_ACCOUNT is not set.

Source

pub fn bucket_name(&self) -> &str

Returns the bucket/container name for this configuration.

Source

pub fn to_url(&self) -> String

Returns a URL-style identifier for this storage location.

Trait Implementations§

Source§

impl Clone for CloudStorageConfig

Source§

fn clone(&self) -> CloudStorageConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CloudStorageConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more