HeadlinesBriefing HeadlinesBriefing.com

Guia de estilo de Rust do Google: regras para um código

Hacker News •
×

O Google publicou seu Guia de estilo de Rust, um documento que regula a forma como Rust é escrito nas bases de código do Google, incluindo google3, Android, Chrome OS, Fuchsia e Chrome. O guia abrange mais do que formatação, estendendo-se ao design de APIs e de implementação. Seu objetivo declarado é a consistência no uso de Rust dentro e entre essas bases de código, ao mesmo tempo em que estabelece um padrão de qualidade.

O escopo de autoridade do guia varia de acordo com o projeto. Android, Chromium e outras bases de código foram consultados durante seu desenvolvimento e pretendem começar a aplicá-lo, embora cada uma possa definir o próprio rigor na aplicação do guia. Informações sobre essa adoção devem ser divulgadas à medida que essas bases de código a implementarem.

Os objetivos do guia espelham em grande parte os do guia de estilo de C++ do Google. A maioria de suas regras remonta a um ou mais desses objetivos, com legibilidade e manutenibilidade tendo prioridade sobre a facilidade de escrita. Os autores observam que o código deve permanecer em uso por longos períodos, por isso um pequeno esforço extra ao escrevê-lo é considerado valioso.

O documento está organizado em seções que abrangem organização do código, formatação, propriedade e empréstimo, entradas e saídas de funções, tipos, traits, genéricos, concorrência, nomenclatura, documentação, código unsafe e questões de implementação. As orientações incluem preferir crates pequenos, evitar imports glob, evitar Rc e Arc e preferir enums a bools em APIs.

Fonte: Hacker News · Resumido por HeadlinesBriefing