diff options
Diffstat (limited to 'docs/dev/style.md')
-rw-r--r-- | docs/dev/style.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md index 44f0956c2..ae69cf1a7 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -231,6 +231,41 @@ if words.len() != 2 { | |||
231 | } | 231 | } |
232 | ``` | 232 | ``` |
233 | 233 | ||
234 | # Avoid Monomorphization | ||
235 | |||
236 | Rust uses monomorphization to compile generic code, meaning that for each instantiation of a generic functions with concrete types, the function is compiled afresh, *per crate*. | ||
237 | This allows for exceptionally good performance, but leads to increased compile times. | ||
238 | Runtime performance obeys 80%/20% rule -- only a small fraction of code is hot. | ||
239 | Compile time **does not** obey this rule -- all code has to be compiled. | ||
240 | For this reason, avoid making a lot of code type parametric, *especially* on the boundaries between crates. | ||
241 | |||
242 | ```rust | ||
243 | // Good | ||
244 | fn frbonicate(f: impl FnMut()) { | ||
245 | frobnicate_impl(&mut f) | ||
246 | } | ||
247 | fn frobnicate_impl(f: &mut dyn FnMut()) { | ||
248 | // lots of code | ||
249 | } | ||
250 | |||
251 | // Not as good | ||
252 | fn frbonicate(f: impl FnMut()) { | ||
253 | // lots of code | ||
254 | } | ||
255 | ``` | ||
256 | |||
257 | Avoid `AsRef` polymorphism, it pays back only for widely used libraries: | ||
258 | |||
259 | ```rust | ||
260 | // Good | ||
261 | fn frbonicate(f: &Path) { | ||
262 | } | ||
263 | |||
264 | // Not as good | ||
265 | fn frbonicate(f: impl AsRef<Path>) { | ||
266 | } | ||
267 | ``` | ||
268 | |||
234 | # Documentation | 269 | # Documentation |
235 | 270 | ||
236 | For `.md` and `.adoc` files, prefer a sentence-per-line format, don't wrap lines. | 271 | For `.md` and `.adoc` files, prefer a sentence-per-line format, don't wrap lines. |