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:
Steve Klabnik 2014-06-23 12:52:28 -04:00 committed by Alex Crichton
parent 9e3d0b002a
commit d58412bfa1
1 changed files with 4 additions and 1 deletions

View File

@ -123,7 +123,10 @@ impl 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;