diff --git a/zarrs/doc/status/stores.md b/zarrs/doc/status/stores.md index e2473d30..c421c533 100644 --- a/zarrs/doc/status/stores.md +++ b/zarrs/doc/status/stores.md @@ -5,17 +5,18 @@ | [OpendalStore] | | ✓* | ✓* | ✓* | ✓ | | [zarrs_opendal] | | [AsyncOpendalStore] | | ✓* | ✓* | ✓* | | ✓ | [zarrs_opendal] | | [AsyncObjectStore] | | ✓* | ✓* | ✓* | | ✓ | [zarrs_object_store] | +| [AsyncIcechunkStore] | | ✓* | ✓* | ✓* | | ✓ | [zarrs_icechunk] | | [HTTPStore] | | ✓ | | | ✓ | | [zarrs_http] | | [AsyncToSyncStorageAdapter] | | ✓ | ✓ | ✓ | ✓ | ✓ | [zarrs_storage] | | [UsageLogStorageAdapter] | | ✓ | ✓ | ✓ | ✓ | ✓ | [zarrs_storage] | | [PerformanceMetricsStorageAdapter] | | ✓ | ✓ | ✓ | ✓ | ✓ | [zarrs_storage] | | [ZipStorageAdapter] | | ✓ | | ✓ | ✓ | | [zarrs_zip] | -† Re-exported in the `zarrs::storage` module +† Re-exported in the `zarrs::storage` module.
-‡ Re-exported as the `zarrs::filesystem` module +‡ Re-exported as the `zarrs::filesystem` module.
-\* Support depends on the [`opendal`](https://docs.rs/opendal/latest/opendal/) [`BlockingOperator`](https://docs.rs/opendal/latest/opendal/struct.BlockingOperator.html)/[`Operator`](https://docs.rs/opendal/latest/opendal/struct.Operator.html) or [`object_store`](https://docs.rs/object_store/latest/object_store/) [store](https://docs.rs/object_store/latest/object_store/index.html#modules). +\* Support depends on the underlying store. [0001]: https://zarr.dev/zeps/accepted/ZEP0001.html @@ -23,6 +24,7 @@ [zarrs_filesystem]: https://docs.rs/zarrs_filesystem/latest/zarrs_filesystem/ [zarrs_object_store]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/ [zarrs_opendal]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/ +[zarrs_icechunk]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/ [zarrs_http]: https://docs.rs/zarrs_http/latest/zarrs_http/ [zarrs_zip]: https://docs.rs/zarrs_zip/latest/zarrs_zip/ @@ -31,6 +33,7 @@ [OpendalStore]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/struct.OpendalStore.html [AsyncOpendalStore]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/struct.AsyncOpendalStore.html [AsyncObjectStore]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/struct.AsyncObjectStore.html +[AsyncIcechunkStore]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/struct.AsyncIcechunkStore.html [HTTPStore]: https://docs.rs/zarrs_http/latest/zarrs_http/struct.HTTPStore.html [AsyncToSyncStorageAdapter]: crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter diff --git a/zarrs/src/lib.rs b/zarrs/src/lib.rs index 02e8094c..a2976063 100644 --- a/zarrs/src/lib.rs +++ b/zarrs/src/lib.rs @@ -66,11 +66,21 @@ //! #![doc = include_str!("../doc/status/stores.md")] //! -//! A huge range of storage backends are supported via the [`opendal`](https://docs.rs/opendal/latest/opendal/) and [`object_store`](https://docs.rs/opendal/latest/object_store/) crates. -//! The documentation for the [zarrs_opendal] and [zarrs_object_store] crates includes version compatibility matrices with `zarrs` and the associated storage backends. +//! A huge range of storage backends are supported via the [`opendal`] and [`object_store`] crates. +//! The documentation for the [`zarrs_opendal`] and [`zarrs_object_store`] crates includes version compatibility matrices with `zarrs` and the associated storage backends. //! These backends provide more feature complete HTTP stores than [zarrs_http]. //! -//! Asynchronous stores can be used in a synchronous context with the [`AsyncToSyncStorageAdapter`](crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter). +//! [`zarrs_icechunk`] implements the [Icechunk](https://icechunk.io/overview/) transactional storage engine, a storage specification for Zarr. +//! It supports [`object_store`] stores. +//! +//! [`opendal`]: https://docs.rs/opendal/latest/opendal/ +//! [`object_store`]: https://docs.rs/object_store/latest/object_store/ +//! [`object_store`]: https://docs.rs/object_store/latest/object_store/ +//! [`zarrs_icechunk`]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/ +//! [`zarrs_object_store`]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/ +//! [`zarrs_opendal`]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/ +//! +//! The [`AsyncToSyncStorageAdapter`](crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter) enables some async stores to be used in a sync context. //! //! ## Examples #![cfg_attr(feature = "ndarray", doc = "```rust")]