about summary refs log tree commit diff
path: root/src/docs/needless_question_mark.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/needless_question_mark.txt')
-rw-r--r--src/docs/needless_question_mark.txt43
1 files changed, 43 insertions, 0 deletions
diff --git a/src/docs/needless_question_mark.txt b/src/docs/needless_question_mark.txt
new file mode 100644
index 00000000000..540739fd45f
--- /dev/null
+++ b/src/docs/needless_question_mark.txt
@@ -0,0 +1,43 @@
+### What it does
+Suggests alternatives for useless applications of `?` in terminating expressions
+
+### Why is this bad?
+There's no reason to use `?` to short-circuit when execution of the body will end there anyway.
+
+### Example
+```
+struct TO {
+    magic: Option<usize>,
+}
+
+fn f(to: TO) -> Option<usize> {
+    Some(to.magic?)
+}
+
+struct TR {
+    magic: Result<usize, bool>,
+}
+
+fn g(tr: Result<TR, bool>) -> Result<usize, bool> {
+    tr.and_then(|t| Ok(t.magic?))
+}
+
+```
+Use instead:
+```
+struct TO {
+    magic: Option<usize>,
+}
+
+fn f(to: TO) -> Option<usize> {
+   to.magic
+}
+
+struct TR {
+    magic: Result<usize, bool>,
+}
+
+fn g(tr: Result<TR, bool>) -> Result<usize, bool> {
+    tr.and_then(|t| t.magic)
+}
+```
\ No newline at end of file