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