about summary refs log tree commit diff
path: root/src/docs/as_ptr_cast_mut.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/as_ptr_cast_mut.txt')
-rw-r--r--src/docs/as_ptr_cast_mut.txt19
1 files changed, 0 insertions, 19 deletions
diff --git a/src/docs/as_ptr_cast_mut.txt b/src/docs/as_ptr_cast_mut.txt
deleted file mode 100644
index 228dde996bb..00000000000
--- a/src/docs/as_ptr_cast_mut.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-### What it does
-Checks for the result of a `&self`-taking `as_ptr` being cast to a mutable pointer
-
-### Why is this bad?
-Since `as_ptr` takes a `&self`, the pointer won't have write permissions unless interior
-mutability is used, making it unlikely that having it as a mutable pointer is correct.
-
-### Example
-```
-let string = String::with_capacity(1);
-let ptr = string.as_ptr() as *mut u8;
-unsafe { ptr.write(4) }; // UNDEFINED BEHAVIOUR
-```
-Use instead:
-```
-let mut string = String::with_capacity(1);
-let ptr = string.as_mut_ptr();
-unsafe { ptr.write(4) };
-```
\ No newline at end of file