about summary refs log tree commit diff
path: root/src/docs/recursive_format_impl.txt
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2022-11-21 20:34:47 +0100
committerPhilipp Krones <hello@philkrones.com>2022-11-21 20:51:52 +0100
commit46c5a5d234f13dcf4bb4cf4241b2addedbf0be14 (patch)
tree56726625e55224ecb09ed11f509a964507b9c333 /src/docs/recursive_format_impl.txt
parent3597ed5a099488aa77caf444106a0550b7e5d2e8 (diff)
downloadrust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.tar.gz
rust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.zip
Merge commit 'f4850f7292efa33759b4f7f9b7621268979e9914' into clippyup
Diffstat (limited to 'src/docs/recursive_format_impl.txt')
-rw-r--r--src/docs/recursive_format_impl.txt32
1 files changed, 0 insertions, 32 deletions
diff --git a/src/docs/recursive_format_impl.txt b/src/docs/recursive_format_impl.txt
deleted file mode 100644
index 32fffd84cf4..00000000000
--- a/src/docs/recursive_format_impl.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-### What it does
-Checks for format trait implementations (e.g. `Display`) with a recursive call to itself
-which uses `self` as a parameter.
-This is typically done indirectly with the `write!` macro or with `to_string()`.
-
-### Why is this bad?
-This will lead to infinite recursion and a stack overflow.
-
-### Example
-
-```
-use std::fmt;
-
-struct Structure(i32);
-impl fmt::Display for Structure {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "{}", self.to_string())
-    }
-}
-
-```
-Use instead:
-```
-use std::fmt;
-
-struct Structure(i32);
-impl fmt::Display for Structure {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "{}", self.0)
-    }
-}
-```
\ No newline at end of file