From 4e4d8baf7b99028a03280b90135117581c15d874 Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Fri, 12 Aug 2016 09:08:37 -0400 Subject: [PATCH] Add doc example for `std::ffi::CString::from_vec_unchecked`. --- src/libstd/ffi/c_str.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/libstd/ffi/c_str.rs b/src/libstd/ffi/c_str.rs index 77b90c0846bbe..18a7c7c845704 100644 --- a/src/libstd/ffi/c_str.rs +++ b/src/libstd/ffi/c_str.rs @@ -211,6 +211,17 @@ impl CString { /// This method is equivalent to `new` except that no runtime assertion /// is made that `v` contains no 0 bytes, and it requires an actual /// byte vector, not anything that can be converted to one with Into. + /// + /// # Examples + /// + /// ``` + /// use std::ffi::CString; + /// + /// let raw = b"foo".to_vec(); + /// unsafe { + /// let c_string = CString::from_vec_unchecked(raw); + /// } + /// ``` #[stable(feature = "rust1", since = "1.0.0")] pub unsafe fn from_vec_unchecked(mut v: Vec) -> CString { v.push(0);