about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorJonathan Turner <jonathandturner@users.noreply.github.com>2016-08-17 06:25:24 -0700
committerGitHub <noreply@github.com>2016-08-17 06:25:24 -0700
commitb444ac69c06930136dfeb05813dcda49c7e82d62 (patch)
tree8d80b466d2e7f93c83ca247fce282383d313aaa9 /src/libstd
parent74549f8ef2a007b496467d2f29509135eacc6ddc (diff)
parent4e4d8baf7b99028a03280b90135117581c15d874 (diff)
downloadrust-b444ac69c06930136dfeb05813dcda49c7e82d62.tar.gz
rust-b444ac69c06930136dfeb05813dcda49c7e82d62.zip
Rollup merge of #35621 - frewsxcv:cstring-from-vec-doc, r=peschkaj
Add doc example for `std::ffi::CString::from_vec_unchecked`.

None
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/ffi/c_str.rs11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/libstd/ffi/c_str.rs b/src/libstd/ffi/c_str.rs
index 77b90c0846b..18a7c7c8457 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<u8>) -> CString {
         v.push(0);