Struct ObjectStoreParams 

pub struct ObjectStoreParams {
    pub block_size: Option<usize>,
    pub object_store: Option<(Arc<dyn ObjectStore>, Url)>,
    pub s3_credentials_refresh_offset: Duration,
    pub object_store_wrapper: Option<Arc<dyn WrappingObjectStore>>,
    pub storage_options_accessor: Option<Arc<StorageOptionsAccessor>>,
    pub use_constant_size_upload_parts: bool,
    pub list_is_lexically_ordered: Option<bool>,
}

Parameters to create an ObjectStore

Fields

block_size: Option<usize>

object_store: Option<(Arc<dyn ObjectStore>, Url)>

👎Deprecated:

Implement an ObjectStoreProvider instead

s3_credentials_refresh_offset: Duration

Refresh offset for AWS credentials when using the legacy AWS credentials path. For StorageOptionsAccessor, use refresh_offset_millis storage option instead.

object_store_wrapper: Option<Arc<dyn WrappingObjectStore>>

storage_options_accessor: Option<Arc<StorageOptionsAccessor>>

Unified storage options accessor with caching and automatic refresh

Provides storage options and optionally a dynamic provider for automatic credential refresh. Use StorageOptionsAccessor::with_static_options() for static options or StorageOptionsAccessor::with_initial_and_provider() for dynamic refresh.

use_constant_size_upload_parts: bool

Use constant size upload parts for multipart uploads. Only necessary for Cloudflare R2, which doesn’t support variable size parts. When this is false, max upload size is 2.5TB. When this is true, the max size is 50GB.

list_is_lexically_ordered: Option<bool>

Implementations

impl ObjectStoreParams

pub fn get_accessor(&self) -> Option<Arc<StorageOptionsAccessor>>

Get the StorageOptionsAccessor from the params

pub fn storage_options(&self) -> Option<&HashMap<String, String>>

Get storage options from the accessor, if any

Returns the initial storage options from the accessor without triggering refresh.

pub fn resolved_block_size(&self) -> Result<Option<usize>, Error>

The block size to use: the explicit block_size parameter, else the block_size storage option, else None for the store’s default.

pub fn scoped_to_base(&self, base_id: Option<u32>) -> Cow<'_, ObjectStoreParams>

Resolve these params for a single base path scope.

Storage options may carry base-scoped entries (base_<id>.<key>) that apply only to one registered base path; see StorageOptionsAccessor::scoped_to_base. Returns the params unchanged when the storage options contain no base-scoped entries.

Trait Implementations

impl Clone for ObjectStoreParams

fn clone(&self) -> ObjectStoreParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectStoreParams

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

Formats the value using the given formatter.

impl Default for ObjectStoreParams

fn default() -> ObjectStoreParams

Returns the “default value” for a type.

impl Eq for ObjectStoreParams

impl Hash for ObjectStoreParams

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ObjectStoreParams

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

Equality operator ==.

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

Inequality operator !=.