created_at2024-03-10 00:17:33.292795
updated_at2024-04-02 22:25:47.474809
descriptionFFI bindings for the zarrs crate
Lachlan Deakin



# zarrs_ffi [![Latest Version](]( [![zarrs documentation](]( ![msrv]( [![build](]( FFI bindings for the [zarrs] crate, a rust library for the [Zarr V3]( storage format for multidimensional arrays and metadata. Developed at the [Department of Materials Physics](, Australian National University, Canberra, Australia. **`zarrs` and `zarrs_ffi` are experimental and in limited production use. Use at your own risk!** Example usage can be found in the [examples]( Currently `zarrs_ffi` only supports a small subset of the [zarrs] API. ## CMake Quickstart 1. Install the rust compiler (and cargo). 2. Put [Findzarrs.cmake]( in your `CMAKE_MODULE_PATH` 3. `find_package(zarrs 0.6.0 REQUIRED COMPONENTS zarrs/bz2)` - `zarrs` is retrieved from `GitHub` using [FetchContent]( and built using [corrosion]( - Components are optional zarrs codecs 4. the `zarrs` FFI library is available as the `zarrs::zarrs` target A complete `CMake` example can be found in [examples/cmake_project]( ## Manual Build #### Basic Build Building generates a header, and a platform-dependent static and dynamic library. ```bash 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. #### Enabling SIMD intrinsics 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"` #### Enabling non-default `zarrs` codecs Non-default `zarrs` codecs (see [`zarrs` crate features]( can be enabled by passing them as feature flags. For example: ```bash cargo build --release --features cbindgen --features zarrs/bitround,zarrs/zfp,zarrs/bz2,zarrs/pcodec ``` ## Licence `zarrs_ffi` is licensed under either of - the Apache License, Version 2.0 [LICENSE-APACHE](./LICENCE-APACHE) or or - the MIT license [LICENSE-MIT](./LICENCE-MIT) or , 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. [zarrs]:
Commit count: 44

cargo fmt