src/librustrt/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 /*!
  12
  13 C-string manipulation and management
  14
  15 This modules provides the basic methods for creating and manipulating
  16 null-terminated strings for use with FFI calls (back to C). Most C APIs require
  17 that the string being passed to them is null-terminated, and by default rust's
  18 string types are *not* null terminated.
  19
  20 The other problem with translating Rust strings to C strings is that Rust
  21 strings can validly contain a null-byte in the middle of the string (0 is a
  22 valid unicode codepoint). This means that not all Rust strings can actually be
  23 translated to C strings.
  24
  25 # Creation of a C string
  26
  27 A C string is managed through the `CString` type defined in this module. It
  28 "owns" the internal buffer of characters and will automatically deallocate the
  29 buffer when the string is dropped. The `ToCStr` trait is implemented for `&str`
  30 and `&[u8]`, but the conversions can fail due to some of the limitations
  31 explained above.
  32
  33 This also means that currently whenever a C string is created, an allocation
  34 must be performed to place the data elsewhere (the lifetime of the C string is
  35 not tied to the lifetime of the original string/data buffer). If C strings are
  36 heavily used in applications, then caching may be advisable to prevent
  37 unnecessary amounts of allocations.
  38
  39 An example of creating and using a C string would be:
  40
  41 ```rust
  42 extern crate libc;
  43
  44 extern {
  45     fn puts(s: *const libc::c_char);
  46 }
  47
  48 fn main() {
  49     let my_string = "Hello, world!";
  50
  51     // Allocate the C string with an explicit local that owns the string. The
  52     // `c_buffer` pointer will be deallocated when `my_c_string` goes out of scope.
  53     let my_c_string = my_string.to_c_str();
  54     unsafe {
  55         puts(my_c_string.as_ptr());
  56     }
  57
  58     // Don't save/return the pointer to the C string, the `c_buffer` will be
  59     // deallocated when this block returns!
  60     my_string.with_c_str(|c_buffer| {
  61         unsafe { puts(c_buffer); }
  62     });
  63 }
  64 ```
  65
  66 */
  67
  68 use core::prelude::*;
  69
  70 use alloc::libc_heap::malloc_raw;
  71 use collections::string::String;
  72 use core::kinds::marker;
  73 use core::mem;
  74 use core::ptr;
  75 use core::raw::Slice;
  76 use core::slice;
  77 use core::str;
  78 use libc;
  79
  80 /// The representation of a C String.
  81 ///
  82 /// This structure wraps a `*libc::c_char`, and will automatically free the
  83 /// memory it is pointing to when it goes out of scope.
  84 pub struct CString {
  85     buf: *const libc::c_char,
  86     owns_buffer_: bool,
  87 }
  88
  89 impl Clone for CString {
  90     /// Clone this CString into a new, uniquely owned CString. For safety
  91     /// reasons, this is always a deep clone, rather than the usual shallow
  92     /// clone.
  93     fn clone(&self) -> CString {
  94         if self.buf.is_null() {
  95             CString { buf: self.buf, owns_buffer_: self.owns_buffer_ }
  96         } else {
  97             let len = self.len() + 1;
  98             let buf = unsafe { malloc_raw(len) } as *mut libc::c_char;
  99             unsafe { ptr::copy_nonoverlapping_memory(buf, self.buf, len); }
 100             CString { buf: buf as *const libc::c_char, owns_buffer_: true }
 101         }
 102     }
 103 }
 104
 105 impl PartialEq for CString {
 106     fn eq(&self, other: &CString) -> bool {
 107         if self.buf as uint == other.buf as uint {
 108             true
 109         } else if self.buf.is_null() || other.buf.is_null() {
 110             false
 111         } else {
 112             unsafe {
 113                 libc::strcmp(self.buf, other.buf) == 0
 114             }
 115         }
 116     }
 117 }
 118
 119 impl CString {
 120     /// Create a C String from a pointer.
 121     pub unsafe fn new(buf: *const libc::c_char, owns_buffer: bool) -> CString {
 122         CString { buf: buf, owns_buffer_: owns_buffer }
 123     }
 124
 125     /// Unwraps the wrapped `*libc::c_char` from the `CString` wrapper.
 126     ///
 127     /// The original object is destructed after this method is called, and if
 128     /// the underlying pointer was previously allocated, care must be taken to
 129     /// ensure that it is deallocated properly.
 130     pub unsafe fn unwrap(self) -> *const libc::c_char {
 131         let mut c_str = self;
 132         c_str.owns_buffer_ = false;
 133         c_str.buf
 134     }
 135
 136     /// Return a pointer to the NUL-terminated string data.
 137     ///
 138     /// `.as_ptr` returns an internal pointer into the `CString`, and
 139     /// may be invalidated when the `CString` falls out of scope (the
 140     /// destructor will run, freeing the allocation if there is
 141     /// one).
 142     ///
 143     /// ```rust
 144     /// let foo = "some string";
 145     ///
 146     /// // right
 147     /// let x = foo.to_c_str();
 148     /// let p = x.as_ptr();
 149     ///
 150     /// // wrong (the CString will be freed, invalidating `p`)
 151     /// let p = foo.to_c_str().as_ptr();
 152     /// ```
 153     ///
 154     /// # Failure
 155     ///
 156     /// Fails if the CString is null.
 157     ///
 158     /// # Example
 159     ///
 160     /// ```rust
 161     /// extern crate libc;
 162     ///
 163     /// fn main() {
 164     ///     let c_str = "foo bar".to_c_str();
 165     ///     unsafe {
 166     ///         libc::puts(c_str.as_ptr());
 167     ///     }
 168     /// }
 169     /// ```
 170     pub fn as_ptr(&self) -> *const libc::c_char {
 171         if self.buf.is_null() { fail!("CString is null!"); }
 172
 173         self.buf
 174     }
 175
 176     /// Return a mutable pointer to the NUL-terminated string data.
 177     ///
 178     /// `.as_mut_ptr` returns an internal pointer into the `CString`, and
 179     /// may be invalidated when the `CString` falls out of scope (the
 180     /// destructor will run, freeing the allocation if there is
 181     /// one).
 182     ///
 183     /// ```rust
 184     /// let foo = "some string";
 185     ///
 186     /// // right
 187     /// let mut x = foo.to_c_str();
 188     /// let p = x.as_mut_ptr();
 189     ///
 190     /// // wrong (the CString will be freed, invalidating `p`)
 191     /// let p = foo.to_c_str().as_mut_ptr();
 192     /// ```
 193     ///
 194     /// # Failure
 195     ///
 196     /// Fails if the CString is null.
 197     pub fn as_mut_ptr(&mut self) -> *mut libc::c_char {
 198         if self.buf.is_null() { fail!("CString is null!") }
 199
 200         self.buf as *mut _
 201     }
 202
 203     /// Calls a closure with a reference to the underlying `*libc::c_char`.
 204     ///
 205     /// # Failure
 206     ///
 207     /// Fails if the CString is null.
 208     #[deprecated="use `.as_ptr()`"]
 209     pub fn with_ref<T>(&self, f: |*const libc::c_char| -> T) -> T {
 210         if self.buf.is_null() { fail!("CString is null!"); }
 211         f(self.buf)
 212     }
 213
 214     /// Calls a closure with a mutable reference to the underlying `*libc::c_char`.
 215     ///
 216     /// # Failure
 217     ///
 218     /// Fails if the CString is null.
 219     #[deprecated="use `.as_mut_ptr()`"]
 220     pub fn with_mut_ref<T>(&mut self, f: |*mut libc::c_char| -> T) -> T {
 221         if self.buf.is_null() { fail!("CString is null!"); }
 222         f(self.buf as *mut libc::c_char)
 223     }
 224
 225     /// Returns true if the CString is a null.
 226     pub fn is_null(&self) -> bool {
 227         self.buf.is_null()
 228     }
 229
 230     /// Returns true if the CString is not null.
 231     pub fn is_not_null(&self) -> bool {
 232         self.buf.is_not_null()
 233     }
 234
 235     /// Returns whether or not the `CString` owns the buffer.
 236     pub fn owns_buffer(&self) -> bool {
 237         self.owns_buffer_
 238     }
 239
 240     /// Converts the CString into a `&[u8]` without copying.
 241     /// Includes the terminating NUL byte.
 242     ///
 243     /// # Failure
 244     ///
 245     /// Fails if the CString is null.
 246     #[inline]
 247     pub fn as_bytes<'a>(&'a self) -> &'a [u8] {
 248         if self.buf.is_null() { fail!("CString is null!"); }
 249         unsafe {
 250             mem::transmute(Slice { data: self.buf, len: self.len() + 1 })
 251         }
 252     }
 253
 254     /// Converts the CString into a `&[u8]` without copying.
 255     /// Does not include the terminating NUL byte.
 256     ///
 257     /// # Failure
 258     ///
 259     /// Fails if the CString is null.
 260     #[inline]
 261     pub fn as_bytes_no_nul<'a>(&'a self) -> &'a [u8] {
 262         if self.buf.is_null() { fail!("CString is null!"); }
 263         unsafe {
 264             mem::transmute(Slice { data: self.buf, len: self.len() })
 265         }
 266     }
 267
 268     /// Converts the CString into a `&str` without copying.
 269     /// Returns None if the CString is not UTF-8.
 270     ///
 271     /// # Failure
 272     ///
 273     /// Fails if the CString is null.
 274     #[inline]
 275     pub fn as_str<'a>(&'a self) -> Option<&'a str> {
 276         let buf = self.as_bytes_no_nul();
 277         str::from_utf8(buf)
 278     }
 279
 280     /// Return a CString iterator.
 281     ///
 282     /// # Failure
 283     ///
 284     /// Fails if the CString is null.
 285     pub fn iter<'a>(&'a self) -> CChars<'a> {
 286         if self.buf.is_null() { fail!("CString is null!"); }
 287         CChars {
 288             ptr: self.buf,
 289             marker: marker::ContravariantLifetime,
 290         }
 291     }
 292 }
 293
 294 impl Drop for CString {
 295     fn drop(&mut self) {
 296         if self.owns_buffer_ {
 297             unsafe {
 298                 libc::free(self.buf as *mut libc::c_void)
 299             }
 300         }
 301     }
 302 }
 303
 304 impl Collection for CString {
 305     /// Return the number of bytes in the CString (not including the NUL terminator).
 306     ///
 307     /// # Failure
 308     ///
 309     /// Fails if the CString is null.
 310     #[inline]
 311     fn len(&self) -> uint {
 312         if self.buf.is_null() { fail!("CString is null!"); }
 313         let mut cur = self.buf;
 314         let mut len = 0;
 315         unsafe {
 316             while *cur != 0 {
 317                 len += 1;
 318                 cur = cur.offset(1);
 319             }
 320         }
 321         return len;
 322     }
 323 }
 324
 325 /// A generic trait for converting a value to a CString.
 326 pub trait ToCStr {
 327     /// Copy the receiver into a CString.
 328     ///
 329     /// # Failure
 330     ///
 331     /// Fails the task if the receiver has an interior null.
 332     fn to_c_str(&self) -> CString;
 333
 334     /// Unsafe variant of `to_c_str()` that doesn't check for nulls.
 335     unsafe fn to_c_str_unchecked(&self) -> CString;
 336
 337     /// Work with a temporary CString constructed from the receiver.
 338     /// The provided `*libc::c_char` will be freed immediately upon return.
 339     ///
 340     /// # Example
 341     ///
 342     /// ```rust
 343     /// extern crate libc;
 344     ///
 345     /// fn main() {
 346     ///     let s = "PATH".with_c_str(|path| unsafe {
 347     ///         libc::getenv(path)
 348     ///     });
 349     /// }
 350     /// ```
 351     ///
 352     /// # Failure
 353     ///
 354     /// Fails the task if the receiver has an interior null.
 355     #[inline]
 356     fn with_c_str<T>(&self, f: |*const libc::c_char| -> T) -> T {
 357         let c_str = self.to_c_str();
 358         f(c_str.as_ptr())
 359     }
 360
 361     /// Unsafe variant of `with_c_str()` that doesn't check for nulls.
 362     #[inline]
 363     unsafe fn with_c_str_unchecked<T>(&self, f: |*const libc::c_char| -> T) -> T {
 364         let c_str = self.to_c_str_unchecked();
 365         f(c_str.as_ptr())
 366     }
 367 }
 368
 369 // FIXME (#12938): Until DST lands, we cannot decompose &str into &
 370 // and str, so we cannot usefully take ToCStr arguments by reference
 371 // (without forcing an additional & around &str). So we are instead
 372 // temporarily adding an instance for ~str and String, so that we can
 373 // take ToCStr as owned. When DST lands, the string instances should
 374 // be revisted, and arguments bound by ToCStr should be passed by
 375 // reference.
 376
 377 impl<'a> ToCStr for &'a str {
 378     #[inline]
 379     fn to_c_str(&self) -> CString {
 380         self.as_bytes().to_c_str()
 381     }
 382
 383     #[inline]
 384     unsafe fn to_c_str_unchecked(&self) -> CString {
 385         self.as_bytes().to_c_str_unchecked()
 386     }
 387
 388     #[inline]
 389     fn with_c_str<T>(&self, f: |*const libc::c_char| -> T) -> T {
 390         self.as_bytes().with_c_str(f)
 391     }
 392
 393     #[inline]
 394     unsafe fn with_c_str_unchecked<T>(&self, f: |*const libc::c_char| -> T) -> T {
 395         self.as_bytes().with_c_str_unchecked(f)
 396     }
 397 }
 398
 399 impl ToCStr for String {
 400     #[inline]
 401     fn to_c_str(&self) -> CString {
 402         self.as_bytes().to_c_str()
 403     }
 404
 405     #[inline]
 406     unsafe fn to_c_str_unchecked(&self) -> CString {
 407         self.as_bytes().to_c_str_unchecked()
 408     }
 409
 410     #[inline]
 411     fn with_c_str<T>(&self, f: |*const libc::c_char| -> T) -> T {
 412         self.as_bytes().with_c_str(f)
 413     }
 414
 415     #[inline]
 416     unsafe fn with_c_str_unchecked<T>(&self, f: |*const libc::c_char| -> T) -> T {
 417         self.as_bytes().with_c_str_unchecked(f)
 418     }
 419 }
 420
 421 // The length of the stack allocated buffer for `vec.with_c_str()`
 422 static BUF_LEN: uint = 128;
 423
 424 impl<'a> ToCStr for &'a [u8] {
 425     fn to_c_str(&self) -> CString {
 426         let mut cs = unsafe { self.to_c_str_unchecked() };
 427         check_for_null(*self, cs.as_mut_ptr());
 428         cs
 429     }
 430
 431     unsafe fn to_c_str_unchecked(&self) -> CString {
 432         let self_len = self.len();
 433         let buf = malloc_raw(self_len + 1);
 434
 435         ptr::copy_memory(buf, self.as_ptr(), self_len);
 436         *buf.offset(self_len as int) = 0;
 437
 438         CString::new(buf as *const libc::c_char, true)
 439     }
 440
 441     fn with_c_str<T>(&self, f: |*const libc::c_char| -> T) -> T {
 442         unsafe { with_c_str(*self, true, f) }
 443     }
 444
 445     unsafe fn with_c_str_unchecked<T>(&self, f: |*const libc::c_char| -> T) -> T {
 446         with_c_str(*self, false, f)
 447     }
 448 }
 449
 450 // Unsafe function that handles possibly copying the &[u8] into a stack array.
 451 unsafe fn with_c_str<T>(v: &[u8], checked: bool,
 452                         f: |*const libc::c_char| -> T) -> T {
 453     let c_str = if v.len() < BUF_LEN {
 454         let mut buf: [u8, .. BUF_LEN] = mem::uninitialized();
 455         slice::bytes::copy_memory(buf, v);
 456         buf[v.len()] = 0;
 457
 458         let buf = buf.as_mut_ptr();
 459         if checked {
 460             check_for_null(v, buf as *mut libc::c_char);
 461         }
 462
 463         return f(buf as *const libc::c_char)
 464     } else if checked {
 465         v.to_c_str()
 466     } else {
 467         v.to_c_str_unchecked()
 468     };
 469
 470     f(c_str.as_ptr())
 471 }
 472
 473 #[inline]
 474 fn check_for_null(v: &[u8], buf: *mut libc::c_char) {
 475     for i in range(0, v.len()) {
 476         unsafe {
 477             let p = buf.offset(i as int);
 478             assert!(*p != 0);
 479         }
 480     }
 481 }
 482
 483 /// External iterator for a CString's bytes.
 484 ///
 485 /// Use with the `std::iter` module.
 486 pub struct CChars<'a> {
 487     ptr: *const libc::c_char,
 488     marker: marker::ContravariantLifetime<'a>,
 489 }
 490
 491 impl<'a> Iterator<libc::c_char> for CChars<'a> {
 492     fn next(&mut self) -> Option<libc::c_char> {
 493         let ch = unsafe { *self.ptr };
 494         if ch == 0 {
 495             None
 496         } else {
 497             self.ptr = unsafe { self.ptr.offset(1) };
 498             Some(ch)
 499         }
 500     }
 501 }
 502
 503 /// Parses a C "multistring", eg windows env values or
 504 /// the req->ptr result in a uv_fs_readdir() call.
 505 ///
 506 /// Optionally, a `count` can be passed in, limiting the
 507 /// parsing to only being done `count`-times.
 508 ///
 509 /// The specified closure is invoked with each string that
 510 /// is found, and the number of strings found is returned.
 511 pub unsafe fn from_c_multistring(buf: *const libc::c_char,
 512                                  count: Option<uint>,
 513                                  f: |&CString|) -> uint {
 514
 515     let mut curr_ptr: uint = buf as uint;
 516     let mut ctr = 0;
 517     let (limited_count, limit) = match count {
 518         Some(limit) => (true, limit),
 519         None => (false, 0)
 520     };
 521     while ((limited_count && ctr < limit) || !limited_count)
 522           && *(curr_ptr as *const libc::c_char) != 0 as libc::c_char {
 523         let cstr = CString::new(curr_ptr as *const libc::c_char, false);
 524         f(&cstr);
 525         curr_ptr += cstr.len() + 1;
 526         ctr += 1;
 527     }
 528     return ctr;
 529 }
 530
 531 #[cfg(test)]
 532 mod tests {
 533     use std::prelude::*;
 534     use std::ptr;
 535     use std::task;
 536     use libc;
 537
 538     use super::*;
 539
 540     #[test]
 541     fn test_str_multistring_parsing() {
 542         unsafe {
 543             let input = b"zero\0one\0\0";
 544             let ptr = input.as_ptr();
 545             let expected = ["zero", "one"];
 546             let mut it = expected.iter();
 547             let result = from_c_multistring(ptr as *const libc::c_char, None, |c| {
 548                 let cbytes = c.as_bytes_no_nul();
 549                 assert_eq!(cbytes, it.next().unwrap().as_bytes());
 550             });
 551             assert_eq!(result, 2);
 552             assert!(it.next().is_none());
 553         }
 554     }
 555
 556     #[test]
 557     fn test_str_to_c_str() {
 558         let c_str = "".to_c_str();
 559         unsafe {
 560             assert_eq!(*c_str.as_ptr().offset(0), 0);
 561         }
 562
 563         let c_str = "hello".to_c_str();
 564         let buf = c_str.as_ptr();
 565         unsafe {
 566             assert_eq!(*buf.offset(0), 'h' as libc::c_char);
 567             assert_eq!(*buf.offset(1), 'e' as libc::c_char);
 568             assert_eq!(*buf.offset(2), 'l' as libc::c_char);
 569             assert_eq!(*buf.offset(3), 'l' as libc::c_char);
 570             assert_eq!(*buf.offset(4), 'o' as libc::c_char);
 571             assert_eq!(*buf.offset(5), 0);
 572         }
 573     }
 574
 575     #[test]
 576     fn test_vec_to_c_str() {
 577         let b: &[u8] = [];
 578         let c_str = b.to_c_str();
 579         unsafe {
 580             assert_eq!(*c_str.as_ptr().offset(0), 0);
 581         }
 582
 583         let c_str = b"hello".to_c_str();
 584         let buf = c_str.as_ptr();
 585         unsafe {
 586             assert_eq!(*buf.offset(0), 'h' as libc::c_char);
 587             assert_eq!(*buf.offset(1), 'e' as libc::c_char);
 588             assert_eq!(*buf.offset(2), 'l' as libc::c_char);
 589             assert_eq!(*buf.offset(3), 'l' as libc::c_char);
 590             assert_eq!(*buf.offset(4), 'o' as libc::c_char);
 591             assert_eq!(*buf.offset(5), 0);
 592         }
 593
 594         let c_str = b"foo\xFF".to_c_str();
 595         let buf = c_str.as_ptr();
 596         unsafe {
 597             assert_eq!(*buf.offset(0), 'f' as libc::c_char);
 598             assert_eq!(*buf.offset(1), 'o' as libc::c_char);
 599             assert_eq!(*buf.offset(2), 'o' as libc::c_char);
 600             assert_eq!(*buf.offset(3), 0xffu8 as i8);
 601             assert_eq!(*buf.offset(4), 0);
 602         }
 603     }
 604
 605     #[test]
 606     fn test_is_null() {
 607         let c_str = unsafe { CString::new(ptr::null(), false) };
 608         assert!(c_str.is_null());
 609         assert!(!c_str.is_not_null());
 610     }
 611
 612     #[test]
 613     fn test_unwrap() {
 614         let c_str = "hello".to_c_str();
 615         unsafe { libc::free(c_str.unwrap() as *mut libc::c_void) }
 616     }
 617
 618     #[test]
 619     fn test_as_ptr() {
 620         let c_str = "hello".to_c_str();
 621         let len = unsafe { libc::strlen(c_str.as_ptr()) };
 622         assert!(!c_str.is_null());
 623         assert!(c_str.is_not_null());
 624         assert_eq!(len, 5);
 625     }
 626     #[test]
 627     #[should_fail]
 628     fn test_as_ptr_empty_fail() {
 629         let c_str = unsafe { CString::new(ptr::null(), false) };
 630         c_str.as_ptr();
 631     }
 632
 633     #[test]
 634     fn test_iterator() {
 635         let c_str = "".to_c_str();
 636         let mut iter = c_str.iter();
 637         assert_eq!(iter.next(), None);
 638
 639         let c_str = "hello".to_c_str();
 640         let mut iter = c_str.iter();
 641         assert_eq!(iter.next(), Some('h' as libc::c_char));
 642         assert_eq!(iter.next(), Some('e' as libc::c_char));
 643         assert_eq!(iter.next(), Some('l' as libc::c_char));
 644         assert_eq!(iter.next(), Some('l' as libc::c_char));
 645         assert_eq!(iter.next(), Some('o' as libc::c_char));
 646         assert_eq!(iter.next(), None);
 647     }
 648
 649     #[test]
 650     fn test_to_c_str_fail() {
 651         assert!(task::try(proc() { "he\x00llo".to_c_str() }).is_err());
 652     }
 653
 654     #[test]
 655     fn test_to_c_str_unchecked() {
 656         unsafe {
 657             let c_string = "he\x00llo".to_c_str_unchecked();
 658             let buf = c_string.as_ptr();
 659             assert_eq!(*buf.offset(0), 'h' as libc::c_char);
 660             assert_eq!(*buf.offset(1), 'e' as libc::c_char);
 661             assert_eq!(*buf.offset(2), 0);
 662             assert_eq!(*buf.offset(3), 'l' as libc::c_char);
 663             assert_eq!(*buf.offset(4), 'l' as libc::c_char);
 664             assert_eq!(*buf.offset(5), 'o' as libc::c_char);
 665             assert_eq!(*buf.offset(6), 0);
 666         }
 667     }
 668
 669     #[test]
 670     fn test_as_bytes() {
 671         let c_str = "hello".to_c_str();
 672         assert_eq!(c_str.as_bytes(), b"hello\0");
 673         let c_str = "".to_c_str();
 674         assert_eq!(c_str.as_bytes(), b"\0");
 675         let c_str = b"foo\xFF".to_c_str();
 676         assert_eq!(c_str.as_bytes(), b"foo\xFF\0");
 677     }
 678
 679     #[test]
 680     fn test_as_bytes_no_nul() {
 681         let c_str = "hello".to_c_str();
 682         assert_eq!(c_str.as_bytes_no_nul(), b"hello");
 683         let c_str = "".to_c_str();
 684         let exp: &[u8] = [];
 685         assert_eq!(c_str.as_bytes_no_nul(), exp);
 686         let c_str = b"foo\xFF".to_c_str();
 687         assert_eq!(c_str.as_bytes_no_nul(), b"foo\xFF");
 688     }
 689
 690     #[test]
 691     #[should_fail]
 692     fn test_as_bytes_fail() {
 693         let c_str = unsafe { CString::new(ptr::null(), false) };
 694         c_str.as_bytes();
 695     }
 696
 697     #[test]
 698     #[should_fail]
 699     fn test_as_bytes_no_nul_fail() {
 700         let c_str = unsafe { CString::new(ptr::null(), false) };
 701         c_str.as_bytes_no_nul();
 702     }
 703
 704     #[test]
 705     fn test_as_str() {
 706         let c_str = "hello".to_c_str();
 707         assert_eq!(c_str.as_str(), Some("hello"));
 708         let c_str = "".to_c_str();
 709         assert_eq!(c_str.as_str(), Some(""));
 710         let c_str = b"foo\xFF".to_c_str();
 711         assert_eq!(c_str.as_str(), None);
 712     }
 713
 714     #[test]
 715     #[should_fail]
 716     fn test_as_str_fail() {
 717         let c_str = unsafe { CString::new(ptr::null(), false) };
 718         c_str.as_str();
 719     }
 720
 721     #[test]
 722     #[should_fail]
 723     fn test_len_fail() {
 724         let c_str = unsafe { CString::new(ptr::null(), false) };
 725         c_str.len();
 726     }
 727
 728     #[test]
 729     #[should_fail]
 730     fn test_iter_fail() {
 731         let c_str = unsafe { CString::new(ptr::null(), false) };
 732         c_str.iter();
 733     }
 734
 735     #[test]
 736     fn test_clone() {
 737         let a = "hello".to_c_str();
 738         let b = a.clone();
 739         assert!(a == b);
 740     }
 741
 742     #[test]
 743     fn test_clone_noleak() {
 744         fn foo(f: |c: &CString|) {
 745             let s = "test".to_string();
 746             let c = s.to_c_str();
 747             // give the closure a non-owned CString
 748             let mut c_ = unsafe { CString::new(c.as_ptr(), false) };
 749             f(&c_);
 750             // muck with the buffer for later printing
 751             unsafe { *c_.as_mut_ptr() = 'X' as libc::c_char }
 752         }
 753
 754         let mut c_: Option<CString> = None;
 755         foo(|c| {
 756             c_ = Some(c.clone());
 757             c.clone();
 758             // force a copy, reading the memory
 759             c.as_bytes().to_owned();
 760         });
 761         let c_ = c_.unwrap();
 762         // force a copy, reading the memory
 763         c_.as_bytes().to_owned();
 764     }
 765
 766     #[test]
 767     fn test_clone_eq_null() {
 768         let x = unsafe { CString::new(ptr::null(), false) };
 769         let y = x.clone();
 770         assert!(x == y);
 771     }
 772 }
 773
 774 #[cfg(test)]
 775 mod bench {
 776     use test::Bencher;
 777     use libc;
 778     use std::prelude::*;
 779
 780     #[inline]
 781     fn check(s: &str, c_str: *const libc::c_char) {
 782         let s_buf = s.as_ptr();
 783         for i in range(0, s.len()) {
 784             unsafe {
 785                 assert_eq!(
 786                     *s_buf.offset(i as int) as libc::c_char,
 787                     *c_str.offset(i as int));
 788             }
 789         }
 790     }
 791
 792     static s_short: &'static str = "Mary";
 793     static s_medium: &'static str = "Mary had a little lamb";
 794     static s_long: &'static str = "\
 795         Mary had a little lamb, Little lamb
 796         Mary had a little lamb, Little lamb
 797         Mary had a little lamb, Little lamb
 798         Mary had a little lamb, Little lamb
 799         Mary had a little lamb, Little lamb
 800         Mary had a little lamb, Little lamb";
 801
 802     fn bench_to_str(b: &mut Bencher, s: &str) {
 803         b.iter(|| {
 804             let c_str = s.to_c_str();
 805             check(s, c_str.as_ptr());
 806         })
 807     }
 808
 809     #[bench]
 810     fn bench_to_c_str_short(b: &mut Bencher) {
 811         bench_to_str(b, s_short)
 812     }
 813
 814     #[bench]
 815     fn bench_to_c_str_medium(b: &mut Bencher) {
 816         bench_to_str(b, s_medium)
 817     }
 818
 819     #[bench]
 820     fn bench_to_c_str_long(b: &mut Bencher) {
 821         bench_to_str(b, s_long)
 822     }
 823
 824     fn bench_to_c_str_unchecked(b: &mut Bencher, s: &str) {
 825         b.iter(|| {
 826             let c_str = unsafe { s.to_c_str_unchecked() };
 827             check(s, c_str.as_ptr())
 828         })
 829     }
 830
 831     #[bench]
 832     fn bench_to_c_str_unchecked_short(b: &mut Bencher) {
 833         bench_to_c_str_unchecked(b, s_short)
 834     }
 835
 836     #[bench]
 837     fn bench_to_c_str_unchecked_medium(b: &mut Bencher) {
 838         bench_to_c_str_unchecked(b, s_medium)
 839     }
 840
 841     #[bench]
 842     fn bench_to_c_str_unchecked_long(b: &mut Bencher) {
 843         bench_to_c_str_unchecked(b, s_long)
 844     }
 845
 846     fn bench_with_c_str(b: &mut Bencher, s: &str) {
 847         b.iter(|| {
 848             s.with_c_str(|c_str_buf| check(s, c_str_buf))
 849         })
 850     }
 851
 852     #[bench]
 853     fn bench_with_c_str_short(b: &mut Bencher) {
 854         bench_with_c_str(b, s_short)
 855     }
 856
 857     #[bench]
 858     fn bench_with_c_str_medium(b: &mut Bencher) {
 859         bench_with_c_str(b, s_medium)
 860     }
 861
 862     #[bench]
 863     fn bench_with_c_str_long(b: &mut Bencher) {
 864         bench_with_c_str(b, s_long)
 865     }
 866
 867     fn bench_with_c_str_unchecked(b: &mut Bencher, s: &str) {
 868         b.iter(|| {
 869             unsafe {
 870                 s.with_c_str_unchecked(|c_str_buf| check(s, c_str_buf))
 871             }
 872         })
 873     }
 874
 875     #[bench]
 876     fn bench_with_c_str_unchecked_short(b: &mut Bencher) {
 877         bench_with_c_str_unchecked(b, s_short)
 878     }
 879
 880     #[bench]
 881     fn bench_with_c_str_unchecked_medium(b: &mut Bencher) {
 882         bench_with_c_str_unchecked(b, s_medium)
 883     }
 884
 885     #[bench]
 886     fn bench_with_c_str_unchecked_long(b: &mut Bencher) {
 887         bench_with_c_str_unchecked(b, s_long)
 888     }
 889 }