mirror of
https://github.com/rust-lang/rust.git
synced 2026-05-29 20:46:07 +03:00
Add more description to c_str::unwrap().
It's unclear what you are supposed to do with this memory. Let's make that more clear.
This commit is contained in:
committed by
Alex Crichton
parent
9e3d0b002a
commit
d58412bfa1
@@ -123,7 +123,10 @@ pub unsafe fn new(buf: *libc::c_char, owns_buffer: bool) -> CString {
|
||||
}
|
||||
|
||||
/// Unwraps the wrapped `*libc::c_char` from the `CString` wrapper.
|
||||
/// Any ownership of the buffer by the `CString` wrapper is forgotten.
|
||||
///
|
||||
/// The original object is destructed after this method is called, and if
|
||||
/// the underlying pointer was previously allocated, care must be taken to
|
||||
/// ensure that it is deallocated properly.
|
||||
pub unsafe fn unwrap(self) -> *libc::c_char {
|
||||
let mut c_str = self;
|
||||
c_str.owns_buffer_ = false;
|
||||
|
||||
Reference in New Issue
Block a user