languages/rust
languages/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust synced 2024-07-20 05:56:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add doc example for CStr::to_str.

Browse source
This commit is contained in:
Corey Farwell 2017-06-18 16:12:39 -07:00
parent 0962394b84
commit e52d2f2ad0
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/libstd/ffi/c_str.rs
View file

@ -894,6 +894,15 @@ pub fn to_bytes_with_nul(&self) -> &[u8] {
/// > check whenever this method is called.
///
/// [`&str`]: ../primitive.str.html
///
/// # Examples
///
/// ```
/// use std::ffi::CStr;
///
/// let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap();
/// assert_eq!(c_str.to_str(), Ok("foo"));
/// ```
#[stable(feature = "cstr_to_str", since = "1.4.0")]
pub fn to_str(&self) -> Result<&str, str::Utf8Error> {
// NB: When CStr is changed to perform the length check in .to_bytes()