Struct lance_io::object_store::ObjectStore

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

Wraps ObjectStore

Fields

inner: Arc<dyn OSObjectStore>

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( 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(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 block_size(&self) -> usize

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

pub fn base_path(&self) -> &Path

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 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<'_, 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.

impl ObjectStore

pub fn new( store: Arc<DynObjectStore>, location: Url, block_size: Option<usize>, wrapper: Option<Arc<dyn WrappingObjectStore>> ) -> 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 Display for ObjectStore

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

Formats the value using the given formatter.