Fixed documentation within c_str::from_ptr
This commit is contained in:
parent
0b36e9dea3
commit
bdfab2049c
1 changed files with 4 additions and 2 deletions
|
@ -935,8 +935,10 @@ impl CStr {
|
||||||
/// Wraps a raw C string with a safe C string wrapper.
|
/// Wraps a raw C string with a safe C string wrapper.
|
||||||
///
|
///
|
||||||
/// This function will wrap the provided `ptr` with a `CStr` wrapper, which
|
/// This function will wrap the provided `ptr` with a `CStr` wrapper, which
|
||||||
/// allows inspection and interoperation of non-owned C strings. This method
|
/// allows inspection and interoperation of non-owned C strings. The total
|
||||||
/// is unsafe for a number of reasons:
|
/// 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`.
|
/// * There is no guarantee to the validity of `ptr`.
|
||||||
/// * The returned lifetime is not guaranteed to be the actual lifetime of
|
/// * The returned lifetime is not guaranteed to be the actual lifetime of
|
||||||
|
|
Loading…
Reference in a new issue