Crate zarrs_storage

The storage API for the zarrs crate.

A Zarr store is a system that can be used to store and retrieve data from a Zarr hierarchy. For example: a filesystem, HTTP server, FTP server, Amazon S3 bucket, ZIP file, etc. The Zarr V3 storage API is detailed here: https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html#storage.

This crate includes an in-memory store implementation. See zarrs storage support for a list of stores that implement the zarrs_storage API.

Licence

zarrs_storage is licensed under either of

• the Apache License, Version 2.0 LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0 or
• the MIT license LICENSE-MIT or http://opensource.org/licenses/MIT, at your option.

Modules

• byte_range
  Byte ranges.
• storage_adapter
  Storage adapters.
• store
  Zarr stores.
• store_testtests
  Store test utilities (for external store development).

Structs

• StorageHandle
  A storage handle.
• StorageValueIO
  Provides a Read interface to a storage value.
• StoreKey
  A Zarr abstract store key.
• StoreKeyError
  An invalid store key.
• StoreKeyOffsetValue
  A StoreKey, ByteOffset, and value (bytes).
• StoreKeyRange
  A StoreKey and ByteRange.
• StoreKeysPrefixes
  StoreKeys and StorePrefixes.
• StorePrefix
  A Zarr abstract store prefix.
• StorePrefixError
  An invalid store prefix.

Enums

• StorageError
  A storage error.

Traits

• AsyncListableStorageTraitsasync
  Async listable storage traits.
• AsyncReadableListableStorageTraitsasync
  A supertrait of AsyncReadableStorageTraits and AsyncListableStorageTraits.
• AsyncReadableStorageTraitsasync
  Async readable storage traits.
• AsyncReadableWritableListableStorageTraitsasync
  A supertrait of AsyncReadableWritableStorageTraits and AsyncListableStorageTraits.
• AsyncReadableWritableStorageTraitsasync
  A supertrait of AsyncReadableStorageTraits and AsyncWritableStorageTraits.
• AsyncWritableStorageTraitsasync
  Async writable storage traits.
• ListableStorageTraits
  Listable storage traits.
• ReadableListableStorageTraits
  A supertrait of ReadableStorageTraits and ListableStorageTraits.
• ReadableStorageTraits
  Readable storage traits.
• ReadableWritableListableStorageTraits
  A supertrait of ReadableWritableStorageTraits and ListableStorageTraits.
• ReadableWritableStorageTraits
  A supertrait of ReadableStorageTraits and WritableStorageTraits.
• WritableStorageTraits
  Writable storage traits.

Functions

• async_discover_childrenasync
  Asynchronously discover the children of a store prefix.
• async_store_set_partial_valuesasync
  Set partial values for an asynchronous store.
• discover_children
  Discover the children of a store prefix.
• store_set_partial_values
  Set partial values for a store.

Type Aliases

• AsyncBytesasync
  The type for bytes used in asynchronous store set and get methods.
• AsyncListableStorageasync
  Arc wrapped asynchronous listable storage.
• AsyncReadableListableStorageasync
  Arc wrapped asynchronous readable and listable storage.
• AsyncReadableStorageasync
  Arc wrapped asynchronous readable storage.
• AsyncReadableWritableListableStorageasync
  Arc wrapped asynchronous readable, writable and listable storage.
• AsyncWritableStorageasync
  Arc wrapped asynchronous writable storage.
• Bytes
  The type for bytes used in synchronous store set and get methods.
• ListableStorage
  Arc wrapped listable storage.
• MaybeAsyncBytesasync
  An alias for bytes which may or may not be available.
• MaybeBytes
  An alias for bytes which may or may not be available.
• ReadableListableStorage
  Arc wrapped readable and listable storage.
• ReadableStorage
  Arc wrapped readable storage.
• ReadableWritableListableStorage
  Arc wrapped readable, writable, and listable storage.
• ReadableWritableStorage
  Arc wrapped readable and writable storage.
• StoreKeys
  A list of StoreKey.
• StorePrefixes
  A list of StorePrefix.
• WritableStorage
  Arc wrapped writable storage.