Struct zarrs::storage::StorageHandle

pub struct StorageHandle<TStorage: ?Sized>(/* private fields */);

A storage handle.

This is a handle to borrowed storage which can be owned and cloned, even if the storage it references is unsized.

Implementations

impl<TStorage: ?Sized> StorageHandle<TStorage>

pub const fn new(storage: Arc<TStorage>) -> Self

Create a new storage handle.

Trait Implementations

impl<TStorage: ?Sized + AsyncListableStorageTraits> AsyncListableStorageTraits for StorageHandle<TStorage>

Available on crate feature async only.

fn list<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<StoreKeys, StorageError>> + Send + 'async_trait>>

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

Retrieve all StoreKeys in the store.

fn list_prefix<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 StorePrefix ) -> Pin<Box<dyn Future<Output = Result<StoreKeys, StorageError>> + Send + 'async_trait>>

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

Retrieve all StoreKeys with a given StorePrefix.

fn list_dir<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 StorePrefix ) -> Pin<Box<dyn Future<Output = Result<StoreKeysPrefixes, StorageError>> + Send + 'async_trait>>

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

Retrieve all StoreKeys and StorePrefix which are direct children of StorePrefix.

impl<TStorage: ?Sized + AsyncReadableStorageTraits> AsyncReadableStorageTraits for StorageHandle<TStorage>

Available on crate feature async only.

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StoreKey ) -> Pin<Box<dyn Future<Output = Result<MaybeBytes, StorageError>> + Send + 'async_trait>>

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

Retrieve the value (bytes) associated with a given StoreKey.

fn get_partial_values_key<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 StoreKey, byte_ranges: &'life2 [ByteRange] ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<Vec<u8>>>, StorageError>> + Send + 'async_trait>>

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

Retrieve partial bytes from a list of byte ranges for a store key.

fn get_partial_values<'life0, 'life1, 'async_trait>( &'life0 self, key_ranges: &'life1 [StoreKeyRange] ) -> Pin<Box<dyn Future<Output = Result<Vec<MaybeBytes>, StorageError>> + Send + 'async_trait>>

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

Retrieve partial bytes from a list of StoreKeyRange.

fn size_prefix<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 StorePrefix ) -> Pin<Box<dyn Future<Output = Result<u64, StorageError>> + Send + 'async_trait>>

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

Return the size in bytes of all keys under prefix.

fn size_key<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StoreKey ) -> Pin<Box<dyn Future<Output = Result<Option<u64>, StorageError>> + Send + 'async_trait>>

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

Return the size in bytes of the value at key.

fn size<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<u64, StorageError>> + Send + 'async_trait>>

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

Return the size in bytes of the readable storage.

fn get_partial_values_batched_by_key<'life0, 'life1, 'async_trait>( &'life0 self, key_ranges: &'life1 [StoreKeyRange] ) -> Pin<Box<dyn Future<Output = Result<Vec<MaybeBytes>, StorageError>> + Send + 'async_trait>>

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

A utility method with the same input and output as get_partial_values that internally calls get_partial_values_key with byte ranges grouped by key.

impl<TStorage: ?Sized + AsyncWritableStorageTraits> AsyncWritableStorageTraits for StorageHandle<TStorage>

Available on crate feature async only.

fn set<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StoreKey, value: Bytes ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

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

Store bytes at a StoreKey.

fn set_partial_values<'life0, 'life1, 'async_trait>( &'life0 self, key_start_values: &'life1 [StoreKeyStartValue<'_>] ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

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

Store bytes according to a list of StoreKeyStartValue.

fn erase<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StoreKey ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

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

Erase a StoreKey.

fn erase_values<'life0, 'life1, 'async_trait>( &'life0 self, keys: &'life1 [StoreKey] ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

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

Erase a list of StoreKey.

fn erase_prefix<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 StorePrefix ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

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

Erase all StoreKey under StorePrefix.

impl<TStorage: Clone + ?Sized> Clone for StorageHandle<TStorage>

fn clone(&self) -> StorageHandle<TStorage>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TStorage: ?Sized + ListableStorageTraits> ListableStorageTraits for StorageHandle<TStorage>

fn list(&self) -> Result<StoreKeys, StorageError>

Retrieve all StoreKeys in the store.

fn list_prefix(&self, prefix: &StorePrefix) -> Result<StoreKeys, StorageError>

Retrieve all StoreKeys with a given StorePrefix.

fn list_dir( &self, prefix: &StorePrefix ) -> Result<StoreKeysPrefixes, StorageError>

Retrieve all StoreKeys and StorePrefix which are direct children of StorePrefix.

impl<TStorage: ?Sized + ReadableStorageTraits> ReadableStorageTraits for StorageHandle<TStorage>

fn get(&self, key: &StoreKey) -> Result<MaybeBytes, StorageError>

Retrieve the value (bytes) associated with a given StoreKey.

fn get_partial_values_key( &self, key: &StoreKey, byte_ranges: &[ByteRange] ) -> Result<Option<Vec<Vec<u8>>>, StorageError>

Retrieve partial bytes from a list of byte ranges for a store key.

fn get_partial_values( &self, key_ranges: &[StoreKeyRange] ) -> Result<Vec<MaybeBytes>, StorageError>

Retrieve partial bytes from a list of StoreKeyRange.

fn size(&self) -> Result<u64, StorageError>

Return the total size in bytes of the storage.

fn size_prefix(&self, prefix: &StorePrefix) -> Result<u64, StorageError>

Return the size in bytes of all keys under prefix.

fn size_key(&self, key: &StoreKey) -> Result<Option<u64>, StorageError>

Return the size in bytes of the value at key.

fn get_partial_values_batched_by_key( &self, key_ranges: &[StoreKeyRange] ) -> Result<Vec<MaybeBytes>, StorageError>

A utility method with the same input and output as get_partial_values that internally calls get_partial_values_key with byte ranges grouped by key.

impl<TStorage: ?Sized + WritableStorageTraits> WritableStorageTraits for StorageHandle<TStorage>

fn set(&self, key: &StoreKey, value: &[u8]) -> Result<(), StorageError>

Store bytes at a StoreKey.

fn set_partial_values( &self, key_start_values: &[StoreKeyStartValue<'_>] ) -> Result<(), StorageError>

Store bytes according to a list of StoreKeyStartValue.

fn erase(&self, key: &StoreKey) -> Result<(), StorageError>

Erase a StoreKey.

fn erase_values(&self, keys: &[StoreKey]) -> Result<(), StorageError>

Erase a list of StoreKey.

fn erase_prefix(&self, prefix: &StorePrefix) -> Result<(), StorageError>

Erase all StoreKey under StorePrefix.

impl<TStorage: ?Sized + AsyncReadableWritableStorageTraits> AsyncReadableWritableStorageTraits for StorageHandle<TStorage>

Available on crate feature async only.

impl<TStorage: ?Sized + ReadableWritableStorageTraits> ReadableWritableStorageTraits for StorageHandle<TStorage>