API reference
The generated rustdoc is part of this site:
Build it locally with:
cargo doc --locked --workspace --no-deps --open
scripts/build-docs.sh runs that command and copies target/doc to docs/book/api. The pages below are a map of the public items. The rustdoc pages are the full signatures, the crate-level examples and the type documentation.
| Page | Crate |
|---|---|
| rfc9162 | hashes, proofs, Head |
| rfc9162-tiles | stores, reader, writer, checkpoints |
| rfc9162-log | Store, Sidecar, runs |
| rfc9162-sidecar | the command-line binary |
The changelog is the release history. Contributing is how a change lands.
Copyright (c) rfc9162 developers