Struct deltalake::storage::file::FileStorageBackend

pub struct FileStorageBackend { /* fields omitted */ }

Multi-writer support for different platforms:

• Modern Linux kernels are well supported. However because Linux implementation leverages RENAME_NOREPLACE, older versions of the kernel might not work depending on what filesystem is being used:
  • ext4 requires >= Linux 3.15
  • btrfs, shmem, and cif requires >= Linux 3.17
  • xfs requires >= Linux 4.0
  • ext2, minix, reiserfs, jfs, vfat, and bpf requires >= Linux 4.9
• Darwin is supported but not fully tested.
• Windows is not supported because we are not using native atomic file rename system call. Patches welcome.
• Support for other platforms are not implemented at the moment.

Implementations

impl FileStorageBackend

pub fn new(root: &str) -> Self

Creates a new FileStorageBackend.

Trait Implementations

impl Debug for FileStorageBackend

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

Formats the value using the given formatter.

impl Default for FileStorageBackend

fn default() -> FileStorageBackend

Returns the “default value” for a type.

impl StorageBackend for FileStorageBackend

fn join_path(&self, path: &str, path_to_join: &str) -> String

Create a new path by appending path_to_join as a new component to path.

fn join_paths(&self, paths: &[&str]) -> String

More efficient path join for multiple path components. Use this method if you need to combine more than two path components.

fn trim_path(&self, path: &str) -> String

Returns trimed path with trailing path separator removed.

fn head_obj<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<ObjectMeta, StorageError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Fetch object metadata without reading the actual content

fn get_obj<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, StorageError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Fetch object content

fn list_objs<'a, 'async_trait>(
    &'a self,
    path: &'a str
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<ObjectMeta, StorageError>> + Send + 'a>>, StorageError>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Return a list of objects by path prefix in an async stream.

fn put_obj<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    path: &'life1 str,
    obj_bytes: &'life2 [u8]
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Create new object with obj_bytes as content.

fn rename_obj<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    src: &'life1 str,
    dst: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Moves object from src to dst.

fn delete_obj<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Deletes object by path.