src/libstd/ffi/c_str.rs

   1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use ascii;
  12 use borrow::{Cow, Borrow};
  13 use cmp::Ordering;
  14 use error::Error;
  15 use fmt::{self, Write};
  16 use io;
  17 use libc;
  18 use mem;
  19 use memchr;
  20 use ops;
  21 use os::raw::c_char;
  22 use ptr;
  23 use slice;
  24 use str::{self, Utf8Error};
  25
  26 /// A type representing an owned C-compatible string.
  27 ///
  28 /// This type serves the primary purpose of being able to safely generate a
  29 /// C-compatible string from a Rust byte slice or vector. An instance of this
  30 /// type is a static guarantee that the underlying bytes contain no interior 0
  31 /// bytes and the final byte is 0.
  32 ///
  33 /// A `CString` is created from either a byte slice or a byte vector. A [`u8`]
  34 /// slice can be obtained with the `as_bytes` method. Slices produced from a
  35 /// `CString` do *not* contain the trailing nul terminator unless otherwise
  36 /// specified.
  37 ///
  38 /// [`u8`]: ../primitive.u8.html
  39 ///
  40 /// # Examples
  41 ///
  42 /// ```no_run
  43 /// # fn main() {
  44 /// use std::ffi::CString;
  45 /// use std::os::raw::c_char;
  46 ///
  47 /// extern {
  48 ///     fn my_printer(s: *const c_char);
  49 /// }
  50 ///
  51 /// let c_to_print = CString::new("Hello, world!").unwrap();
  52 /// unsafe {
  53 ///     my_printer(c_to_print.as_ptr());
  54 /// }
  55 /// # }
  56 /// ```
  57 ///
  58 /// # Safety
  59 ///
  60 /// `CString` is intended for working with traditional C-style strings
  61 /// (a sequence of non-null bytes terminated by a single null byte); the
  62 /// primary use case for these kinds of strings is interoperating with C-like
  63 /// code. Often you will need to transfer ownership to/from that external
  64 /// code. It is strongly recommended that you thoroughly read through the
  65 /// documentation of `CString` before use, as improper ownership management
  66 /// of `CString` instances can lead to invalid memory accesses, memory leaks,
  67 /// and other memory errors.
  68
  69 #[derive(PartialEq, PartialOrd, Eq, Ord, Hash, Clone)]
  70 #[stable(feature = "rust1", since = "1.0.0")]
  71 pub struct CString {
  72     // Invariant 1: the slice ends with a zero byte and has a length of at least one.
  73     // Invariant 2: the slice contains only one zero byte.
  74     // Improper usage of unsafe function can break Invariant 2, but not Invariant 1.
  75     inner: Box<[u8]>,
  76 }
  77
  78 /// Representation of a borrowed C string.
  79 ///
  80 /// This dynamically sized type is only safely constructed via a borrowed
  81 /// version of an instance of `CString`. This type can be constructed from a raw
  82 /// C string as well and represents a C string borrowed from another location.
  83 ///
  84 /// Note that this structure is **not** `repr(C)` and is not recommended to be
  85 /// placed in the signatures of FFI functions. Instead safe wrappers of FFI
  86 /// functions may leverage the unsafe [`from_ptr`] constructor to provide a safe
  87 /// interface to other consumers.
  88 ///
  89 /// [`from_ptr`]: #method.from_ptr
  90 ///
  91 /// # Examples
  92 ///
  93 /// Inspecting a foreign C string:
  94 ///
  95 /// ```no_run
  96 /// use std::ffi::CStr;
  97 /// use std::os::raw::c_char;
  98 ///
  99 /// extern { fn my_string() -> *const c_char; }
 100 ///
 101 /// unsafe {
 102 ///     let slice = CStr::from_ptr(my_string());
 103 ///     println!("string length: {}", slice.to_bytes().len());
 104 /// }
 105 /// ```
 106 ///
 107 /// Passing a Rust-originating C string:
 108 ///
 109 /// ```no_run
 110 /// use std::ffi::{CString, CStr};
 111 /// use std::os::raw::c_char;
 112 ///
 113 /// fn work(data: &CStr) {
 114 ///     extern { fn work_with(data: *const c_char); }
 115 ///
 116 ///     unsafe { work_with(data.as_ptr()) }
 117 /// }
 118 ///
 119 /// let s = CString::new("data data data data").unwrap();
 120 /// work(&s);
 121 /// ```
 122 ///
 123 /// Converting a foreign C string into a Rust [`String`]:
 124 ///
 125 /// [`String`]: ../string/struct.String.html
 126 ///
 127 /// ```no_run
 128 /// use std::ffi::CStr;
 129 /// use std::os::raw::c_char;
 130 ///
 131 /// extern { fn my_string() -> *const c_char; }
 132 ///
 133 /// fn my_string_safe() -> String {
 134 ///     unsafe {
 135 ///         CStr::from_ptr(my_string()).to_string_lossy().into_owned()
 136 ///     }
 137 /// }
 138 ///
 139 /// println!("string: {}", my_string_safe());
 140 /// ```
 141 #[derive(Hash)]
 142 #[stable(feature = "rust1", since = "1.0.0")]
 143 pub struct CStr {
 144     // FIXME: this should not be represented with a DST slice but rather with
 145     //        just a raw `c_char` along with some form of marker to make
 146     //        this an unsized type. Essentially `sizeof(&CStr)` should be the
 147     //        same as `sizeof(&c_char)` but `CStr` should be an unsized type.
 148     inner: [c_char]
 149 }
 150
 151 /// An error returned from [`CString::new`] to indicate that a nul byte was found
 152 /// in the vector provided.
 153 ///
 154 /// [`CString::new`]: struct.CString.html#method.new
 155 #[derive(Clone, PartialEq, Eq, Debug)]
 156 #[stable(feature = "rust1", since = "1.0.0")]
 157 pub struct NulError(usize, Vec<u8>);
 158
 159 /// An error returned from [`CStr::from_bytes_with_nul`] to indicate that a nul
 160 /// byte was found too early in the slice provided or one wasn't found at all.
 161 ///
 162 /// [`CStr::from_bytes_with_nul`]: struct.CStr.html#method.from_bytes_with_nul
 163 #[derive(Clone, PartialEq, Eq, Debug)]
 164 #[stable(feature = "cstr_from_bytes", since = "1.10.0")]
 165 pub struct FromBytesWithNulError {
 166     kind: FromBytesWithNulErrorKind,
 167 }
 168
 169 #[derive(Clone, PartialEq, Eq, Debug)]
 170 enum FromBytesWithNulErrorKind {
 171     InteriorNul(usize),
 172     NotNulTerminated,
 173 }
 174
 175 impl FromBytesWithNulError {
 176     fn interior_nul(pos: usize) -> FromBytesWithNulError {
 177         FromBytesWithNulError {
 178             kind: FromBytesWithNulErrorKind::InteriorNul(pos),
 179         }
 180     }
 181     fn not_nul_terminated() -> FromBytesWithNulError {
 182         FromBytesWithNulError {
 183             kind: FromBytesWithNulErrorKind::NotNulTerminated,
 184         }
 185     }
 186 }
 187
 188 /// An error returned from [`CString::into_string`] to indicate that a UTF-8 error
 189 /// was encountered during the conversion.
 190 ///
 191 /// [`CString::into_string`]: struct.CString.html#method.into_string
 192 #[derive(Clone, PartialEq, Eq, Debug)]
 193 #[stable(feature = "cstring_into", since = "1.7.0")]
 194 pub struct IntoStringError {
 195     inner: CString,
 196     error: Utf8Error,
 197 }
 198
 199 impl CString {
 200     /// Creates a new C-compatible string from a container of bytes.
 201     ///
 202     /// This method will consume the provided data and use the underlying bytes
 203     /// to construct a new string, ensuring that there is a trailing 0 byte.
 204     ///
 205     /// # Examples
 206     ///
 207     /// ```no_run
 208     /// use std::ffi::CString;
 209     /// use std::os::raw::c_char;
 210     ///
 211     /// extern { fn puts(s: *const c_char); }
 212     ///
 213     /// let to_print = CString::new("Hello!").unwrap();
 214     /// unsafe {
 215     ///     puts(to_print.as_ptr());
 216     /// }
 217     /// ```
 218     ///
 219     /// # Errors
 220     ///
 221     /// This function will return an error if the bytes yielded contain an
 222     /// internal 0 byte. The error returned will contain the bytes as well as
 223     /// the position of the nul byte.
 224     #[stable(feature = "rust1", since = "1.0.0")]
 225     pub fn new<T: Into<Vec<u8>>>(t: T) -> Result<CString, NulError> {
 226         Self::_new(t.into())
 227     }
 228
 229     fn _new(bytes: Vec<u8>) -> Result<CString, NulError> {
 230         match memchr::memchr(0, &bytes) {
 231             Some(i) => Err(NulError(i, bytes)),
 232             None => Ok(unsafe { CString::from_vec_unchecked(bytes) }),
 233         }
 234     }
 235
 236     /// Creates a C-compatible string from a byte vector without checking for
 237     /// interior 0 bytes.
 238     ///
 239     /// This method is equivalent to [`new`] except that no runtime assertion
 240     /// is made that `v` contains no 0 bytes, and it requires an actual
 241     /// byte vector, not anything that can be converted to one with Into.
 242     ///
 243     /// [`new`]: #method.new
 244     ///
 245     /// # Examples
 246     ///
 247     /// ```
 248     /// use std::ffi::CString;
 249     ///
 250     /// let raw = b"foo".to_vec();
 251     /// unsafe {
 252     ///     let c_string = CString::from_vec_unchecked(raw);
 253     /// }
 254     /// ```
 255     #[stable(feature = "rust1", since = "1.0.0")]
 256     pub unsafe fn from_vec_unchecked(mut v: Vec<u8>) -> CString {
 257         v.reserve_exact(1);
 258         v.push(0);
 259         CString { inner: v.into_boxed_slice() }
 260     }
 261
 262     /// Retakes ownership of a `CString` that was transferred to C.
 263     ///
 264     /// Additionally, the length of the string will be recalculated from the pointer.
 265     ///
 266     /// # Safety
 267     ///
 268     /// This should only ever be called with a pointer that was earlier
 269     /// obtained by calling [`into_raw`] on a `CString`. Other usage (e.g. trying to take
 270     /// ownership of a string that was allocated by foreign code) is likely to lead
 271     /// to undefined behavior or allocator corruption.
 272     ///
 273     /// [`into_raw`]: #method.into_raw
 274     #[stable(feature = "cstr_memory", since = "1.4.0")]
 275     pub unsafe fn from_raw(ptr: *mut c_char) -> CString {
 276         let len = libc::strlen(ptr) + 1; // Including the NUL byte
 277         let slice = slice::from_raw_parts(ptr, len as usize);
 278         CString { inner: mem::transmute(slice) }
 279     }
 280
 281     /// Transfers ownership of the string to a C caller.
 282     ///
 283     /// The pointer must be returned to Rust and reconstituted using
 284     /// [`from_raw`] to be properly deallocated. Specifically, one
 285     /// should *not* use the standard C `free` function to deallocate
 286     /// this string.
 287     ///
 288     /// Failure to call [`from_raw`] will lead to a memory leak.
 289     ///
 290     /// [`from_raw`]: #method.from_raw
 291     ///
 292     /// # Examples
 293     ///
 294     /// ```
 295     /// use std::ffi::CString;
 296     ///
 297     /// let c_string = CString::new("foo").unwrap();
 298     ///
 299     /// let ptr = c_string.into_raw();
 300     ///
 301     /// unsafe {
 302     ///     assert_eq!(b'f', *ptr as u8);
 303     ///     assert_eq!(b'o', *ptr.offset(1) as u8);
 304     ///     assert_eq!(b'o', *ptr.offset(2) as u8);
 305     ///     assert_eq!(b'\0', *ptr.offset(3) as u8);
 306     ///
 307     ///     // retake pointer to free memory
 308     ///     let _ = CString::from_raw(ptr);
 309     /// }
 310     /// ```
 311     #[stable(feature = "cstr_memory", since = "1.4.0")]
 312     pub fn into_raw(self) -> *mut c_char {
 313         Box::into_raw(self.into_inner()) as *mut c_char
 314     }
 315
 316     /// Converts the `CString` into a [`String`] if it contains valid Unicode data.
 317     ///
 318     /// On failure, ownership of the original `CString` is returned.
 319     ///
 320     /// [`String`]: ../string/struct.String.html
 321     #[stable(feature = "cstring_into", since = "1.7.0")]
 322     pub fn into_string(self) -> Result<String, IntoStringError> {
 323         String::from_utf8(self.into_bytes())
 324             .map_err(|e| IntoStringError {
 325                 error: e.utf8_error(),
 326                 inner: unsafe { CString::from_vec_unchecked(e.into_bytes()) },
 327             })
 328     }
 329
 330     /// Returns the underlying byte buffer.
 331     ///
 332     /// The returned buffer does **not** contain the trailing nul separator and
 333     /// it is guaranteed to not have any interior nul bytes.
 334     ///
 335     /// # Examples
 336     ///
 337     /// ```
 338     /// use std::ffi::CString;
 339     ///
 340     /// let c_string = CString::new("foo").unwrap();
 341     /// let bytes = c_string.into_bytes();
 342     /// assert_eq!(bytes, vec![b'f', b'o', b'o']);
 343     /// ```
 344     #[stable(feature = "cstring_into", since = "1.7.0")]
 345     pub fn into_bytes(self) -> Vec<u8> {
 346         let mut vec = self.into_inner().into_vec();
 347         let _nul = vec.pop();
 348         debug_assert_eq!(_nul, Some(0u8));
 349         vec
 350     }
 351
 352     /// Equivalent to the [`into_bytes`] function except that the returned vector
 353     /// includes the trailing nul byte.
 354     ///
 355     /// [`into_bytes`]: #method.into_bytes
 356     #[stable(feature = "cstring_into", since = "1.7.0")]
 357     pub fn into_bytes_with_nul(self) -> Vec<u8> {
 358         self.into_inner().into_vec()
 359     }
 360
 361     /// Returns the contents of this `CString` as a slice of bytes.
 362     ///
 363     /// The returned slice does **not** contain the trailing nul separator and
 364     /// it is guaranteed to not have any interior nul bytes.
 365     #[stable(feature = "rust1", since = "1.0.0")]
 366     pub fn as_bytes(&self) -> &[u8] {
 367         &self.inner[..self.inner.len() - 1]
 368     }
 369
 370     /// Equivalent to the [`as_bytes`] function except that the returned slice
 371     /// includes the trailing nul byte.
 372     ///
 373     /// [`as_bytes`]: #method.as_bytes
 374     #[stable(feature = "rust1", since = "1.0.0")]
 375     pub fn as_bytes_with_nul(&self) -> &[u8] {
 376         &self.inner
 377     }
 378
 379     /// Extracts a [`CStr`] slice containing the entire string.
 380     ///
 381     /// [`CStr`]: struct.CStr.html
 382     #[unstable(feature = "as_c_str", issue = "40380")]
 383     pub fn as_c_str(&self) -> &CStr {
 384         &*self
 385     }
 386
 387     /// Converts this `CString` into a boxed [`CStr`].
 388     ///
 389     /// [`CStr`]: struct.CStr.html
 390     #[unstable(feature = "into_boxed_c_str", issue = "40380")]
 391     pub fn into_boxed_c_str(self) -> Box<CStr> {
 392         unsafe { mem::transmute(self.into_inner()) }
 393     }
 394
 395     // Bypass "move out of struct which implements [`Drop`] trait" restriction.
 396     ///
 397     /// [`Drop`]: ../ops/trait.Drop.html
 398     fn into_inner(self) -> Box<[u8]> {
 399         unsafe {
 400             let result = ptr::read(&self.inner);
 401             mem::forget(self);
 402             result
 403         }
 404     }
 405 }
 406
 407 // Turns this `CString` into an empty string to prevent
 408 // memory unsafe code from working by accident. Inline
 409 // to prevent LLVM from optimizing it away in debug builds.
 410 #[stable(feature = "cstring_drop", since = "1.13.0")]
 411 impl Drop for CString {
 412     #[inline]
 413     fn drop(&mut self) {
 414         unsafe { *self.inner.get_unchecked_mut(0) = 0; }
 415     }
 416 }
 417
 418 #[stable(feature = "rust1", since = "1.0.0")]
 419 impl ops::Deref for CString {
 420     type Target = CStr;
 421
 422     fn deref(&self) -> &CStr {
 423         unsafe { CStr::from_bytes_with_nul_unchecked(self.as_bytes_with_nul()) }
 424     }
 425 }
 426
 427 #[stable(feature = "rust1", since = "1.0.0")]
 428 impl fmt::Debug for CString {
 429     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 430         fmt::Debug::fmt(&**self, f)
 431     }
 432 }
 433
 434 #[stable(feature = "cstring_into", since = "1.7.0")]
 435 impl From<CString> for Vec<u8> {
 436     fn from(s: CString) -> Vec<u8> {
 437         s.into_bytes()
 438     }
 439 }
 440
 441 #[stable(feature = "cstr_debug", since = "1.3.0")]
 442 impl fmt::Debug for CStr {
 443     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 444         write!(f, "\"")?;
 445         for byte in self.to_bytes().iter().flat_map(|&b| ascii::escape_default(b)) {
 446             f.write_char(byte as char)?;
 447         }
 448         write!(f, "\"")
 449     }
 450 }
 451
 452 #[stable(feature = "cstr_default", since = "1.10.0")]
 453 impl<'a> Default for &'a CStr {
 454     fn default() -> &'a CStr {
 455         static SLICE: &'static [c_char] = &[0];
 456         unsafe { CStr::from_ptr(SLICE.as_ptr()) }
 457     }
 458 }
 459
 460 #[stable(feature = "cstr_default", since = "1.10.0")]
 461 impl Default for CString {
 462     /// Creates an empty `CString`.
 463     fn default() -> CString {
 464         let a: &CStr = Default::default();
 465         a.to_owned()
 466     }
 467 }
 468
 469 #[stable(feature = "cstr_borrow", since = "1.3.0")]
 470 impl Borrow<CStr> for CString {
 471     fn borrow(&self) -> &CStr { self }
 472 }
 473
 474 #[stable(feature = "box_from_c_str", since = "1.17.0")]
 475 impl<'a> From<&'a CStr> for Box<CStr> {
 476     fn from(s: &'a CStr) -> Box<CStr> {
 477         let boxed: Box<[u8]> = Box::from(s.to_bytes_with_nul());
 478         unsafe { mem::transmute(boxed) }
 479     }
 480 }
 481
 482 #[stable(feature = "c_string_from_box", since = "1.18.0")]
 483 impl From<Box<CStr>> for CString {
 484     fn from(s: Box<CStr>) -> CString {
 485         s.into_c_string()
 486     }
 487 }
 488
 489 #[stable(feature = "box_from_c_string", since = "1.18.0")]
 490 impl Into<Box<CStr>> for CString {
 491     fn into(self) -> Box<CStr> {
 492         self.into_boxed_c_str()
 493     }
 494 }
 495
 496 #[stable(feature = "default_box_extra", since = "1.17.0")]
 497 impl Default for Box<CStr> {
 498     fn default() -> Box<CStr> {
 499         let boxed: Box<[u8]> = Box::from([0]);
 500         unsafe { mem::transmute(boxed) }
 501     }
 502 }
 503
 504 impl NulError {
 505     /// Returns the position of the nul byte in the slice that was provided to
 506     /// [`CString::new`].
 507     ///
 508     /// [`CString::new`]: struct.CString.html#method.new
 509     ///
 510     /// # Examples
 511     ///
 512     /// ```
 513     /// use std::ffi::CString;
 514     ///
 515     /// let nul_error = CString::new("foo\0bar").unwrap_err();
 516     /// assert_eq!(nul_error.nul_position(), 3);
 517     ///
 518     /// let nul_error = CString::new("foo bar\0").unwrap_err();
 519     /// assert_eq!(nul_error.nul_position(), 7);
 520     /// ```
 521     #[stable(feature = "rust1", since = "1.0.0")]
 522     pub fn nul_position(&self) -> usize { self.0 }
 523
 524     /// Consumes this error, returning the underlying vector of bytes which
 525     /// generated the error in the first place.
 526     ///
 527     /// # Examples
 528     ///
 529     /// ```
 530     /// use std::ffi::CString;
 531     ///
 532     /// let nul_error = CString::new("foo\0bar").unwrap_err();
 533     /// assert_eq!(nul_error.into_vec(), b"foo\0bar");
 534     /// ```
 535     #[stable(feature = "rust1", since = "1.0.0")]
 536     pub fn into_vec(self) -> Vec<u8> { self.1 }
 537 }
 538
 539 #[stable(feature = "rust1", since = "1.0.0")]
 540 impl Error for NulError {
 541     fn description(&self) -> &str { "nul byte found in data" }
 542 }
 543
 544 #[stable(feature = "rust1", since = "1.0.0")]
 545 impl fmt::Display for NulError {
 546     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 547         write!(f, "nul byte found in provided data at position: {}", self.0)
 548     }
 549 }
 550
 551 #[stable(feature = "rust1", since = "1.0.0")]
 552 impl From<NulError> for io::Error {
 553     fn from(_: NulError) -> io::Error {
 554         io::Error::new(io::ErrorKind::InvalidInput,
 555                        "data provided contains a nul byte")
 556     }
 557 }
 558
 559 #[stable(feature = "frombyteswithnulerror_impls", since = "1.17.0")]
 560 impl Error for FromBytesWithNulError {
 561     fn description(&self) -> &str {
 562         match self.kind {
 563             FromBytesWithNulErrorKind::InteriorNul(..) =>
 564                 "data provided contains an interior nul byte",
 565             FromBytesWithNulErrorKind::NotNulTerminated =>
 566                 "data provided is not nul terminated",
 567         }
 568     }
 569 }
 570
 571 #[stable(feature = "frombyteswithnulerror_impls", since = "1.17.0")]
 572 impl fmt::Display for FromBytesWithNulError {
 573     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 574         f.write_str(self.description())?;
 575         if let FromBytesWithNulErrorKind::InteriorNul(pos) = self.kind {
 576             write!(f, " at byte pos {}", pos)?;
 577         }
 578         Ok(())
 579     }
 580 }
 581
 582 impl IntoStringError {
 583     /// Consumes this error, returning original [`CString`] which generated the
 584     /// error.
 585     ///
 586     /// [`CString`]: struct.CString.html
 587     #[stable(feature = "cstring_into", since = "1.7.0")]
 588     pub fn into_cstring(self) -> CString {
 589         self.inner
 590     }
 591
 592     /// Access the underlying UTF-8 error that was the cause of this error.
 593     #[stable(feature = "cstring_into", since = "1.7.0")]
 594     pub fn utf8_error(&self) -> Utf8Error {
 595         self.error
 596     }
 597 }
 598
 599 #[stable(feature = "cstring_into", since = "1.7.0")]
 600 impl Error for IntoStringError {
 601     fn description(&self) -> &str {
 602         "C string contained non-utf8 bytes"
 603     }
 604
 605     fn cause(&self) -> Option<&Error> {
 606         Some(&self.error)
 607     }
 608 }
 609
 610 #[stable(feature = "cstring_into", since = "1.7.0")]
 611 impl fmt::Display for IntoStringError {
 612     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 613         self.description().fmt(f)
 614     }
 615 }
 616
 617 impl CStr {
 618     /// Casts a raw C string to a safe C string wrapper.
 619     ///
 620     /// This function will cast the provided `ptr` to the `CStr` wrapper which
 621     /// allows inspection and interoperation of non-owned C strings. This method
 622     /// is unsafe for a number of reasons:
 623     ///
 624     /// * There is no guarantee to the validity of `ptr`.
 625     /// * The returned lifetime is not guaranteed to be the actual lifetime of
 626     ///   `ptr`.
 627     /// * There is no guarantee that the memory pointed to by `ptr` contains a
 628     ///   valid nul terminator byte at the end of the string.
 629     ///
 630     /// > **Note**: This operation is intended to be a 0-cost cast but it is
 631     /// > currently implemented with an up-front calculation of the length of
 632     /// > the string. This is not guaranteed to always be the case.
 633     ///
 634     /// # Examples
 635     ///
 636     /// ```no_run
 637     /// # fn main() {
 638     /// use std::ffi::CStr;
 639     /// use std::os::raw::c_char;
 640     ///
 641     /// extern {
 642     ///     fn my_string() -> *const c_char;
 643     /// }
 644     ///
 645     /// unsafe {
 646     ///     let slice = CStr::from_ptr(my_string());
 647     ///     println!("string returned: {}", slice.to_str().unwrap());
 648     /// }
 649     /// # }
 650     /// ```
 651     #[stable(feature = "rust1", since = "1.0.0")]
 652     pub unsafe fn from_ptr<'a>(ptr: *const c_char) -> &'a CStr {
 653         let len = libc::strlen(ptr);
 654         let ptr = ptr as *const u8;
 655         CStr::from_bytes_with_nul_unchecked(slice::from_raw_parts(ptr, len as usize + 1))
 656     }
 657
 658     /// Creates a C string wrapper from a byte slice.
 659     ///
 660     /// This function will cast the provided `bytes` to a `CStr` wrapper after
 661     /// ensuring that it is null terminated and does not contain any interior
 662     /// nul bytes.
 663     ///
 664     /// # Examples
 665     ///
 666     /// ```
 667     /// use std::ffi::CStr;
 668     ///
 669     /// let cstr = CStr::from_bytes_with_nul(b"hello\0");
 670     /// assert!(cstr.is_ok());
 671     /// ```
 672     #[stable(feature = "cstr_from_bytes", since = "1.10.0")]
 673     pub fn from_bytes_with_nul(bytes: &[u8])
 674                                -> Result<&CStr, FromBytesWithNulError> {
 675         let nul_pos = memchr::memchr(0, bytes);
 676         if let Some(nul_pos) = nul_pos {
 677             if nul_pos + 1 != bytes.len() {
 678                 return Err(FromBytesWithNulError::interior_nul(nul_pos));
 679             }
 680             Ok(unsafe { CStr::from_bytes_with_nul_unchecked(bytes) })
 681         } else {
 682             Err(FromBytesWithNulError::not_nul_terminated())
 683         }
 684     }
 685
 686     /// Unsafely creates a C string wrapper from a byte slice.
 687     ///
 688     /// This function will cast the provided `bytes` to a `CStr` wrapper without
 689     /// performing any sanity checks. The provided slice must be null terminated
 690     /// and not contain any interior nul bytes.
 691     ///
 692     /// # Examples
 693     ///
 694     /// ```
 695     /// use std::ffi::{CStr, CString};
 696     ///
 697     /// unsafe {
 698     ///     let cstring = CString::new("hello").unwrap();
 699     ///     let cstr = CStr::from_bytes_with_nul_unchecked(cstring.to_bytes_with_nul());
 700     ///     assert_eq!(cstr, &*cstring);
 701     /// }
 702     /// ```
 703     #[stable(feature = "cstr_from_bytes", since = "1.10.0")]
 704     pub unsafe fn from_bytes_with_nul_unchecked(bytes: &[u8]) -> &CStr {
 705         mem::transmute(bytes)
 706     }
 707
 708     /// Returns the inner pointer to this C string.
 709     ///
 710     /// The returned pointer will be valid for as long as `self` is and points
 711     /// to a contiguous region of memory terminated with a 0 byte to represent
 712     /// the end of the string.
 713     ///
 714     /// **WARNING**
 715     ///
 716     /// It is your responsibility to make sure that the underlying memory is not
 717     /// freed too early. For example, the following code will cause undefined
 718     /// behaviour when `ptr` is used inside the `unsafe` block:
 719     ///
 720     /// ```no_run
 721     /// use std::ffi::{CString};
 722     ///
 723     /// let ptr = CString::new("Hello").unwrap().as_ptr();
 724     /// unsafe {
 725     ///     // `ptr` is dangling
 726     ///     *ptr;
 727     /// }
 728     /// ```
 729     ///
 730     /// This happens because the pointer returned by `as_ptr` does not carry any
 731     /// lifetime information and the string is deallocated immediately after
 732     /// the `CString::new("Hello").unwrap().as_ptr()` expression is evaluated.
 733     /// To fix the problem, bind the string to a local variable:
 734     ///
 735     /// ```no_run
 736     /// use std::ffi::{CString};
 737     ///
 738     /// let hello = CString::new("Hello").unwrap();
 739     /// let ptr = hello.as_ptr();
 740     /// unsafe {
 741     ///     // `ptr` is valid because `hello` is in scope
 742     ///     *ptr;
 743     /// }
 744     /// ```
 745     #[stable(feature = "rust1", since = "1.0.0")]
 746     pub fn as_ptr(&self) -> *const c_char {
 747         self.inner.as_ptr()
 748     }
 749
 750     /// Converts this C string to a byte slice.
 751     ///
 752     /// This function will calculate the length of this string (which normally
 753     /// requires a linear amount of work to be done) and then return the
 754     /// resulting slice of `u8` elements.
 755     ///
 756     /// The returned slice will **not** contain the trailing nul that this C
 757     /// string has.
 758     ///
 759     /// > **Note**: This method is currently implemented as a 0-cost cast, but
 760     /// > it is planned to alter its definition in the future to perform the
 761     /// > length calculation whenever this method is called.
 762     #[stable(feature = "rust1", since = "1.0.0")]
 763     pub fn to_bytes(&self) -> &[u8] {
 764         let bytes = self.to_bytes_with_nul();
 765         &bytes[..bytes.len() - 1]
 766     }
 767
 768     /// Converts this C string to a byte slice containing the trailing 0 byte.
 769     ///
 770     /// This function is the equivalent of [`to_bytes`] except that it will retain
 771     /// the trailing nul instead of chopping it off.
 772     ///
 773     /// > **Note**: This method is currently implemented as a 0-cost cast, but
 774     /// > it is planned to alter its definition in the future to perform the
 775     /// > length calculation whenever this method is called.
 776     ///
 777     /// [`to_bytes`]: #method.to_bytes
 778     #[stable(feature = "rust1", since = "1.0.0")]
 779     pub fn to_bytes_with_nul(&self) -> &[u8] {
 780         unsafe { mem::transmute(&self.inner) }
 781     }
 782
 783     /// Yields a [`&str`] slice if the `CStr` contains valid UTF-8.
 784     ///
 785     /// This function will calculate the length of this string and check for
 786     /// UTF-8 validity, and then return the [`&str`] if it's valid.
 787     ///
 788     /// > **Note**: This method is currently implemented to check for validity
 789     /// > after a 0-cost cast, but it is planned to alter its definition in the
 790     /// > future to perform the length calculation in addition to the UTF-8
 791     /// > check whenever this method is called.
 792     ///
 793     /// [`&str`]: ../primitive.str.html
 794     #[stable(feature = "cstr_to_str", since = "1.4.0")]
 795     pub fn to_str(&self) -> Result<&str, str::Utf8Error> {
 796         // NB: When CStr is changed to perform the length check in .to_bytes()
 797         // instead of in from_ptr(), it may be worth considering if this should
 798         // be rewritten to do the UTF-8 check inline with the length calculation
 799         // instead of doing it afterwards.
 800         str::from_utf8(self.to_bytes())
 801     }
 802
 803     /// Converts a `CStr` into a [`Cow`]`<`[`str`]`>`.
 804     ///
 805     /// This function will calculate the length of this string (which normally
 806     /// requires a linear amount of work to be done) and then return the
 807     /// resulting slice as a [`Cow`]`<`[`str`]`>`, replacing any invalid UTF-8 sequences
 808     /// with `U+FFFD REPLACEMENT CHARACTER`.
 809     ///
 810     /// > **Note**: This method is currently implemented to check for validity
 811     /// > after a 0-cost cast, but it is planned to alter its definition in the
 812     /// > future to perform the length calculation in addition to the UTF-8
 813     /// > check whenever this method is called.
 814     ///
 815     /// [`Cow`]: ../borrow/enum.Cow.html
 816     /// [`str`]: ../primitive.str.html
 817     #[stable(feature = "cstr_to_str", since = "1.4.0")]
 818     pub fn to_string_lossy(&self) -> Cow<str> {
 819         String::from_utf8_lossy(self.to_bytes())
 820     }
 821
 822     /// Converts a [`Box`]`<CStr>` into a [`CString`] without copying or allocating.
 823     ///
 824     /// [`Box`]: ../boxed/struct.Box.html
 825     /// [`CString`]: struct.CString.html
 826     #[unstable(feature = "into_boxed_c_str", issue = "40380")]
 827     pub fn into_c_string(self: Box<CStr>) -> CString {
 828         unsafe { mem::transmute(self) }
 829     }
 830 }
 831
 832 #[stable(feature = "rust1", since = "1.0.0")]
 833 impl PartialEq for CStr {
 834     fn eq(&self, other: &CStr) -> bool {
 835         self.to_bytes().eq(other.to_bytes())
 836     }
 837 }
 838 #[stable(feature = "rust1", since = "1.0.0")]
 839 impl Eq for CStr {}
 840 #[stable(feature = "rust1", since = "1.0.0")]
 841 impl PartialOrd for CStr {
 842     fn partial_cmp(&self, other: &CStr) -> Option<Ordering> {
 843         self.to_bytes().partial_cmp(&other.to_bytes())
 844     }
 845 }
 846 #[stable(feature = "rust1", since = "1.0.0")]
 847 impl Ord for CStr {
 848     fn cmp(&self, other: &CStr) -> Ordering {
 849         self.to_bytes().cmp(&other.to_bytes())
 850     }
 851 }
 852
 853 #[stable(feature = "cstr_borrow", since = "1.3.0")]
 854 impl ToOwned for CStr {
 855     type Owned = CString;
 856
 857     fn to_owned(&self) -> CString {
 858         CString { inner: self.to_bytes_with_nul().into() }
 859     }
 860 }
 861
 862 #[stable(feature = "cstring_asref", since = "1.7.0")]
 863 impl<'a> From<&'a CStr> for CString {
 864     fn from(s: &'a CStr) -> CString {
 865         s.to_owned()
 866     }
 867 }
 868
 869 #[stable(feature = "cstring_asref", since = "1.7.0")]
 870 impl ops::Index<ops::RangeFull> for CString {
 871     type Output = CStr;
 872
 873     #[inline]
 874     fn index(&self, _index: ops::RangeFull) -> &CStr {
 875         self
 876     }
 877 }
 878
 879 #[stable(feature = "cstring_asref", since = "1.7.0")]
 880 impl AsRef<CStr> for CStr {
 881     fn as_ref(&self) -> &CStr {
 882         self
 883     }
 884 }
 885
 886 #[stable(feature = "cstring_asref", since = "1.7.0")]
 887 impl AsRef<CStr> for CString {
 888     fn as_ref(&self) -> &CStr {
 889         self
 890     }
 891 }
 892
 893 #[cfg(test)]
 894 mod tests {
 895     use super::*;
 896     use os::raw::c_char;
 897     use borrow::Cow::{Borrowed, Owned};
 898     use hash::{Hash, Hasher};
 899     use collections::hash_map::DefaultHasher;
 900
 901     #[test]
 902     fn c_to_rust() {
 903         let data = b"123\0";
 904         let ptr = data.as_ptr() as *const c_char;
 905         unsafe {
 906             assert_eq!(CStr::from_ptr(ptr).to_bytes(), b"123");
 907             assert_eq!(CStr::from_ptr(ptr).to_bytes_with_nul(), b"123\0");
 908         }
 909     }
 910
 911     #[test]
 912     fn simple() {
 913         let s = CString::new("1234").unwrap();
 914         assert_eq!(s.as_bytes(), b"1234");
 915         assert_eq!(s.as_bytes_with_nul(), b"1234\0");
 916     }
 917
 918     #[test]
 919     fn build_with_zero1() {
 920         assert!(CString::new(&b"\0"[..]).is_err());
 921     }
 922     #[test]
 923     fn build_with_zero2() {
 924         assert!(CString::new(vec![0]).is_err());
 925     }
 926
 927     #[test]
 928     fn build_with_zero3() {
 929         unsafe {
 930             let s = CString::from_vec_unchecked(vec![0]);
 931             assert_eq!(s.as_bytes(), b"\0");
 932         }
 933     }
 934
 935     #[test]
 936     fn formatted() {
 937         let s = CString::new(&b"abc\x01\x02\n\xE2\x80\xA6\xFF"[..]).unwrap();
 938         assert_eq!(format!("{:?}", s), r#""abc\x01\x02\n\xe2\x80\xa6\xff""#);
 939     }
 940
 941     #[test]
 942     fn borrowed() {
 943         unsafe {
 944             let s = CStr::from_ptr(b"12\0".as_ptr() as *const _);
 945             assert_eq!(s.to_bytes(), b"12");
 946             assert_eq!(s.to_bytes_with_nul(), b"12\0");
 947         }
 948     }
 949
 950     #[test]
 951     fn to_str() {
 952         let data = b"123\xE2\x80\xA6\0";
 953         let ptr = data.as_ptr() as *const c_char;
 954         unsafe {
 955             assert_eq!(CStr::from_ptr(ptr).to_str(), Ok("123…"));
 956             assert_eq!(CStr::from_ptr(ptr).to_string_lossy(), Borrowed("123…"));
 957         }
 958         let data = b"123\xE2\0";
 959         let ptr = data.as_ptr() as *const c_char;
 960         unsafe {
 961             assert!(CStr::from_ptr(ptr).to_str().is_err());
 962             assert_eq!(CStr::from_ptr(ptr).to_string_lossy(), Owned::<str>(format!("123\u{FFFD}")));
 963         }
 964     }
 965
 966     #[test]
 967     fn to_owned() {
 968         let data = b"123\0";
 969         let ptr = data.as_ptr() as *const c_char;
 970
 971         let owned = unsafe { CStr::from_ptr(ptr).to_owned() };
 972         assert_eq!(owned.as_bytes_with_nul(), data);
 973     }
 974
 975     #[test]
 976     fn equal_hash() {
 977         let data = b"123\xE2\xFA\xA6\0";
 978         let ptr = data.as_ptr() as *const c_char;
 979         let cstr: &'static CStr = unsafe { CStr::from_ptr(ptr) };
 980
 981         let mut s = DefaultHasher::new();
 982         cstr.hash(&mut s);
 983         let cstr_hash = s.finish();
 984         let mut s = DefaultHasher::new();
 985         CString::new(&data[..data.len() - 1]).unwrap().hash(&mut s);
 986         let cstring_hash = s.finish();
 987
 988         assert_eq!(cstr_hash, cstring_hash);
 989     }
 990
 991     #[test]
 992     fn from_bytes_with_nul() {
 993         let data = b"123\0";
 994         let cstr = CStr::from_bytes_with_nul(data);
 995         assert_eq!(cstr.map(CStr::to_bytes), Ok(&b"123"[..]));
 996         let cstr = CStr::from_bytes_with_nul(data);
 997         assert_eq!(cstr.map(CStr::to_bytes_with_nul), Ok(&b"123\0"[..]));
 998
 999         unsafe {
1000             let cstr = CStr::from_bytes_with_nul(data);
1001             let cstr_unchecked = CStr::from_bytes_with_nul_unchecked(data);
1002             assert_eq!(cstr, Ok(cstr_unchecked));
1003         }
1004     }
1005
1006     #[test]
1007     fn from_bytes_with_nul_unterminated() {
1008         let data = b"123";
1009         let cstr = CStr::from_bytes_with_nul(data);
1010         assert!(cstr.is_err());
1011     }
1012
1013     #[test]
1014     fn from_bytes_with_nul_interior() {
1015         let data = b"1\023\0";
1016         let cstr = CStr::from_bytes_with_nul(data);
1017         assert!(cstr.is_err());
1018     }
1019
1020     #[test]
1021     fn into_boxed() {
1022         let orig: &[u8] = b"Hello, world!\0";
1023         let cstr = CStr::from_bytes_with_nul(orig).unwrap();
1024         let boxed: Box<CStr> = Box::from(cstr);
1025         let cstring = cstr.to_owned().into_boxed_c_str().into_c_string();
1026         assert_eq!(cstr, &*boxed);
1027         assert_eq!(&*boxed, &*cstring);
1028         assert_eq!(&*cstring, cstr);
1029     }
1030
1031     #[test]
1032     fn boxed_default() {
1033         let boxed = <Box<CStr>>::default();
1034         assert_eq!(boxed.to_bytes_with_nul(), &[0]);
1035     }
1036 }