Rust API¶
The Rust API reference is rustdoc, and it is published in two places on purpose (D30).
-
docs.rsis canonical for a released version of a published crate:atune,atune_core,atune_cliandatune_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-featuresfor the exact version of the documentation you are reading, including the crates that are never published to crates.io and so will never appear ondocs.rs:atune_bench,atune_dev,atune_gui,atune_oniro,atune_plugin_exampleandatune_showcase.
The published four 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 compiled
module has to be atune.so for import atune to work, 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.
Every link in this bullet goes through the generated link map, so it follows
whatever this site's Rust-reference policy is for the version you are reading
rather than hard-coding a location (ยง12). The four docs.rs links above are
spelled out on purpose โ that sentence is about docs.rs, so a link resolved
through the policy would send you to the wrong one of the two. The lang=
on this line is not decoration either: atune is the facade crate and the
root CLI command, the only name the map spells twice, so the resolver refuses
to guess which reference a page means.
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.