diff options
Diffstat (limited to 'src/tools/clippy/src/docs/ref_binding_to_reference.txt')
-rw-r--r-- | src/tools/clippy/src/docs/ref_binding_to_reference.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/ref_binding_to_reference.txt b/src/tools/clippy/src/docs/ref_binding_to_reference.txt new file mode 100644 index 000000000..dc391cd98 --- /dev/null +++ b/src/tools/clippy/src/docs/ref_binding_to_reference.txt @@ -0,0 +1,21 @@ +### What it does +Checks for `ref` bindings which create a reference to a reference. + +### Why is this bad? +The address-of operator at the use site is clearer about the need for a reference. + +### Example +``` +let x = Some(""); +if let Some(ref x) = x { + // use `x` here +} +``` + +Use instead: +``` +let x = Some(""); +if let Some(x) = x { + // use `&x` here +} +```
\ No newline at end of file |