Skip to content

Rust API

The Rust API reference is rustdoc, and it is published in two places on purpose (D30).

  • docs.rs is canonical for a released version of a published crate: atune, atune_core, atune_cli and atune_derive. It builds every crate feature, and each gated item carries a badge saying which feature it needs.

  • This site carries cargo doc --workspace --all-features for the exact version of the documentation you are reading, including the crates that are never published to crates.io and so will never appear on docs.rs: atune_bench, atune_dev, atune_gui, atune_plugin_example and atune_showcase.

The four publishable crates are here too, at the version you are reading: atune, atune_core, atune_cli and atune_derive.

atune_py is not in either list, and that is deliberate. Its native module is atune.atune inside a mixed package, so its library target is named atune — the same name the facade uses — and it is marked doc = false rather than have two crates write into one rustdoc directory. Its public API is Python, and it is documented in full at the Python reference.

docs.rs has nothing to show yet

No version has been published, so the four docs.rs links above have nothing behind them. The in-site copy is a different matter: the deploy job builds and attaches it, so if you are reading this on the site it is there. From a clone, cargo doc --workspace --all-features --no-deps --open.