Struct FileStorageBackend

pub struct FileStorageBackend { /* private fields */ }

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. Patches welcome.
• Support for other platforms are not implemented at the moment.

Implementations

impl FileStorageBackend

pub fn try_new(path: impl AsRef<Path>) -> ObjectStoreResult<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 Display for FileStorageBackend

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

Formats the value using the given formatter.

impl ObjectStore for FileStorageBackend

fn put<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, bytes: PutPayload, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<PutResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save the provided bytes to the specified location

fn put_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, bytes: PutPayload, options: PutOptions, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<PutResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save the provided payload to location with the given options

fn get<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<GetResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return the bytes that are stored at the specified location.

fn get_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, options: GetOptions, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<GetResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a get request with options

fn get_range<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, range: Range<usize>, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<Bytes>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return the bytes that are stored at the specified location in the given byte range.

fn head<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<ObjectMeta>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return the metadata for the specified location

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete the object at the specified location.

fn list( &self, prefix: Option<&ObjectStorePath>, ) -> BoxStream<'_, ObjectStoreResult<ObjectMeta>>

List all the objects with the given prefix.

fn list_with_offset( &self, prefix: Option<&ObjectStorePath>, offset: &ObjectStorePath, ) -> BoxStream<'_, ObjectStoreResult<ObjectMeta>>

List all the objects with the given prefix and a location greater than offset

fn list_with_delimiter<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 ObjectStorePath>, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<ListResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List objects with the given prefix and an implementation specific delimiter. Returns common prefixes (directories) in addition to object metadata.

fn copy<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 ObjectStorePath, to: &'life2 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Copy an object from one path to another in the same object store.

fn copy_if_not_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 ObjectStorePath, to: &'life2 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Copy an object from one path to another, only if destination is empty.

fn rename_if_not_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 ObjectStorePath, to: &'life2 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move an object from one path to another in the same object store.

fn put_multipart<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<Box<dyn MultipartUpload>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a multipart upload

fn put_multipart_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 ObjectStorePath, options: PutMultipartOpts, ) -> Pin<Box<dyn Future<Output = ObjectStoreResult<Box<dyn MultipartUpload>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a multipart upload with options

fn get_ranges<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, location: &'life1 Path, ranges: &'life2 [Range<usize>], ) -> Pin<Box<dyn Future<Output = Result<Vec<Bytes>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Return the bytes that are stored at the specified location in the given byte ranges

fn delete_stream<'a>( &'a self, locations: Pin<Box<dyn Stream<Item = Result<Path, Error>> + Send + 'a>>, ) -> Pin<Box<dyn Stream<Item = Result<Path, Error>> + Send + 'a>>

Delete all the objects at the specified locations

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Move an object from one path to another in the same object store.