Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Prerequisites

The most recent zarrs requires Rust version msrv or newer.

You can check your current Rust version by running:

rustc --version

If you don’t have Rust installed, follow the official Rust installation guide.

Some optional zarrs codecs require:

These are typically available through package managers on Linux, Homebrew on Mac, etc.

Adding zarrs to Your Rust Library/Application

zarrs is a Rust library. To use it as a dependency in your Rust project, add it to your Cargo.toml file:

[dependencies]
zarrs = "18.0" # Replace with the latest version

The latest version is Latest Version. See crates.io for a full list of versions.

Crate Features

zarrs has a number of features for stores, codecs, or APIs, many of which are enabled by default. The below example demonstrates how to disable default features and explicitly enable required features:

[dependencies.zarrs]
version = "18.0"
default-features = false
features = ["filesystem", "blosc"]

See zarrs (docs.rs) - Crate Features for an up-to-date list of all available features.

Supplementary Crates

Remote store support and other capabilities are provided by supplementary crates. See the Rust Crates section and Stores chapter for an overview of the crates available.