Struct ObjectStore

pub struct ObjectStore {
    pub inner: Arc<dyn OSObjectStore>,
    pub use_constant_size_upload_parts: bool,
    pub list_is_lexically_ordered: bool,
    /* private fields */
}

Wraps ObjectStore

Fields

inner: Arc<dyn OSObjectStore>

use_constant_size_upload_parts: bool

Whether to use constant size upload parts for multipart uploads. This is only necessary for Cloudflare R2.

list_is_lexically_ordered: bool

Whether we can assume that the list of files is lexically ordered. This is true for object stores, but not for local filesystems.

Implementations

impl ObjectStore

pub async fn from_uri(uri: &str) -> Result<(Self, Path)>

Parse from a string URI.

Returns the ObjectStore instance and the absolute path to the object.

pub async fn from_uri_and_params( registry: Arc<ObjectStoreRegistry>, uri: &str, params: &ObjectStoreParams, ) -> Result<(Self, Path)>

Parse from a string URI.

Returns the ObjectStore instance and the absolute path to the object.

pub fn from_path_with_scheme( str_path: &str, scheme: &str, ) -> Result<(Self, Path)>

pub fn from_path(str_path: &str) -> Result<(Self, Path)>

pub fn local() -> Self

Local object store.

pub fn memory() -> Self

Create a in-memory object store directly for testing.

pub fn is_local(&self) -> bool

Returns true if the object store pointed to a local file system.

pub fn is_cloud(&self) -> bool

pub fn block_size(&self) -> usize

pub fn set_block_size(&mut self, new_size: usize)

pub fn set_io_parallelism(&mut self, io_parallelism: usize)

pub fn io_parallelism(&self) -> usize

pub async fn open(&self, path: &Path) -> Result<Box<dyn Reader>>

Open a file for path.

Parameters

• path: Absolute path to the file.

pub async fn open_with_size( &self, path: &Path, known_size: usize, ) -> Result<Box<dyn Reader>>

Open a reader for a file with known size.

This size may either have been retrieved from a list operation or cached metadata. By passing in the known size, we can skip a HEAD / metadata call.

pub async fn create_local_writer(path: &Path) -> Result<ObjectWriter>

Create an ObjectWriter from local std::path::Path

pub async fn open_local(path: &Path) -> Result<Box<dyn Reader>>

Open an Reader from local std::path::Path

pub async fn create(&self, path: &Path) -> Result<ObjectWriter>

Create a new file.

pub async fn put(&self, path: &Path, content: &[u8]) -> Result<()>

A helper function to create a file and write content to it.

pub async fn delete(&self, path: &Path) -> Result<()>

pub async fn copy(&self, from: &Path, to: &Path) -> Result<()>

pub async fn read_dir(&self, dir_path: impl Into<Path>) -> Result<Vec<String>>

Read a directory (start from base directory) and returns all sub-paths in the directory.

pub async fn read_dir_all( &self, dir_path: impl Into<&Path> + Send, unmodified_since: Option<DateTime<Utc>>, ) -> Result<BoxStream<'_, Result<ObjectMeta>>>

Read all files (start from base directory) recursively

unmodified_since can be specified to only return files that have not been modified since the given time.

pub async fn remove_dir_all(&self, dir_path: impl Into<Path>) -> Result<()>

Remove a directory recursively.

pub fn remove_stream<'a>( &'a self, locations: BoxStream<'a, Result<Path>>, ) -> BoxStream<'a, Result<Path>>

pub async fn exists(&self, path: &Path) -> Result<bool>

Check a file exists.

pub async fn size(&self, path: &Path) -> Result<usize>

Get file size.

pub async fn read_one_all(&self, path: &Path) -> Result<Bytes>

Convenience function to open a reader and read all the bytes

pub async fn read_one_range( &self, path: &Path, range: Range<usize>, ) -> Result<Bytes>

Convenience function open a reader and make a single request

If you will be making multiple requests to the path it is more efficient to call Self::open and then call Reader::get_range multiple times.

impl ObjectStore

pub fn new( store: Arc<DynObjectStore>, location: Url, block_size: Option<usize>, wrapper: Option<Arc<dyn WrappingObjectStore>>, use_constant_size_upload_parts: bool, list_is_lexically_ordered: bool, io_parallelism: usize, download_retry_count: usize, ) -> Self

Trait Implementations

impl Clone for ObjectStore

fn clone(&self) -> ObjectStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectStore

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

Formats the value using the given formatter.

impl DeepSizeOf for ObjectStore

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl Display for ObjectStore

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

Formats the value using the given formatter.