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. After
  34 /// being created, a `CString` predominately inherits all of its methods from
  35 /// the `Deref` implementation to `[c_char]`. Note that the underlying array
  36 /// is represented as an array of `c_char` as opposed to `u8`. A `u8` slice
  37 /// can be obtained with the `as_bytes` method.  Slices produced from a `CString`
  38 /// do *not* contain the trailing nul terminator unless otherwise specified.
  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 /// # Examples
  90 ///
  91 /// Inspecting a foreign C string
  92 ///
  93 /// ```no_run
  94 /// use std::ffi::CStr;
  95 /// use std::os::raw::c_char;
  96 ///
  97 /// extern { fn my_string() -> *const c_char; }
  98 ///
  99 /// unsafe {
 100 ///     let slice = CStr::from_ptr(my_string());
 101 ///     println!("string length: {}", slice.to_bytes().len());
 102 /// }
 103 /// ```
 104 ///
 105 /// Passing a Rust-originating C string
 106 ///
 107 /// ```no_run
 108 /// use std::ffi::{CString, CStr};
 109 /// use std::os::raw::c_char;
 110 ///
 111 /// fn work(data: &CStr) {
 112 ///     extern { fn work_with(data: *const c_char); }
 113 ///
 114 ///     unsafe { work_with(data.as_ptr()) }
 115 /// }
 116 ///
 117 /// let s = CString::new("data data data data").unwrap();
 118 /// work(&s);
 119 /// ```
 120 ///
 121 /// Converting a foreign C string into a Rust `String`
 122 ///
 123 /// ```no_run
 124 /// use std::ffi::CStr;
 125 /// use std::os::raw::c_char;
 126 ///
 127 /// extern { fn my_string() -> *const c_char; }
 128 ///
 129 /// fn my_string_safe() -> String {
 130 ///     unsafe {
 131 ///         CStr::from_ptr(my_string()).to_string_lossy().into_owned()
 132 ///     }
 133 /// }
 134 ///
 135 /// println!("string: {}", my_string_safe());
 136 /// ```
 137 #[derive(Hash)]
 138 #[stable(feature = "rust1", since = "1.0.0")]
 139 pub struct CStr {
 140     // FIXME: this should not be represented with a DST slice but rather with
 141     //        just a raw `c_char` along with some form of marker to make
 142     //        this an unsized type. Essentially `sizeof(&CStr)` should be the
 143     //        same as `sizeof(&c_char)` but `CStr` should be an unsized type.
 144     inner: [c_char]
 145 }
 146
 147 /// An error returned from `CString::new` to indicate that a nul byte was found
 148 /// in the vector provided.
 149 #[derive(Clone, PartialEq, Eq, Debug)]
 150 #[stable(feature = "rust1", since = "1.0.0")]
 151 pub struct NulError(usize, Vec<u8>);
 152
 153 /// An error returned from `CStr::from_bytes_with_nul` to indicate that a nul
 154 /// byte was found too early in the slice provided or one wasn't found at all.
 155 #[derive(Clone, PartialEq, Eq, Debug)]
 156 #[stable(feature = "cstr_from_bytes", since = "1.10.0")]
 157 pub struct FromBytesWithNulError { _a: () }
 158
 159 /// An error returned from `CString::into_string` to indicate that a UTF-8 error
 160 /// was encountered during the conversion.
 161 #[derive(Clone, PartialEq, Eq, Debug)]
 162 #[stable(feature = "cstring_into", since = "1.7.0")]
 163 pub struct IntoStringError {
 164     inner: CString,
 165     error: Utf8Error,
 166 }
 167
 168 impl CString {
 169     /// Creates a new C-compatible string from a container of bytes.
 170     ///
 171     /// This method will consume the provided data and use the underlying bytes
 172     /// to construct a new string, ensuring that there is a trailing 0 byte.
 173     ///
 174     /// # Examples
 175     ///
 176     /// ```no_run
 177     /// use std::ffi::CString;
 178     /// use std::os::raw::c_char;
 179     ///
 180     /// extern { fn puts(s: *const c_char); }
 181     ///
 182     /// let to_print = CString::new("Hello!").unwrap();
 183     /// unsafe {
 184     ///     puts(to_print.as_ptr());
 185     /// }
 186     /// ```
 187     ///
 188     /// # Errors
 189     ///
 190     /// This function will return an error if the bytes yielded contain an
 191     /// internal 0 byte. The error returned will contain the bytes as well as
 192     /// the position of the nul byte.
 193     #[stable(feature = "rust1", since = "1.0.0")]
 194     pub fn new<T: Into<Vec<u8>>>(t: T) -> Result<CString, NulError> {
 195         Self::_new(t.into())
 196     }
 197
 198     fn _new(bytes: Vec<u8>) -> Result<CString, NulError> {
 199         match memchr::memchr(0, &bytes) {
 200             Some(i) => Err(NulError(i, bytes)),
 201             None => Ok(unsafe { CString::from_vec_unchecked(bytes) }),
 202         }
 203     }
 204
 205     /// Creates a C-compatible string from a byte vector without checking for
 206     /// interior 0 bytes.
 207     ///
 208     /// This method is equivalent to `new` except that no runtime assertion
 209     /// is made that `v` contains no 0 bytes, and it requires an actual
 210     /// byte vector, not anything that can be converted to one with Into.
 211     ///
 212     /// # Examples
 213     ///
 214     /// ```
 215     /// use std::ffi::CString;
 216     ///
 217     /// let raw = b"foo".to_vec();
 218     /// unsafe {
 219     ///     let c_string = CString::from_vec_unchecked(raw);
 220     /// }
 221     /// ```
 222     #[stable(feature = "rust1", since = "1.0.0")]
 223     pub unsafe fn from_vec_unchecked(mut v: Vec<u8>) -> CString {
 224         v.reserve_exact(1);
 225         v.push(0);
 226         CString { inner: v.into_boxed_slice() }
 227     }
 228
 229     /// Retakes ownership of a `CString` that was transferred to C.
 230     ///
 231     /// Additionally, the length of the string will be recalculated from the pointer.
 232     ///
 233     /// # Safety
 234     ///
 235     /// This should only ever be called with a pointer that was earlier
 236     /// obtained by calling `into_raw` on a `CString`. Other usage (e.g. trying to take
 237     /// ownership of a string that was allocated by foreign code) is likely to lead
 238     /// to undefined behavior or allocator corruption.
 239     #[stable(feature = "cstr_memory", since = "1.4.0")]
 240     pub unsafe fn from_raw(ptr: *mut c_char) -> CString {
 241         let len = libc::strlen(ptr) + 1; // Including the NUL byte
 242         let slice = slice::from_raw_parts(ptr, len as usize);
 243         CString { inner: mem::transmute(slice) }
 244     }
 245
 246     /// Transfers ownership of the string to a C caller.
 247     ///
 248     /// The pointer must be returned to Rust and reconstituted using
 249     /// `from_raw` to be properly deallocated. Specifically, one
 250     /// should *not* use the standard C `free` function to deallocate
 251     /// this string.
 252     ///
 253     /// Failure to call `from_raw` will lead to a memory leak.
 254     #[stable(feature = "cstr_memory", since = "1.4.0")]
 255     pub fn into_raw(self) -> *mut c_char {
 256         Box::into_raw(self.into_inner()) as *mut c_char
 257     }
 258
 259     /// Converts the `CString` into a `String` if it contains valid Unicode data.
 260     ///
 261     /// On failure, ownership of the original `CString` is returned.
 262     #[stable(feature = "cstring_into", since = "1.7.0")]
 263     pub fn into_string(self) -> Result<String, IntoStringError> {
 264         String::from_utf8(self.into_bytes())
 265             .map_err(|e| IntoStringError {
 266                 error: e.utf8_error(),
 267                 inner: unsafe { CString::from_vec_unchecked(e.into_bytes()) },
 268             })
 269     }
 270
 271     /// Returns the underlying byte buffer.
 272     ///
 273     /// The returned buffer does **not** contain the trailing nul separator and
 274     /// it is guaranteed to not have any interior nul bytes.
 275     #[stable(feature = "cstring_into", since = "1.7.0")]
 276     pub fn into_bytes(self) -> Vec<u8> {
 277         let mut vec = self.into_inner().into_vec();
 278         let _nul = vec.pop();
 279         debug_assert_eq!(_nul, Some(0u8));
 280         vec
 281     }
 282
 283     /// Equivalent to the `into_bytes` function except that the returned vector
 284     /// includes the trailing nul byte.
 285     #[stable(feature = "cstring_into", since = "1.7.0")]
 286     pub fn into_bytes_with_nul(self) -> Vec<u8> {
 287         self.into_inner().into_vec()
 288     }
 289
 290     /// Returns the contents of this `CString` as a slice of bytes.
 291     ///
 292     /// The returned slice does **not** contain the trailing nul separator and
 293     /// it is guaranteed to not have any interior nul bytes.
 294     #[stable(feature = "rust1", since = "1.0.0")]
 295     pub fn as_bytes(&self) -> &[u8] {
 296         &self.inner[..self.inner.len() - 1]
 297     }
 298
 299     /// Equivalent to the `as_bytes` function except that the returned slice
 300     /// includes the trailing nul byte.
 301     #[stable(feature = "rust1", since = "1.0.0")]
 302     pub fn as_bytes_with_nul(&self) -> &[u8] {
 303         &self.inner
 304     }
 305
 306     /// Converts this `CString` into a boxed `CStr`.
 307     #[unstable(feature = "into_boxed_c_str", issue = "0")]
 308     pub fn into_boxed_c_str(self) -> Box<CStr> {
 309         unsafe { mem::transmute(self.into_inner()) }
 310     }
 311
 312     // Bypass "move out of struct which implements `Drop` trait" restriction.
 313     fn into_inner(self) -> Box<[u8]> {
 314         unsafe {
 315             let result = ptr::read(&self.inner);
 316             mem::forget(self);
 317             result
 318         }
 319     }
 320 }
 321
 322 // Turns this `CString` into an empty string to prevent
 323 // memory unsafe code from working by accident. Inline
 324 // to prevent LLVM from optimizing it away in debug builds.
 325 #[stable(feature = "cstring_drop", since = "1.13.0")]
 326 impl Drop for CString {
 327     #[inline]
 328     fn drop(&mut self) {
 329         unsafe { *self.inner.get_unchecked_mut(0) = 0; }
 330     }
 331 }
 332
 333 #[stable(feature = "rust1", since = "1.0.0")]
 334 impl ops::Deref for CString {
 335     type Target = CStr;
 336
 337     fn deref(&self) -> &CStr {
 338         unsafe { mem::transmute(self.as_bytes_with_nul()) }
 339     }
 340 }
 341
 342 #[stable(feature = "rust1", since = "1.0.0")]
 343 impl fmt::Debug for CString {
 344     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 345         fmt::Debug::fmt(&**self, f)
 346     }
 347 }
 348
 349 #[stable(feature = "cstring_into", since = "1.7.0")]
 350 impl From<CString> for Vec<u8> {
 351     fn from(s: CString) -> Vec<u8> {
 352         s.into_bytes()
 353     }
 354 }
 355
 356 #[stable(feature = "cstr_debug", since = "1.3.0")]
 357 impl fmt::Debug for CStr {
 358     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 359         write!(f, "\"")?;
 360         for byte in self.to_bytes().iter().flat_map(|&b| ascii::escape_default(b)) {
 361             f.write_char(byte as char)?;
 362         }
 363         write!(f, "\"")
 364     }
 365 }
 366
 367 #[stable(feature = "cstr_default", since = "1.10.0")]
 368 impl<'a> Default for &'a CStr {
 369     fn default() -> &'a CStr {
 370         static SLICE: &'static [c_char] = &[0];
 371         unsafe { CStr::from_ptr(SLICE.as_ptr()) }
 372     }
 373 }
 374
 375 #[stable(feature = "cstr_default", since = "1.10.0")]
 376 impl Default for CString {
 377     /// Creates an empty `CString`.
 378     fn default() -> CString {
 379         let a: &CStr = Default::default();
 380         a.to_owned()
 381     }
 382 }
 383
 384 #[stable(feature = "cstr_borrow", since = "1.3.0")]
 385 impl Borrow<CStr> for CString {
 386     fn borrow(&self) -> &CStr { self }
 387 }
 388
 389 #[stable(feature = "box_from_c_str", since = "1.17.0")]
 390 impl<'a> From<&'a CStr> for Box<CStr> {
 391     fn from(s: &'a CStr) -> Box<CStr> {
 392         let boxed: Box<[u8]> = Box::from(s.to_bytes_with_nul());
 393         unsafe { mem::transmute(boxed) }
 394     }
 395 }
 396
 397 #[stable(feature = "default_box_extra", since = "1.17.0")]
 398 impl Default for Box<CStr> {
 399     fn default() -> Box<CStr> {
 400         let boxed: Box<[u8]> = Box::from([0]);
 401         unsafe { mem::transmute(boxed) }
 402     }
 403 }
 404
 405 impl NulError {
 406     /// Returns the position of the nul byte in the slice that was provided to
 407     /// `CString::new`.
 408     ///
 409     /// # Examples
 410     ///
 411     /// ```
 412     /// use std::ffi::CString;
 413     ///
 414     /// let nul_error = CString::new("foo\0bar").unwrap_err();
 415     /// assert_eq!(nul_error.nul_position(), 3);
 416     ///
 417     /// let nul_error = CString::new("foo bar\0").unwrap_err();
 418     /// assert_eq!(nul_error.nul_position(), 7);
 419     /// ```
 420     #[stable(feature = "rust1", since = "1.0.0")]
 421     pub fn nul_position(&self) -> usize { self.0 }
 422
 423     /// Consumes this error, returning the underlying vector of bytes which
 424     /// generated the error in the first place.
 425     ///
 426     /// # Examples
 427     ///
 428     /// ```
 429     /// use std::ffi::CString;
 430     ///
 431     /// let nul_error = CString::new("foo\0bar").unwrap_err();
 432     /// assert_eq!(nul_error.into_vec(), b"foo\0bar");
 433     /// ```
 434     #[stable(feature = "rust1", since = "1.0.0")]
 435     pub fn into_vec(self) -> Vec<u8> { self.1 }
 436 }
 437
 438 #[stable(feature = "rust1", since = "1.0.0")]
 439 impl Error for NulError {
 440     fn description(&self) -> &str { "nul byte found in data" }
 441 }
 442
 443 #[stable(feature = "rust1", since = "1.0.0")]
 444 impl fmt::Display for NulError {
 445     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 446         write!(f, "nul byte found in provided data at position: {}", self.0)
 447     }
 448 }
 449
 450 #[stable(feature = "rust1", since = "1.0.0")]
 451 impl From<NulError> for io::Error {
 452     fn from(_: NulError) -> io::Error {
 453         io::Error::new(io::ErrorKind::InvalidInput,
 454                        "data provided contains a nul byte")
 455     }
 456 }
 457
 458 impl IntoStringError {
 459     /// Consumes this error, returning original `CString` which generated the
 460     /// error.
 461     #[stable(feature = "cstring_into", since = "1.7.0")]
 462     pub fn into_cstring(self) -> CString {
 463         self.inner
 464     }
 465
 466     /// Access the underlying UTF-8 error that was the cause of this error.
 467     #[stable(feature = "cstring_into", since = "1.7.0")]
 468     pub fn utf8_error(&self) -> Utf8Error {
 469         self.error
 470     }
 471 }
 472
 473 #[stable(feature = "cstring_into", since = "1.7.0")]
 474 impl Error for IntoStringError {
 475     fn description(&self) -> &str {
 476         "C string contained non-utf8 bytes"
 477     }
 478
 479     fn cause(&self) -> Option<&Error> {
 480         Some(&self.error)
 481     }
 482 }
 483
 484 #[stable(feature = "cstring_into", since = "1.7.0")]
 485 impl fmt::Display for IntoStringError {
 486     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 487         self.description().fmt(f)
 488     }
 489 }
 490
 491 impl CStr {
 492     /// Casts a raw C string to a safe C string wrapper.
 493     ///
 494     /// This function will cast the provided `ptr` to the `CStr` wrapper which
 495     /// allows inspection and interoperation of non-owned C strings. This method
 496     /// is unsafe for a number of reasons:
 497     ///
 498     /// * There is no guarantee to the validity of `ptr`
 499     /// * The returned lifetime is not guaranteed to be the actual lifetime of
 500     ///   `ptr`
 501     /// * There is no guarantee that the memory pointed to by `ptr` contains a
 502     ///   valid nul terminator byte at the end of the string.
 503     ///
 504     /// > **Note**: This operation is intended to be a 0-cost cast but it is
 505     /// > currently implemented with an up-front calculation of the length of
 506     /// > the string. This is not guaranteed to always be the case.
 507     ///
 508     /// # Examples
 509     ///
 510     /// ```no_run
 511     /// # fn main() {
 512     /// use std::ffi::CStr;
 513     /// use std::os::raw::c_char;
 514     ///
 515     /// extern {
 516     ///     fn my_string() -> *const c_char;
 517     /// }
 518     ///
 519     /// unsafe {
 520     ///     let slice = CStr::from_ptr(my_string());
 521     ///     println!("string returned: {}", slice.to_str().unwrap());
 522     /// }
 523     /// # }
 524     /// ```
 525     #[stable(feature = "rust1", since = "1.0.0")]
 526     pub unsafe fn from_ptr<'a>(ptr: *const c_char) -> &'a CStr {
 527         let len = libc::strlen(ptr);
 528         mem::transmute(slice::from_raw_parts(ptr, len as usize + 1))
 529     }
 530
 531     /// Creates a C string wrapper from a byte slice.
 532     ///
 533     /// This function will cast the provided `bytes` to a `CStr` wrapper after
 534     /// ensuring that it is null terminated and does not contain any interior
 535     /// nul bytes.
 536     ///
 537     /// # Examples
 538     ///
 539     /// ```
 540     /// use std::ffi::CStr;
 541     ///
 542     /// let cstr = CStr::from_bytes_with_nul(b"hello\0");
 543     /// assert!(cstr.is_ok());
 544     /// ```
 545     #[stable(feature = "cstr_from_bytes", since = "1.10.0")]
 546     pub fn from_bytes_with_nul(bytes: &[u8])
 547                                -> Result<&CStr, FromBytesWithNulError> {
 548         if bytes.is_empty() || memchr::memchr(0, &bytes) != Some(bytes.len() - 1) {
 549             Err(FromBytesWithNulError { _a: () })
 550         } else {
 551             Ok(unsafe { Self::from_bytes_with_nul_unchecked(bytes) })
 552         }
 553     }
 554
 555     /// Unsafely creates a C string wrapper from a byte slice.
 556     ///
 557     /// This function will cast the provided `bytes` to a `CStr` wrapper without
 558     /// performing any sanity checks. The provided slice must be null terminated
 559     /// and not contain any interior nul bytes.
 560     ///
 561     /// # Examples
 562     ///
 563     /// ```
 564     /// use std::ffi::{CStr, CString};
 565     ///
 566     /// unsafe {
 567     ///     let cstring = CString::new("hello").unwrap();
 568     ///     let cstr = CStr::from_bytes_with_nul_unchecked(cstring.to_bytes_with_nul());
 569     ///     assert_eq!(cstr, &*cstring);
 570     /// }
 571     /// ```
 572     #[stable(feature = "cstr_from_bytes", since = "1.10.0")]
 573     pub unsafe fn from_bytes_with_nul_unchecked(bytes: &[u8]) -> &CStr {
 574         mem::transmute(bytes)
 575     }
 576
 577     /// Returns the inner pointer to this C string.
 578     ///
 579     /// The returned pointer will be valid for as long as `self` is and points
 580     /// to a contiguous region of memory terminated with a 0 byte to represent
 581     /// the end of the string.
 582     ///
 583     /// **WARNING**
 584     ///
 585     /// It is your responsibility to make sure that the underlying memory is not
 586     /// freed too early. For example, the following code will cause undefined
 587     /// behaviour when `ptr` is used inside the `unsafe` block:
 588     ///
 589     /// ```no_run
 590     /// use std::ffi::{CString};
 591     ///
 592     /// let ptr = CString::new("Hello").unwrap().as_ptr();
 593     /// unsafe {
 594     ///     // `ptr` is dangling
 595     ///     *ptr;
 596     /// }
 597     /// ```
 598     ///
 599     /// This happens because the pointer returned by `as_ptr` does not carry any
 600     /// lifetime information and the string is deallocated immediately after
 601     /// the `CString::new("Hello").unwrap().as_ptr()` expression is evaluated.
 602     /// To fix the problem, bind the string to a local variable:
 603     ///
 604     /// ```no_run
 605     /// use std::ffi::{CString};
 606     ///
 607     /// let hello = CString::new("Hello").unwrap();
 608     /// let ptr = hello.as_ptr();
 609     /// unsafe {
 610     ///     // `ptr` is valid because `hello` is in scope
 611     ///     *ptr;
 612     /// }
 613     /// ```
 614     #[stable(feature = "rust1", since = "1.0.0")]
 615     pub fn as_ptr(&self) -> *const c_char {
 616         self.inner.as_ptr()
 617     }
 618
 619     /// Converts this C string to a byte slice.
 620     ///
 621     /// This function will calculate the length of this string (which normally
 622     /// requires a linear amount of work to be done) and then return the
 623     /// resulting slice of `u8` elements.
 624     ///
 625     /// The returned slice will **not** contain the trailing nul that this C
 626     /// string has.
 627     ///
 628     /// > **Note**: This method is currently implemented as a 0-cost cast, but
 629     /// > it is planned to alter its definition in the future to perform the
 630     /// > length calculation whenever this method is called.
 631     #[stable(feature = "rust1", since = "1.0.0")]
 632     pub fn to_bytes(&self) -> &[u8] {
 633         let bytes = self.to_bytes_with_nul();
 634         &bytes[..bytes.len() - 1]
 635     }
 636
 637     /// Converts this C string to a byte slice containing the trailing 0 byte.
 638     ///
 639     /// This function is the equivalent of `to_bytes` except that it will retain
 640     /// the trailing nul instead of chopping it off.
 641     ///
 642     /// > **Note**: This method is currently implemented as a 0-cost cast, but
 643     /// > it is planned to alter its definition in the future to perform the
 644     /// > length calculation whenever this method is called.
 645     #[stable(feature = "rust1", since = "1.0.0")]
 646     pub fn to_bytes_with_nul(&self) -> &[u8] {
 647         unsafe { mem::transmute(&self.inner) }
 648     }
 649
 650     /// Yields a `&str` slice if the `CStr` contains valid UTF-8.
 651     ///
 652     /// This function will calculate the length of this string and check for
 653     /// UTF-8 validity, and then return the `&str` if it's valid.
 654     ///
 655     /// > **Note**: This method is currently implemented to check for validity
 656     /// > after a 0-cost cast, but it is planned to alter its definition in the
 657     /// > future to perform the length calculation in addition to the UTF-8
 658     /// > check whenever this method is called.
 659     #[stable(feature = "cstr_to_str", since = "1.4.0")]
 660     pub fn to_str(&self) -> Result<&str, str::Utf8Error> {
 661         // NB: When CStr is changed to perform the length check in .to_bytes()
 662         // instead of in from_ptr(), it may be worth considering if this should
 663         // be rewritten to do the UTF-8 check inline with the length calculation
 664         // instead of doing it afterwards.
 665         str::from_utf8(self.to_bytes())
 666     }
 667
 668     /// Converts a `CStr` into a `Cow<str>`.
 669     ///
 670     /// This function will calculate the length of this string (which normally
 671     /// requires a linear amount of work to be done) and then return the
 672     /// resulting slice as a `Cow<str>`, replacing any invalid UTF-8 sequences
 673     /// with `U+FFFD REPLACEMENT CHARACTER`.
 674     ///
 675     /// > **Note**: This method is currently implemented to check for validity
 676     /// > after a 0-cost cast, but it is planned to alter its definition in the
 677     /// > future to perform the length calculation in addition to the UTF-8
 678     /// > check whenever this method is called.
 679     #[stable(feature = "cstr_to_str", since = "1.4.0")]
 680     pub fn to_string_lossy(&self) -> Cow<str> {
 681         String::from_utf8_lossy(self.to_bytes())
 682     }
 683 }
 684
 685 #[stable(feature = "rust1", since = "1.0.0")]
 686 impl PartialEq for CStr {
 687     fn eq(&self, other: &CStr) -> bool {
 688         self.to_bytes().eq(other.to_bytes())
 689     }
 690 }
 691 #[stable(feature = "rust1", since = "1.0.0")]
 692 impl Eq for CStr {}
 693 #[stable(feature = "rust1", since = "1.0.0")]
 694 impl PartialOrd for CStr {
 695     fn partial_cmp(&self, other: &CStr) -> Option<Ordering> {
 696         self.to_bytes().partial_cmp(&other.to_bytes())
 697     }
 698 }
 699 #[stable(feature = "rust1", since = "1.0.0")]
 700 impl Ord for CStr {
 701     fn cmp(&self, other: &CStr) -> Ordering {
 702         self.to_bytes().cmp(&other.to_bytes())
 703     }
 704 }
 705
 706 #[stable(feature = "cstr_borrow", since = "1.3.0")]
 707 impl ToOwned for CStr {
 708     type Owned = CString;
 709
 710     fn to_owned(&self) -> CString {
 711         CString { inner: self.to_bytes_with_nul().into() }
 712     }
 713 }
 714
 715 #[stable(feature = "cstring_asref", since = "1.7.0")]
 716 impl<'a> From<&'a CStr> for CString {
 717     fn from(s: &'a CStr) -> CString {
 718         s.to_owned()
 719     }
 720 }
 721
 722 #[stable(feature = "cstring_asref", since = "1.7.0")]
 723 impl ops::Index<ops::RangeFull> for CString {
 724     type Output = CStr;
 725
 726     #[inline]
 727     fn index(&self, _index: ops::RangeFull) -> &CStr {
 728         self
 729     }
 730 }
 731
 732 #[stable(feature = "cstring_asref", since = "1.7.0")]
 733 impl AsRef<CStr> for CStr {
 734     fn as_ref(&self) -> &CStr {
 735         self
 736     }
 737 }
 738
 739 #[stable(feature = "cstring_asref", since = "1.7.0")]
 740 impl AsRef<CStr> for CString {
 741     fn as_ref(&self) -> &CStr {
 742         self
 743     }
 744 }
 745
 746 #[cfg(test)]
 747 mod tests {
 748     use super::*;
 749     use os::raw::c_char;
 750     use borrow::Cow::{Borrowed, Owned};
 751     use hash::{Hash, Hasher};
 752     use collections::hash_map::DefaultHasher;
 753
 754     #[test]
 755     fn c_to_rust() {
 756         let data = b"123\0";
 757         let ptr = data.as_ptr() as *const c_char;
 758         unsafe {
 759             assert_eq!(CStr::from_ptr(ptr).to_bytes(), b"123");
 760             assert_eq!(CStr::from_ptr(ptr).to_bytes_with_nul(), b"123\0");
 761         }
 762     }
 763
 764     #[test]
 765     fn simple() {
 766         let s = CString::new("1234").unwrap();
 767         assert_eq!(s.as_bytes(), b"1234");
 768         assert_eq!(s.as_bytes_with_nul(), b"1234\0");
 769     }
 770
 771     #[test]
 772     fn build_with_zero1() {
 773         assert!(CString::new(&b"\0"[..]).is_err());
 774     }
 775     #[test]
 776     fn build_with_zero2() {
 777         assert!(CString::new(vec![0]).is_err());
 778     }
 779
 780     #[test]
 781     fn build_with_zero3() {
 782         unsafe {
 783             let s = CString::from_vec_unchecked(vec![0]);
 784             assert_eq!(s.as_bytes(), b"\0");
 785         }
 786     }
 787
 788     #[test]
 789     fn formatted() {
 790         let s = CString::new(&b"abc\x01\x02\n\xE2\x80\xA6\xFF"[..]).unwrap();
 791         assert_eq!(format!("{:?}", s), r#""abc\x01\x02\n\xe2\x80\xa6\xff""#);
 792     }
 793
 794     #[test]
 795     fn borrowed() {
 796         unsafe {
 797             let s = CStr::from_ptr(b"12\0".as_ptr() as *const _);
 798             assert_eq!(s.to_bytes(), b"12");
 799             assert_eq!(s.to_bytes_with_nul(), b"12\0");
 800         }
 801     }
 802
 803     #[test]
 804     fn to_str() {
 805         let data = b"123\xE2\x80\xA6\0";
 806         let ptr = data.as_ptr() as *const c_char;
 807         unsafe {
 808             assert_eq!(CStr::from_ptr(ptr).to_str(), Ok("123…"));
 809             assert_eq!(CStr::from_ptr(ptr).to_string_lossy(), Borrowed("123…"));
 810         }
 811         let data = b"123\xE2\0";
 812         let ptr = data.as_ptr() as *const c_char;
 813         unsafe {
 814             assert!(CStr::from_ptr(ptr).to_str().is_err());
 815             assert_eq!(CStr::from_ptr(ptr).to_string_lossy(), Owned::<str>(format!("123\u{FFFD}")));
 816         }
 817     }
 818
 819     #[test]
 820     fn to_owned() {
 821         let data = b"123\0";
 822         let ptr = data.as_ptr() as *const c_char;
 823
 824         let owned = unsafe { CStr::from_ptr(ptr).to_owned() };
 825         assert_eq!(owned.as_bytes_with_nul(), data);
 826     }
 827
 828     #[test]
 829     fn equal_hash() {
 830         let data = b"123\xE2\xFA\xA6\0";
 831         let ptr = data.as_ptr() as *const c_char;
 832         let cstr: &'static CStr = unsafe { CStr::from_ptr(ptr) };
 833
 834         let mut s = DefaultHasher::new();
 835         cstr.hash(&mut s);
 836         let cstr_hash = s.finish();
 837         let mut s = DefaultHasher::new();
 838         CString::new(&data[..data.len() - 1]).unwrap().hash(&mut s);
 839         let cstring_hash = s.finish();
 840
 841         assert_eq!(cstr_hash, cstring_hash);
 842     }
 843
 844     #[test]
 845     fn from_bytes_with_nul() {
 846         let data = b"123\0";
 847         let cstr = CStr::from_bytes_with_nul(data);
 848         assert_eq!(cstr.map(CStr::to_bytes), Ok(&b"123"[..]));
 849         let cstr = CStr::from_bytes_with_nul(data);
 850         assert_eq!(cstr.map(CStr::to_bytes_with_nul), Ok(&b"123\0"[..]));
 851
 852         unsafe {
 853             let cstr = CStr::from_bytes_with_nul(data);
 854             let cstr_unchecked = CStr::from_bytes_with_nul_unchecked(data);
 855             assert_eq!(cstr, Ok(cstr_unchecked));
 856         }
 857     }
 858
 859     #[test]
 860     fn from_bytes_with_nul_unterminated() {
 861         let data = b"123";
 862         let cstr = CStr::from_bytes_with_nul(data);
 863         assert!(cstr.is_err());
 864     }
 865
 866     #[test]
 867     fn from_bytes_with_nul_interior() {
 868         let data = b"1\023\0";
 869         let cstr = CStr::from_bytes_with_nul(data);
 870         assert!(cstr.is_err());
 871     }
 872
 873     #[test]
 874     fn into_boxed() {
 875         let orig: &[u8] = b"Hello, world!\0";
 876         let cstr = CStr::from_bytes_with_nul(orig).unwrap();
 877         let cstring = cstr.to_owned();
 878         let box1: Box<CStr> = Box::from(cstr);
 879         let box2 = cstring.into_boxed_c_str();
 880         assert_eq!(cstr, &*box1);
 881         assert_eq!(box1, box2);
 882         assert_eq!(&*box2, cstr);
 883     }
 884
 885     #[test]
 886     fn boxed_default() {
 887         let boxed = <Box<CStr>>::default();
 888         assert_eq!(boxed.to_bytes_with_nul(), &[0]);
 889     }
 890 }