Zugriff auf die Rust Dokumentation

Die Schleusen sind geöffnet, es regnet ohne Unterlass, der Sommer scheint entgültig vorbei. Herbst und Winter sind Lesezeit. In diesem Sinne zeige ich hier die Möglichkeiten auf die lokal verfügbare Rust Entwickler Dokumentation zuzugreifen.

Dokumentation über rustup

Mit Hilfe von rustup kann die Dokumentation lokal installiert werden.
Dazu zunächst prüfen ob diese installiert ist: rustup component list | grep "^rust-docs-.*default"
Falls keine Ausgabe erfolgt, kann das Bundle per rustup component add `rustup component list | grep "^rust-docs" | sed 's/ .*$//'` installiert werden.

Jetzt stehen die Befehle rustup doc [--book || --reference || --std] zur Verfügung um im Browser das Rust Buch, die Reference oder die StandardLib zu öffnen.

Dokumentation der Cargo Crates

Da Rust großteils in Code Kommentaren dokumentiert wird, steht auch die Dokumentation zu verwendet Cargo Crates zur Verfügung.

Der Befehl cargo doc baut die Dokumentation aus allen in der Cargo.toml angegebenen Crates.
Einschränkung erfolgt über cargo doc -p <CrateName>.
Über das Argument cargo doc -p <CrateName> --open wird die Dokumentation im Browser angezeigt.