Rust API

The workspace's crates are documented with rustdoc, built into this book under api/.

  • archiveview: the Plot widget to embed in an egui app (see Embed the plot), the standalone ArchiveApp, views, config and snapshot mode
  • archiver: the Archiver Appliance retrieval client: URLs, requests and tolerant JSON decoding
  • mockarchiver: the mock appliance, for tests

The crates are not published to crates.io and their API is not yet stable.

In a local build the links work when the book is built with scripts/build-docs.sh (see Build from source), not with a plain mdbook serve.