Rust API Guidelines

The official Rust API Guidelines capture the Rust library team's consensus on idiomatic, interoperable crate design. They cover naming, trait implementations, documentation, type safety, macros, and more. Use the checklist below when writing, reviewing, or publishing Rust library code.

Checklist

Naming (details)

• Casing conforms to RFC 430 ([C-CASE])
• Ad-hoc conversions follow as_, to_, into_ conventions ([C-CONV])
• Getter names follow Rust convention ([C-GETTER])
• Methods on collections that produce iterators follow iter, iter_mut, into_iter ([C-ITER])
• Iterator type names match the methods that produce them ([C-ITER-TY])
• Feature names are free of placeholder words ([C-FEATURE])
• Names use a consistent word order ([C-WORD-ORDER])