Skip to content

Commit 73ca84d

Browse files
committed
Auto merge of rust-lang#74741 - aticu:master, r=jonas-schievink
Improve documentation of `String::from_raw_parts`
2 parents 0e11fc8 + 44d8b4c commit 73ca84d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/liballoc/string.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -667,15 +667,16 @@ impl String {
667667
/// This is highly unsafe, due to the number of invariants that aren't
668668
/// checked:
669669
///
670-
/// * The memory at `ptr` needs to have been previously allocated by the
670+
/// * The memory at `buf` needs to have been previously allocated by the
671671
/// same allocator the standard library uses, with a required alignment of exactly 1.
672672
/// * `length` needs to be less than or equal to `capacity`.
673673
/// * `capacity` needs to be the correct value.
674+
/// * The first `length` bytes at `buf` need to be valid UTF-8.
674675
///
675676
/// Violating these may cause problems like corrupting the allocator's
676677
/// internal data structures.
677678
///
678-
/// The ownership of `ptr` is effectively transferred to the
679+
/// The ownership of `buf` is effectively transferred to the
679680
/// `String` which may then deallocate, reallocate or change the
680681
/// contents of memory pointed to by the pointer at will. Ensure
681682
/// that nothing else uses the pointer after calling this

0 commit comments

Comments
 (0)