Struct StorageOptions 

pub struct StorageOptions(pub HashMap<String, String>);

Tuple Fields

0: HashMap<String, String>

Implementations

impl StorageOptions

pub fn with_env_s3(&mut self)

Add values from the environment to storage options.

Explicitly-set options (including aliases, case variants, and empty-string sentinels) always take precedence over env vars.

pub fn as_s3_options(&self) -> HashMap<AmazonS3ConfigKey, String>

Return options recognized by AmazonS3ConfigKey, ignoring unknown keys.

When aliases conflict, the exact canonical name (such as aws_region) wins, followed by case variants of that name. Remaining ties use the lexicographically smallest original key. Empty values are preserved.

use std::collections::HashMap;
use lance_io::object_store::StorageOptions;
use object_store::aws::AmazonS3ConfigKey;

let options = StorageOptions(HashMap::from([
    ("region".into(), "us-east-1".into()),
    ("aws_region".into(), "eu-west-1".into()),
]));
assert_eq!(options.as_s3_options()[&AmazonS3ConfigKey::Region], "eu-west-1");

pub fn aws_provider_scheme(&self) -> Result<Option<AwsProviderScheme>>

Parse the aws_provider_scheme storage option, if set.

impl StorageOptions

pub fn with_env_azure(&mut self)

Add values from the environment without overriding explicit options, including aliases, case variants, and empty-string values.

pub fn as_azure_options(&self) -> HashMap<AzureConfigKey, String>

Return options recognized by AzureConfigKey, ignoring unknown keys.

When aliases conflict, the exact canonical name (such as azure_storage_account_name) wins, followed by case variants of that name. Remaining ties use the lexicographically smallest original key. Empty values are preserved.

use std::collections::HashMap;
use lance_io::object_store::StorageOptions;
use object_store::azure::AzureConfigKey;

let options = StorageOptions(HashMap::from([
    ("account_name".into(), "alias".into()),
    ("azure_storage_account_name".into(), "canonical".into()),
]));
assert_eq!(options.as_azure_options()[&AzureConfigKey::AccountName], "canonical");

impl StorageOptions

pub fn with_env_gcs(&mut self)

Add values from the environment without overriding explicit options, including aliases, case variants, and empty-string values.

pub fn as_gcs_options(&self) -> HashMap<GoogleConfigKey, String>

Return options recognized by GoogleConfigKey, ignoring unknown keys.

When aliases conflict, the exact canonical name (such as google_service_account) wins, followed by case variants of that name. Remaining ties use the lexicographically smallest original key. Empty values are preserved.

use std::collections::HashMap;
use lance_io::object_store::StorageOptions;
use object_store::gcp::GoogleConfigKey;

let options = StorageOptions(HashMap::from([
    ("service_account".into(), "alias.json".into()),
    ("google_service_account".into(), "canonical.json".into()),
]));
assert_eq!(options.as_gcs_options()[&GoogleConfigKey::ServiceAccount], "canonical.json");

impl StorageOptions

pub fn new(options: HashMap<String, String>) -> Self

Create a new instance of StorageOptions

pub fn allow_http(&self) -> bool

Denotes if unsecure connections via http are allowed

pub fn block_size(&self) -> Result<Option<usize>>

Byte gap below which the I/O scheduler merges two reads of one file into a single request, overriding the store’s default.

pub fn download_retry_count(&self) -> usize

Number of times to retry a download that fails

pub fn client_max_retries(&self) -> usize

Max retry times to set in RetryConfig for object store client

pub fn client_retry_timeout(&self) -> u64

Seconds of timeout to set in RetryConfig for object store client

pub fn get(&self, key: &str) -> Option<&String>

pub fn client_options(&self) -> Result<ClientOptions>

Build ClientOptions with default headers extracted from headers.* keys.

Keys prefixed with headers. are parsed into HTTP headers. For example, headers.x-ms-version = 2023-11-03 results in a default header x-ms-version: 2023-11-03.

Returns an error if any headers.* key has an invalid header name or value.

pub fn expires_at_millis(&self) -> Option<u64>

Get the expiration time in milliseconds since epoch, if present

Trait Implementations

impl Clone for StorageOptions

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 StorageOptions

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

Formats the value using the given formatter.

impl Default for StorageOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<HashMap<String, String>> for StorageOptions

fn from(value: HashMap<String, String>) -> Self

Converts to this type from the input type.