about summary refs log tree commit diff
path: root/src/docs/format_push_string.txt
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2022-11-21 19:59:07 +0100
committerPhilipp Krones <hello@philkrones.com>2022-11-21 20:01:17 +0100
commitfd5b85c957d92a3bc5fc754407d1e56aa9178d27 (patch)
treecba25a7cb16b8f5981eb75b1138ece61bb412fb6 /src/docs/format_push_string.txt
parent80a4699aaeb17903cd55c3159764febf3ff4e7e9 (diff)
parent51ec465cc3dfb62a2dad7e808b399fa76a1c9170 (diff)
Merge remote-tracking branch 'upstream/master' into rustup
Diffstat (limited to 'src/docs/format_push_string.txt')
-rw-r--r--src/docs/format_push_string.txt26
1 files changed, 0 insertions, 26 deletions
diff --git a/src/docs/format_push_string.txt b/src/docs/format_push_string.txt
deleted file mode 100644
index ca409ebc7ec..00000000000
--- a/src/docs/format_push_string.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-### What it does
-Detects cases where the result of a `format!` call is
-appended to an existing `String`.
-
-### Why is this bad?
-Introduces an extra, avoidable heap allocation.
-
-### Known problems
-`format!` returns a `String` but `write!` returns a `Result`.
-Thus you are forced to ignore the `Err` variant to achieve the same API.
-
-While using `write!` in the suggested way should never fail, this isn't necessarily clear to the programmer.
-
-### Example
-```
-let mut s = String::new();
-s += &format!("0x{:X}", 1024);
-s.push_str(&format!("0x{:X}", 1024));
-```
-Use instead:
-```
-use std::fmt::Write as _; // import without risk of name clashing
-
-let mut s = String::new();
-let _ = write!(s, "0x{:X}", 1024);
-```
\ No newline at end of file