General naming conventions
In general, Rust tends to use CamelCase for “type-level” constructs
(types and traits) and snake_case for “value-level” constructs. More
precisely, the proposed (and mostly followed) conventions are:
| Item | Convention |
|---|---|
| Crates | snake_case (but prefer single word) |
| Modules | snake_case |
| Types | CamelCase |
| Traits | CamelCase |
| Enum variants | CamelCase |
| Functions | snake_case |
| Methods | snake_case |
| General constructors | new or new_with_more_details |
| Conversion constructors | from_some_other_type |
| Local variables | snake_case |
| Static variables | SCREAMING_SNAKE_CASE |
| Type parameters | concise CamelCase, usually single uppercase letter: T |
| Lifetimes | short, lowercase: 'a |
Referring to types in method names
Function names often involve type names, the most common example being conversions
like as_slice. If the type has a purely textual name (ignoring parameters), it
is straightforward to convert between type conventions and function conventions:
| Type name | Text in methods |
|---|---|
String | string |
Vec<T> | vec |
YourType | your_type |
Types that involve notation are less clear, so this RFC proposes some standard conventions for referring to these types. There is some overlap on these rules; apply the most specific applicable rule.
| Type name | Text in methods |
|---|---|
&str | str |
&[T] | slice |
&mut [T] | mut_slice |
&[u8] | bytes |
&T | ref |
&mut T | mut |
*const T | ptr |
*mut T | mut_ptr |
