API documentation
The generated API documentation is published alongside this book, under
/api/. It is produced by cargo doc from the doc
comments in the workspace, and covers every public item of every crate.
Entry points, in the order a reader is likely to need them:
| crate | contents |
|---|---|
mumble_server_runtime_shard | shared views, scopes, overlays, audio relations, deltas, the shard loop |
mumble_server_runtime_gateway | TLS control plane, handshake, connection routing, the voice plane |
mumble_server_runtime_protocol | TCP framing, control messages, UDP envelopes |
mumble_server_runtime_crypto | OCB2-AES128 and the per-connection crypto state |
A broken intra-doc link fails the build, so every link in the generated documentation resolves.
To build the same documentation locally:
$ cargo doc --workspace --no-deps --all-features --open