FFI bindings for the zarrs crate, a Rust library for the Zarr storage format for multidimensional arrays and metadata.
Currently zarrs_ffi
only supports a small subset of the zarrs API.
A changelog can be found here. Example usage can be found in the examples.
- Install the Rust compiler (and cargo).
- Put Findzarrs.cmake in your
CMAKE_MODULE_PATH
find_package(zarrs 0.8 REQUIRED COMPONENTS zarrs/bz2)
- zarrs is retrieved from
GitHub
using FetchContent and built using corrosion - Components are optional zarrs codecs
- zarrs is retrieved from
- the
zarrs_ffi
library is available as thezarrs::zarrs
orzarrs::zarrs-static
target
A complete CMake
example can be found in examples/cmake_project.
Building generates a header, and a platform-dependent static and dynamic library.
cargo build --release --features cbindgen # -> zarrs.h and target/release/[lib]zarrs_ffi{.a,.so,.dll,.dylib}
zarrs.h
is only re-generated if the cbindgen
feature is enabled.
Encoding and decoding performance may be improved with avx2
/sse2
enabled (if supported).
Compile with either of:
RUSTFLAGS="-C target-cpu=native"
RUSTFLAGS="-C target-feature=+avx2,+sse2"
Non-default zarrs
codecs (see zarrs
crate features) can be enabled with the all_codecs
feature.
Alternatively, individual codecs can be enabled by passing them as feature flags.
For example:
cargo build --release --features cbindgen --features zarrs/zstd,zarrs/bitround,zarrs/zfp,zarrs/bz2,zarrs/pcodec,zarrs/gdeflate
zarrs_ffi
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.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.