Rust 1.48.0 est disponible avec quelques modifications dans rustdoc

Pour rendre la rédaction de documentation encore plus facile

Rust 1.48.0 est disponible avec quelques modifications dans rustdoc
pour rendre la rédaction de documentation encore plus facile

Rust est un langage de programmation open source, dont le code source est disponible sur GitHub, qui permet à chacun de créer des logiciels fiables et efficaces. Environ deux mois après la publication de Rust1.47.0, l'équipe de développement du langage a annoncé ce jeudi la disponibilité générale de la version stable de Rust 1.48.0. Cette nouvelle version apporte quelques nouvelles fonctionnalités et changements dans le langage, en particulier dans l'outil rustdoc. Voici ci-dessous ce dont il s'agit dans cette nouvelle mouture du langage.

Liaison plus facile dans rustdoc

L'équipe du langage a annoncé que la vedette de cette nouvelle version est rustdoc, qui bénéficie de quelques modifications pour faciliter encore plus la rédaction de documentation. Alors, qu'est-ce que rustdoc ? En effet, la distribution standard de Rust est livrée avec un outil appelé rustdoc. Son travail consiste à générer de la documentation pour les projets Rust. Sur un plan fondamental, rustdoc prend comme argument soit une racine de caisse (crate), soit un fichier Markdown, et produit du HTML, du CSS et du JavaScript.

584517

Le fait que rustdoc permet de rédiger de la documentation dans Markdown le rend très facile à utiliser, mais présente aussi quelques inconvénients. Markdown ne sait rien de Rust, et des URL que rustdoc génère. Ainsi, lors de l'écriture d'une documentation, les programmeurs Rust doivent décrire eux-mêmes ces liens manuellement. Selon l'équipe, non seulement ce processus est fastidieux et sujet à erreur, mais il peut également être erroné à certains endroits. En gros, vous ne pouvez pas écrire ces liens à la main, et les faire tous correspondre à la réalité.

Dans cette version, vous pouvez utiliser une certaine syntaxe pour faire savoir à rustdoc que vous essayez de créer un lien vers un type, et il générera les URL pour vous.

Ajout des alias de recherche

À partir de Rust 1.48.0, vous pouvez maintenant spécifier #[doc(alias = "")] sur les éléments pour ajouter des alias de recherche lors de la recherche dans l'interface utilisateur de rustdoc. Il s'agit d'un changement moins important, mais toujours utile. Cela ressemble à ceci :

#[doc(alias = "bar")]
struct Foo;

Avec cette annotation, si vous recherchez "bar" dans la recherche de rustdoc, "Foo" apparaîtra dans les résultats, même si le texte de votre recherche ne contient pas "Foo". D'après l'équipe, un cas d'utilisation intéressant pour les alias est celui des caisses de wrapper FFI, où chaque fonction Rust pourrait avoir un alias correspondant à la fonction C qu'elle enveloppe. Les utilisateurs existants de la bibliothèque C sous-jacente pourraient alors facilement rechercher les bonnes fonctions Rust.

La bibliothèque de Rust

Selon l'équipe, le changement le plus significatif de l'API est en quelque sorte "une bouchée de pain" : [T ; N] : TryFrom> est maintenant stable. Qu'est-ce que cela signifie ? Eh bien, vous pouvez utiliser cela pour essayer de transformer un vecteur en un tableau d'une longueur donnée

« Dans la dernière version de Rust, nous avons parlé de la possibilité pour la bibliothèque standard d'utiliser des const génériques. C'est un bon exemple des types d'API que nous pouvons ajouter avec ce genre de fonctionnalités. Attendez-vous à en savoir plus sur la stabilisation des const generics bientôt », a déclaré l'équipe de développement du langage.

D'autres changements dans la bibliothèque

• io::Write est maintenant implémenté pour &ChildStdin, &Sink, &Stdout, et &Stderr ;
  
• tous les tableaux, quelle que soit leur longueur, implémentent maintenant TryFrom> ;
  
• la macro matches! supporte maintenant l'utilisation d'une virgule de fin de ligne ;
  
• Vec implémente maintenant PartialEq<> où A : PartialEq ;
  
• les méthodes RefCell::{replace, replace_with, clone} utilisent maintenant toutes #.