diff options
Diffstat (limited to '')
-rw-r--r-- | src/tools/clippy/src/docs/box_collection.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/box_collection.txt b/src/tools/clippy/src/docs/box_collection.txt new file mode 100644 index 000000000..053f24c46 --- /dev/null +++ b/src/tools/clippy/src/docs/box_collection.txt @@ -0,0 +1,23 @@ +### What it does +Checks for use of `Box<T>` where T is a collection such as Vec anywhere in the code. +Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information. + +### Why is this bad? +Collections already keeps their contents in a separate area on +the heap. So if you `Box` them, you just add another level of indirection +without any benefit whatsoever. + +### Example +``` +struct X { + values: Box<Vec<Foo>>, +} +``` + +Better: + +``` +struct X { + values: Vec<Foo>, +} +```
\ No newline at end of file |