Struct ObjectStorageConfig

pub struct ObjectStorageConfig {
    pub url: String,
    pub other_options: BTreeMap<String, String>,
}

Fields

url: String

URL.

The following URL schemes are supported:

• S3:
  • s3://<bucket>/<path>
  • s3a://<bucket>/<path>
  • https://s3.<region>.amazonaws.com/<bucket>
  • https://<bucket>.s3.<region>.amazonaws.com
  • https://ACCOUNT_ID.r2.cloudflarestorage.com/bucket
• Google Cloud Storage:
  • gs://<bucket>/<path>
• Microsoft Azure Blob Storage:
  • abfs[s]://<container>/<path> (according to fsspec)
  • abfs[s]://<file_system>@<account_name>.dfs.core.windows.net/<path>
  • abfs[s]://<file_system>@<account_name>.dfs.fabric.microsoft.com/<path>
  • az://<container>/<path> (according to fsspec)
  • adl://<container>/<path> (according to fsspec)
  • azure://<container>/<path> (custom)
  • https://<account>.dfs.core.windows.net
  • https://<account>.blob.core.windows.net
  • https://<account>.blob.core.windows.net/<container>
  • https://<account>.dfs.fabric.microsoft.com
  • https://<account>.dfs.fabric.microsoft.com/<container>
  • https://<account>.blob.fabric.microsoft.com
  • https://<account>.blob.fabric.microsoft.com/<container>

Settings derived from the URL will override other settings.

other_options: BTreeMap<String, String>

Additional options as key-value pairs.

The following keys are supported:

• S3:
  • access_key_id: AWS Access Key.
  • secret_access_key: AWS Secret Access Key.
  • region: Region.
  • default_region: Default region.
  • endpoint: Custom endpoint for communicating with S3, e.g. https://localhost:4566 for testing against a localstack instance.
  • token: Token to use for requests (passed to underlying provider).
  • Other keys.
• Google Cloud Storage:
  • service_account: Path to the service account file.
  • service_account_key: The serialized service account key.
  • google_application_credentials: Application credentials path.
  • Other keys.
• Microsoft Azure Blob Storage:
  • access_key: Azure Access Key.
  • container_name: Azure Container Name.
  • account: Azure Account.
  • bearer_token_authorization: Static bearer token for authorizing requests.
  • client_id: Client ID for use in client secret or Kubernetes federated credential flow.
  • client_secret: Client secret for use in client secret flow.
  • tenant_id: Tenant ID for use in client secret or Kubernetes federated credential flow.
  • endpoint: Override the endpoint for communicating with blob storage.
  • Other keys.

Options set through the URL take precedence over those set with these options.

Trait Implementations

impl Clone for ObjectStorageConfig

fn clone(&self) -> ObjectStorageConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectStorageConfig

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

Formats the value using the given formatter.

impl Default for ObjectStorageConfig

fn default() -> ObjectStorageConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObjectStorageConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ObjectStorageConfig

fn eq(&self, other: &ObjectStorageConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ObjectStorageConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for ObjectStorageConfig

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for ObjectStorageConfig

impl StructuralPartialEq for ObjectStorageConfig