quantumclaw/clawhdf5
3
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs: plugin filters and the filter registry

Browse Source 
CHANGELOG (Unreleased): LZF, bitshuffle, bzip2 and Blosc read and write
in pure Rust, their features, the ChunkOptions::plugin field (breaking for
struct-literal construction), the filter registry, the named
UnsupportedFilter message, and Blosc2/ZFP still unimplemented.
README: the clawhdf5-format feature table gains lzf (default),
bitshuffle, bzip2, blosc and plugin-filters, with how to write them and
what is not implemented; no speed claims. docs/known-issues.md: the audit's
filter gap is marked fixed 2026-09-26 for LZF/bitshuffle/bzip2/Blosc,
Blosc2 and ZFP still open. CLAUDE.md: the clawhdf5-filters row no longer
says "No Blosc". clawhdf5-format's crate docs list the new features.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
This commit is contained in:
osobh
2026-09-26 00:14:47 -05:00
co-authored by Claude Opus 5.5
parent 056092b082
commit e01160299a
5 changed files with 64 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/clawhdf5-format/src/lib.rs
+8
View File
@@ -43,6 +43,14 @@
//! | `checksum` | yes | Jenkins lookup3 checksum validation |
//! | `deflate` | yes | Deflate (gzip) compression via `flate2` |
//! | `provenance` | yes | SHINES provenance — SHA-256 hashing & verification |
//! | `lzf` | yes | LZF filter (32000), h5py's `compression="lzf"` |
//! | `bitshuffle` | no | Bitshuffle filter (32008), none/LZ4/Zstandard |
//! | `bzip2` | no | bzip2 filter (307) |
//! | `blosc` | no | Blosc 1 filter (32001) |
//! | `plugin-filters` | no | The four above |
//!
//! Filters are looked up by ID in [`filter_registry`], which also takes
//! codecs registered at run time for other IDs.
#![cfg_attr(not(feature = "std"), no_std)]