Outils pour travailler avec Rust

Au delà de ceux que nous avons déjà vus, nous disposons d’outils pour travailler avec Rust.

La documentation embarquée

Nous pouvons générer une documentation de notre projet avec la commande

cargo doc

Cette documentation générée localement dans target/doc/ inclut les dépendances (crates) que nous avons injectées dans notre projet (via le fichier cargo.toml).

Le fonctionnement hors ligne et l’outil de recherche sont bien pratiques pour gagner du temps lors de nos recherches liées aux librairies que nous utilisons dans le projet.

Pour générer la documentation et l’ouvrir directement ¹, utiliser

cargo doc --open

La commande rapide cargo check et l’EDI

Beaucoup d’environnements de développement intégré font du très bon travail pour nous aider avec Rust via cargo check ou un dérivé et au travers de serveurs de langage (LSP) et de rust-analyzer.

Il faut bien sûr installer et paramétrer les extensions correspondant à notre environnement.

Les documentations officielles et connexes

La documentation officielle du langage est très fournie : https://doc.rust-lang.org/stable/.

La plupart des documentations accessibles par le Web sont accessibles localement sur notre machine grâce à

rustup doc

qui ouvre le fichier html correspondant à https://doc.rust-lang.org/stable/ ¹.

Le fameux Book (The Rust Programming Language), par exemple, est servi localement ce qui permet de travailler même hors connexion à l’Internet.

1. La commande utilise l’application associée à l’ouverture des fichiers html dans notre système. Il peut s’agir du navigateur web comme d’un éditeur, auquel cas nous avons intérêt
   – soit à changer l’application d’ouverture par défaut dans nos paramètres système,
   – soit à ouvrir le fichier concerné manuellement avec l’application de notre choix via un gestionnaire de fichiers graphique ou un Terminal. ↩ ↩2