Wie greife ich über die Befehlszeile unter Linux auf die API-Dokumentation zu?

Question

Gibt es einen Befehl, um von der Linux-Befehlszeile aus auf rost-lang-api-Dokumentation zuzugreifen?

Ich bin nach etwas ähnliches zu diesem Beispiel für golang Dokumentation:

godoc strings Contains

, die den Ausgang gibt:

Paketdokumentation

Paket Strings Import "Strings"

FUN CINTIONS

func Enthält (s, Teilstring) bool Enthält returns true, wenn substr in s steht.

Ich weiß, es gibt einen rustdoc Befehl, aber es erzeugt nur Dokumentation, es zeigt es nicht an.

Answer 1

Die einzige Lösung wäre bisher, Befehlszeilenbrowser wie LYNX zu verwenden und zu http://doc.rust-lang.org/std/index.html zu gehen.

Oder wie Intermernet notierte, könnten Sie HTML-Dokumente in die Grep-Funktion pipen. Wenn ich mich nicht irre, sollten die Nightlies mit den entsprechenden Dokumenten kommen, wenn Sie API-Dokumente benötigen.

Answer 2

Wir haben noch kein Tool wie dieses, aber möchten eins. https://github.com/rust-lang/rfcs/issues/650 verfolgt dieses Problem.

(früher als https://github.com/rust-lang/rust/issues/6160 nachverfolgt)

Answer 3

I eine kleine Shell-Funktion erstellt im Terminal innerhalb eines Projektes die Dokumentation zu erzeugen und zu öffnen, indem pandoc und lynx:

cli-rustdoc() { 
    cargo doc -p "$1"; pandoc "target/doc/$1/index.html" | lynx -stdin 
} 

Anwendungsbeispiel: $ cli-rustdoc rand

Nicht perfekt, aber es macht den größten Teil.