squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Fixed documentation within c_str::from_ptr

Browse source
This commit is contained in:
hman523 2019-09-09 18:50:11 -05:00
parent 0b36e9dea3
commit bdfab2049c
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/libstd/ffi/c_str.rs
View file

@ -935,8 +935,10 @@ impl CStr {
/// Wraps a raw C string with a safe C string wrapper.
///
/// This function will wrap the provided `ptr` with a `CStr` wrapper, which
/// allows inspection and interoperation of non-owned C strings. This method
/// is unsafe for a number of reasons:
/// allows inspection and interoperation of non-owned C strings. The total
/// size of the raw C string must be smaller than `isize::MAX` **bytes**
/// in memory due to calling the slice::from_raw_parts function.
/// This method is unsafe for a number of reasons:
///
/// * There is no guarantee to the validity of `ptr`.
/// * The returned lifetime is not guaranteed to be the actual lifetime of