Rust crate

The tetration crate provides read/write helpers for .tet files, a query engine, format conversion, and an optional C ABI for FFI bindings.

API documentation

Full type-level API reference: docs.rs/tetration

This site covers usage patterns and cookbooks. Prefer docs.rs for struct fields, trait bounds, and module listings.

What the crate provides

Module	Role
catalog	File layout, TetFile, TetWriterSession, catalog summary
query	JSON/TOML parse, plan, execute, materialize
convert	HDF5 / NetCDF / Zarr v3 import
export	Zarr v3 export
verify / repair	File health
ffi	C ABI behind tetration-ffi feature

Current version

[dependencies]
tetration = "0.1.10"

Requires Rust 1.95+.

Sections

• Quick start — minimal read example
• Open & inspect — catalog access, dataset iteration
• Chunk reads — mmap and partial read patterns
• Write path — creating .tet files programmatically
• C ABI / FFI — overview for binding authors

Embedder flow

1. Write — TetWriterSession::create → push_dataset with TetDatasetWrite::f32_row_major, f64_row_major, or row_major(dtype, …) → commit(). Streaming grids use TetDatasetStreamSpec (same builders) and commit_with_fill.
2. Read / aggregate — TetFile::open → execute_query_json → QueryResponse
3. Dense tensors — materialize_query_selection or materialize_query_transform_ram → DenseMaterializeOutcome

Examples in the repo

cargo run --example create_and_query
cargo run --example session_write
cargo run --example inspect_catalog