Skip to content

Commit

Permalink
Note that bitround/zstd are backwards compatible with v2 (numcodecs)
Browse files Browse the repository at this point in the history
  • Loading branch information
LDeakin committed Jul 25, 2024
1 parent a989c05 commit db62c2a
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/status/codecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| Bytes to Bytes | [blosc] | [ZEP0001] | ✓ | ✓ | **blosc** |
| | [gzip] | [ZEP0001] | ✓ | ✓ | **gzip** |
| | [crc32c] | [ZEP0002] | ✓ | | **crc32c** |
| | [zstd] | [zarr-specs #256] | ✓ | | zstd |
| | [zstd] | [zarr-specs #256] | ✓ | ✓ | zstd |

<sup>\* Bolded feature flags are part of the default set of features.</sup>

Expand Down
2 changes: 1 addition & 1 deletion doc/status/codecs_experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Experimental codecs are recommended for evaluation only.

| Codec Type | Codec | ZEP | V3 | V2 | Feature Flag |
| -------------- | -------------------------------- | --- | ------- | ------- | ------------ |
| Array to Array | [bitround] | | &check; | | bitround |
| Array to Array | [bitround] | | &check; | &check; | bitround |
| Array to Bytes | [zfp] | | &check; | | zfp |
| | [pcodec] | | &check; | | pcodec |
| | [vlen] | | &check; | | |
Expand Down
6 changes: 6 additions & 0 deletions src/metadata/v2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,19 @@ pub mod array;

/// Zarr V2 codec metadata.
pub mod codec {
#[cfg(feature = "bitround")]
/// `bitround` codec metadata.
pub mod bitround;
/// `blosc` codec metadata.
pub mod blosc;
#[cfg(feature = "bz2")]
/// `bz2` codec metadata.
pub mod bz2;
/// `gzip` codec metadata.
pub mod gzip;
#[cfg(feature = "zstd")]
/// `zstd` codec metadata.
pub mod zstd;
}

pub use array::ArrayMetadataV2;
Expand Down
1 change: 1 addition & 0 deletions src/metadata/v2/codec/bitround.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub use crate::metadata::v3::codec::bitround::BitroundCodecConfigurationV1;
1 change: 1 addition & 0 deletions src/metadata/v2/codec/zstd.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub use crate::metadata::v3::codec::zstd::ZstdCodecConfigurationV1;

0 comments on commit db62c2a

Please sign in to comment.