src/libcollections/string.rs

   1 // Copyright 2014 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 //! A UTF-8 encoded, growable string.
  12 //!
  13 //! This module contains the [`String`] type, a trait for converting
  14 //! [`ToString`]s, and several error types that may result from working with
  15 //! [`String`]s.
  16 //!
  17 //! [`String`]: struct.String.html
  18 //! [`ToString`]: trait.ToString.html
  19 //!
  20 //! # Examples
  21 //!
  22 //! There are multiple ways to create a new `String` from a string literal:
  23 //!
  24 //! ```rust
  25 //! let s = "Hello".to_string();
  26 //!
  27 //! let s = String::from("world");
  28 //! let s: String = "also this".into();
  29 //! ```
  30 //!
  31 //! You can create a new `String` from an existing one by concatenating with
  32 //! `+`:
  33 //!
  34 //! ```rust
  35 //! let s = "Hello".to_string();
  36 //!
  37 //! let message = s + " world!";
  38 //! ```
  39 //!
  40 //! If you have a vector of valid UTF-8 bytes, you can make a `String` out of
  41 //! it. You can do the reverse too.
  42 //!
  43 //! ```rust
  44 //! let sparkle_heart = vec![240, 159, 146, 150];
  45 //!
  46 //! // We know these bytes are valid, so we'll use `unwrap()`.
  47 //! let sparkle_heart = String::from_utf8(sparkle_heart).unwrap();
  48 //!
  49 //! assert_eq!("💖", sparkle_heart);
  50 //!
  51 //! let bytes = sparkle_heart.into_bytes();
  52 //!
  53 //! assert_eq!(bytes, [240, 159, 146, 150]);
  54 //! ```
  55
  56 #![stable(feature = "rust1", since = "1.0.0")]
  57
  58 use core::fmt;
  59 use core::hash;
  60 use core::iter::FromIterator;
  61 use core::mem;
  62 use core::ops::{self, Add, AddAssign, Index, IndexMut};
  63 use core::ptr;
  64 use core::str::pattern::Pattern;
  65 use rustc_unicode::char::{decode_utf16, REPLACEMENT_CHARACTER};
  66 use rustc_unicode::str as unicode_str;
  67
  68 use borrow::{Cow, ToOwned};
  69 use range::RangeArgument;
  70 use str::{self, FromStr, Utf8Error, Chars};
  71 use vec::Vec;
  72 use boxed::Box;
  73
  74 /// A UTF-8 encoded, growable string.
  75 ///
  76 /// The `String` type is the most common string type that has ownership over the
  77 /// contents of the string. It has a close relationship with its borrowed
  78 /// counterpart, the primitive [`str`].
  79 ///
  80 /// [`str`]: ../../std/primitive.str.html
  81 ///
  82 /// # Examples
  83 ///
  84 /// You can create a `String` from a literal string with `String::from`:
  85 ///
  86 /// ```
  87 /// let hello = String::from("Hello, world!");
  88 /// ```
  89 ///
  90 /// You can append a [`char`] to a `String` with the [`push()`] method, and
  91 /// append a [`&str`] with the [`push_str()`] method:
  92 ///
  93 /// ```
  94 /// let mut hello = String::from("Hello, ");
  95 ///
  96 /// hello.push('w');
  97 /// hello.push_str("orld!");
  98 /// ```
  99 ///
 100 /// [`char`]: ../../std/primitive.char.html
 101 /// [`push()`]: #method.push
 102 /// [`push_str()`]: #method.push_str
 103 ///
 104 /// If you have a vector of UTF-8 bytes, you can create a `String` from it with
 105 /// the [`from_utf8()`] method:
 106 ///
 107 /// ```
 108 /// // some bytes, in a vector
 109 /// let sparkle_heart = vec![240, 159, 146, 150];
 110 ///
 111 /// // We know these bytes are valid, so we'll use `unwrap()`.
 112 /// let sparkle_heart = String::from_utf8(sparkle_heart).unwrap();
 113 ///
 114 /// assert_eq!("💖", sparkle_heart);
 115 /// ```
 116 ///
 117 /// [`from_utf8()`]: #method.from_utf8
 118 ///
 119 /// # UTF-8
 120 ///
 121 /// `String`s are always valid UTF-8. This has a few implications, the first of
 122 /// which is that if you need a non-UTF-8 string, consider [`OsString`]. It is
 123 /// similar, but without the UTF-8 constraint. The second implication is that
 124 /// you cannot index into a `String`:
 125 ///
 126 /// ```ignore
 127 /// let s = "hello";
 128 ///
 129 /// println!("The first letter of s is {}", s[0]); // ERROR!!!
 130 /// ```
 131 ///
 132 /// [`OsString`]: ../../std/ffi/struct.OsString.html
 133 ///
 134 /// Indexing is intended to be a constant-time operation, but UTF-8 encoding
 135 /// does not allow us to do this. Furtheremore, it's not clear what sort of
 136 /// thing the index should return: a byte, a codepoint, or a grapheme cluster.
 137 /// The [`as_bytes()`] and [`chars()`] methods return iterators over the first
 138 /// two, respectively.
 139 ///
 140 /// [`as_bytes()`]: #method.as_bytes
 141 /// [`chars()`]: #method.chars
 142 ///
 143 /// # Deref
 144 ///
 145 /// `String`s implement [`Deref`]`<Target=str>`, and so inherit all of [`str`]'s
 146 /// methods. In addition, this means that you can pass a `String` to any
 147 /// function which takes a [`&str`] by using an ampersand (`&`):
 148 ///
 149 /// ```
 150 /// fn takes_str(s: &str) { }
 151 ///
 152 /// let s = String::from("Hello");
 153 ///
 154 /// takes_str(&s);
 155 /// ```
 156 ///
 157 /// [`&str`]: ../../std/primitive.str.html
 158 /// [`Deref`]: ../../std/ops/trait.Deref.html
 159 ///
 160 /// This will create a [`&str`] from the `String` and pass it in. This
 161 /// conversion is very inexpensive, and so generally, functions will accept
 162 /// [`&str`]s as arguments unless they need a `String` for some specific reason.
 163 ///
 164 ///
 165 /// # Representation
 166 ///
 167 /// A `String` is made up of three components: a pointer to some bytes, a
 168 /// length, and a capacity. The pointer points to an internal buffer `String`
 169 /// uses to store its data. The length is the number of bytes currently stored
 170 /// in the buffer, and the capacity is the size of the buffer in bytes. As such,
 171 /// the length will always be less than or equal to the capacity.
 172 ///
 173 /// This buffer is always stored on the heap.
 174 ///
 175 /// You can look at these with the [`as_ptr()`], [`len()`], and [`capacity()`]
 176 /// methods:
 177 ///
 178 /// ```
 179 /// use std::mem;
 180 ///
 181 /// let story = String::from("Once upon a time...");
 182 ///
 183 /// let ptr = story.as_ptr();
 184 /// let len = story.len();
 185 /// let capacity = story.capacity();
 186 ///
 187 /// // story has nineteen bytes
 188 /// assert_eq!(19, len);
 189 ///
 190 /// // Now that we have our parts, we throw the story away.
 191 /// mem::forget(story);
 192 ///
 193 /// // We can re-build a String out of ptr, len, and capacity. This is all
 194 /// // unsafe because we are responsible for making sure the components are
 195 /// // valid:
 196 /// let s = unsafe { String::from_raw_parts(ptr as *mut _, len, capacity) } ;
 197 ///
 198 /// assert_eq!(String::from("Once upon a time..."), s);
 199 /// ```
 200 ///
 201 /// [`as_ptr()`]: #method.as_ptr
 202 /// [`len()`]: #method.len
 203 /// [`capacity()`]: #method.capacity
 204 ///
 205 /// If a `String` has enough capacity, adding elements to it will not
 206 /// re-allocate. For example, consider this program:
 207 ///
 208 /// ```
 209 /// let mut s = String::new();
 210 ///
 211 /// println!("{}", s.capacity());
 212 ///
 213 /// for _ in 0..5 {
 214 ///     s.push_str("hello");
 215 ///     println!("{}", s.capacity());
 216 /// }
 217 /// ```
 218 ///
 219 /// This will output the following:
 220 ///
 221 /// ```text
 222 /// 0
 223 /// 5
 224 /// 10
 225 /// 20
 226 /// 20
 227 /// 40
 228 /// ```
 229 ///
 230 /// At first, we have no memory allocated at all, but as we append to the
 231 /// string, it increases its capacity appropriately. If we instead use the
 232 /// [`with_capacity()`] method to allocate the correct capacity initially:
 233 ///
 234 /// ```
 235 /// let mut s = String::with_capacity(25);
 236 ///
 237 /// println!("{}", s.capacity());
 238 ///
 239 /// for _ in 0..5 {
 240 ///     s.push_str("hello");
 241 ///     println!("{}", s.capacity());
 242 /// }
 243 /// ```
 244 ///
 245 /// [`with_capacity()`]: #method.with_capacity
 246 ///
 247 /// We end up with a different output:
 248 ///
 249 /// ```text
 250 /// 25
 251 /// 25
 252 /// 25
 253 /// 25
 254 /// 25
 255 /// 25
 256 /// ```
 257 ///
 258 /// Here, there's no need to allocate more memory inside the loop.
 259 #[derive(PartialOrd, Eq, Ord)]
 260 #[stable(feature = "rust1", since = "1.0.0")]
 261 pub struct String {
 262     vec: Vec<u8>,
 263 }
 264
 265 /// A possible error value when converting a `String` from a UTF-8 byte vector.
 266 ///
 267 /// This type is the error type for the [`from_utf8()`] method on [`String`]. It
 268 /// is designed in such a way to carefully avoid reallocations: the
 269 /// [`into_bytes()`] method will give back the byte vector that was used in the
 270 /// conversion attempt.
 271 ///
 272 /// [`from_utf8()`]: struct.String.html#method.from_utf8
 273 /// [`String`]: struct.String.html
 274 /// [`into_bytes()`]: struct.FromUtf8Error.html#method.into_bytes
 275 ///
 276 /// The [`Utf8Error`] type provided by [`std::str`] represents an error that may
 277 /// occur when converting a slice of [`u8`]s to a [`&str`]. In this sense, it's
 278 /// an analogue to `FromUtf8Error`, and you can get one from a `FromUtf8Error`
 279 /// through the [`utf8_error()`] method.
 280 ///
 281 /// [`Utf8Error`]: ../../std/str/struct.Utf8Error.html
 282 /// [`std::str`]: ../../std/str/index.html
 283 /// [`u8`]: ../../std/primitive.u8.html
 284 /// [`&str`]: ../../std/primitive.str.html
 285 /// [`utf8_error()`]: #method.utf8_error
 286 ///
 287 /// # Examples
 288 ///
 289 /// Basic usage:
 290 ///
 291 /// ```
 292 /// // some invalid bytes, in a vector
 293 /// let bytes = vec![0, 159];
 294 ///
 295 /// let value = String::from_utf8(bytes);
 296 ///
 297 /// assert!(value.is_err());
 298 /// assert_eq!(vec![0, 159], value.unwrap_err().into_bytes());
 299 /// ```
 300 #[stable(feature = "rust1", since = "1.0.0")]
 301 #[derive(Debug)]
 302 pub struct FromUtf8Error {
 303     bytes: Vec<u8>,
 304     error: Utf8Error,
 305 }
 306
 307 /// A possible error value when converting a `String` from a UTF-16 byte slice.
 308 ///
 309 /// This type is the error type for the [`from_utf16()`] method on [`String`].
 310 ///
 311 /// [`from_utf16()`]: struct.String.html#method.from_utf16
 312 /// [`String`]: struct.String.html
 313 ///
 314 /// # Examples
 315 ///
 316 /// Basic usage:
 317 ///
 318 /// ```
 319 /// // 𝄞mu<invalid>ic
 320 /// let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
 321 ///           0xD800, 0x0069, 0x0063];
 322 ///
 323 /// assert!(String::from_utf16(v).is_err());
 324 /// ```
 325 #[stable(feature = "rust1", since = "1.0.0")]
 326 #[derive(Debug)]
 327 pub struct FromUtf16Error(());
 328
 329 impl String {
 330     /// Creates a new empty `String`.
 331     ///
 332     /// Given that the `String` is empty, this will not allocate any initial
 333     /// buffer. While that means that this initial operation is very
 334     /// inexpensive, but may cause excessive allocation later, when you add
 335     /// data. If you have an idea of how much data the `String` will hold,
 336     /// consider the [`with_capacity()`] method to prevent excessive
 337     /// re-allocation.
 338     ///
 339     /// [`with_capacity()`]: #method.with_capacity
 340     ///
 341     /// # Examples
 342     ///
 343     /// Basic usage:
 344     ///
 345     /// ```
 346     /// let s = String::new();
 347     /// ```
 348     #[inline]
 349     #[stable(feature = "rust1", since = "1.0.0")]
 350     pub fn new() -> String {
 351         String { vec: Vec::new() }
 352     }
 353
 354     /// Creates a new empty `String` with a particular capacity.
 355     ///
 356     /// `String`s have an internal buffer to hold their data. The capacity is
 357     /// the length of that buffer, and can be queried with the [`capacity()`]
 358     /// method. This method creates an empty `String`, but one with an initial
 359     /// buffer that can hold `capacity` bytes. This is useful when you may be
 360     /// appending a bunch of data to the `String`, reducing the number of
 361     /// reallocations it needs to do.
 362     ///
 363     /// [`capacity()`]: #method.capacity
 364     ///
 365     /// If the given capacity is `0`, no allocation will occur, and this method
 366     /// is identical to the [`new()`] method.
 367     ///
 368     /// [`new()`]: #method.new
 369     ///
 370     /// # Examples
 371     ///
 372     /// Basic usage:
 373     ///
 374     /// ```
 375     /// let mut s = String::with_capacity(10);
 376     ///
 377     /// // The String contains no chars, even though it has capacity for more
 378     /// assert_eq!(s.len(), 0);
 379     ///
 380     /// // These are all done without reallocating...
 381     /// let cap = s.capacity();
 382     /// for i in 0..10 {
 383     ///     s.push('a');
 384     /// }
 385     ///
 386     /// assert_eq!(s.capacity(), cap);
 387     ///
 388     /// // ...but this may make the vector reallocate
 389     /// s.push('a');
 390     /// ```
 391     #[inline]
 392     #[stable(feature = "rust1", since = "1.0.0")]
 393     pub fn with_capacity(capacity: usize) -> String {
 394         String { vec: Vec::with_capacity(capacity) }
 395     }
 396
 397     // HACK(japaric): with cfg(test) the inherent `[T]::to_vec` method, which is
 398     // required for this method definition, is not available. Since we don't
 399     // require this method for testing purposes, I'll just stub it
 400     // NB see the slice::hack module in slice.rs for more information
 401     #[inline]
 402     #[cfg(test)]
 403     pub fn from_str(_: &str) -> String {
 404         panic!("not available with cfg(test)");
 405     }
 406
 407     /// Converts a vector of bytes to a `String`.
 408     ///
 409     /// A string slice ([`&str`]) is made of bytes ([`u8`]), and a vector of bytes
 410     /// ([`Vec<u8>`]) is made of bytes, so this function converts between the
 411     /// two. Not all byte slices are valid `String`s, however: `String`
 412     /// requires that it is valid UTF-8. `from_utf8()` checks to ensure that
 413     /// the bytes are valid UTF-8, and then does the conversion.
 414     ///
 415     /// [`&str`]: ../../std/primitive.str.html
 416     /// [`u8`]: ../../std/primitive.u8.html
 417     /// [`Vec<u8>`]: ../../std/vec/struct.Vec.html
 418     ///
 419     /// If you are sure that the byte slice is valid UTF-8, and you don't want
 420     /// to incur the overhead of the validity check, there is an unsafe version
 421     /// of this function, [`from_utf8_unchecked()`], which has the same behavior
 422     /// but skips the check.
 423     ///
 424     /// [`from_utf8_unchecked()`]: struct.String.html#method.from_utf8_unchecked
 425     ///
 426     /// This method will take care to not copy the vector, for efficiency's
 427     /// sake.
 428     ///
 429     /// If you need a `&str` instead of a `String`, consider
 430     /// [`str::from_utf8()`].
 431     ///
 432     /// [`str::from_utf8()`]: ../../std/str/fn.from_utf8.html
 433     ///
 434     /// # Errors
 435     ///
 436     /// Returns `Err` if the slice is not UTF-8 with a description as to why the
 437     /// provided bytes are not UTF-8. The vector you moved in is also included.
 438     ///
 439     /// # Examples
 440     ///
 441     /// Basic usage:
 442     ///
 443     /// ```
 444     /// // some bytes, in a vector
 445     /// let sparkle_heart = vec![240, 159, 146, 150];
 446     ///
 447     /// // We know these bytes are valid, so we'll use `unwrap()`.
 448     /// let sparkle_heart = String::from_utf8(sparkle_heart).unwrap();
 449     ///
 450     /// assert_eq!("💖", sparkle_heart);
 451     /// ```
 452     ///
 453     /// Incorrect bytes:
 454     ///
 455     /// ```
 456     /// // some invalid bytes, in a vector
 457     /// let sparkle_heart = vec![0, 159, 146, 150];
 458     ///
 459     /// assert!(String::from_utf8(sparkle_heart).is_err());
 460     /// ```
 461     ///
 462     /// See the docs for [`FromUtf8Error`] for more details on what you can do
 463     /// with this error.
 464     ///
 465     /// [`FromUtf8Error`]: struct.FromUtf8Error.html
 466     #[inline]
 467     #[stable(feature = "rust1", since = "1.0.0")]
 468     pub fn from_utf8(vec: Vec<u8>) -> Result<String, FromUtf8Error> {
 469         match str::from_utf8(&vec) {
 470             Ok(..) => Ok(String { vec: vec }),
 471             Err(e) => {
 472                 Err(FromUtf8Error {
 473                     bytes: vec,
 474                     error: e,
 475                 })
 476             }
 477         }
 478     }
 479
 480     /// Converts a slice of bytes to a string, including invalid characters.
 481     ///
 482     /// Strings are made of bytes ([`u8`]), and a slice of bytes
 483     /// ([`&[u8]`][byteslice]) is made of bytes, so this function converts
 484     /// between the two. Not all byte slices are valid strings, however: strings
 485     /// are required to be valid UTF-8. During this conversion,
 486     /// `from_utf8_lossy()` will replace any invalid UTF-8 sequences with
 487     /// `U+FFFD REPLACEMENT CHARACTER`, which looks like this: �
 488     ///
 489     /// [`u8`]: ../../std/primitive.u8.html
 490     /// [byteslice]: ../../std/primitive.slice.html
 491     ///
 492     /// If you are sure that the byte slice is valid UTF-8, and you don't want
 493     /// to incur the overhead of the conversion, there is an unsafe version
 494     /// of this function, [`from_utf8_unchecked()`], which has the same behavior
 495     /// but skips the checks.
 496     ///
 497     /// [`from_utf8_unchecked()`]: struct.String.html#method.from_utf8_unchecked
 498     ///
 499     /// This function returns a [`Cow<'a, str>`]. If our byte slice is invalid
 500     /// UTF-8, then we need to insert the replacement characters, which will
 501     /// change the size of the string, and hence, require a `String`. But if
 502     /// it's already valid UTF-8, we don't need a new allocation. This return
 503     /// type allows us to handle both cases.
 504     ///
 505     /// [`Cow<'a, str>`]: ../../std/borrow/enum.Cow.html
 506     ///
 507     /// # Examples
 508     ///
 509     /// Basic usage:
 510     ///
 511     /// ```
 512     /// // some bytes, in a vector
 513     /// let sparkle_heart = vec![240, 159, 146, 150];
 514     ///
 515     /// let sparkle_heart = String::from_utf8_lossy(&sparkle_heart);
 516     ///
 517     /// assert_eq!("💖", sparkle_heart);
 518     /// ```
 519     ///
 520     /// Incorrect bytes:
 521     ///
 522     /// ```
 523     /// // some invalid bytes
 524     /// let input = b"Hello \xF0\x90\x80World";
 525     /// let output = String::from_utf8_lossy(input);
 526     ///
 527     /// assert_eq!("Hello �World", output);
 528     /// ```
 529     #[stable(feature = "rust1", since = "1.0.0")]
 530     pub fn from_utf8_lossy<'a>(v: &'a [u8]) -> Cow<'a, str> {
 531         let mut i;
 532         match str::from_utf8(v) {
 533             Ok(s) => return Cow::Borrowed(s),
 534             Err(e) => i = e.valid_up_to(),
 535         }
 536
 537         const TAG_CONT_U8: u8 = 128;
 538         const REPLACEMENT: &'static [u8] = b"\xEF\xBF\xBD"; // U+FFFD in UTF-8
 539         let total = v.len();
 540         fn unsafe_get(xs: &[u8], i: usize) -> u8 {
 541             unsafe { *xs.get_unchecked(i) }
 542         }
 543         fn safe_get(xs: &[u8], i: usize, total: usize) -> u8 {
 544             if i >= total {
 545                 0
 546             } else {
 547                 unsafe_get(xs, i)
 548             }
 549         }
 550
 551         let mut res = String::with_capacity(total);
 552
 553         if i > 0 {
 554             unsafe { res.as_mut_vec().extend_from_slice(&v[..i]) };
 555         }
 556
 557         // subseqidx is the index of the first byte of the subsequence we're
 558         // looking at.  It's used to copy a bunch of contiguous good codepoints
 559         // at once instead of copying them one by one.
 560         let mut subseqidx = i;
 561
 562         while i < total {
 563             let i_ = i;
 564             let byte = unsafe_get(v, i);
 565             i += 1;
 566
 567             macro_rules! error { () => ({
 568                 unsafe {
 569                     if subseqidx != i_ {
 570                         res.as_mut_vec().extend_from_slice(&v[subseqidx..i_]);
 571                     }
 572                     subseqidx = i;
 573                     res.as_mut_vec().extend_from_slice(REPLACEMENT);
 574                 }
 575             })}
 576
 577             if byte < 128 {
 578                 // subseqidx handles this
 579             } else {
 580                 let w = unicode_str::utf8_char_width(byte);
 581
 582                 match w {
 583                     2 => {
 584                         if safe_get(v, i, total) & 192 != TAG_CONT_U8 {
 585                             error!();
 586                             continue;
 587                         }
 588                         i += 1;
 589                     }
 590                     3 => {
 591                         match (byte, safe_get(v, i, total)) {
 592                             (0xE0, 0xA0...0xBF) => (),
 593                             (0xE1...0xEC, 0x80...0xBF) => (),
 594                             (0xED, 0x80...0x9F) => (),
 595                             (0xEE...0xEF, 0x80...0xBF) => (),
 596                             _ => {
 597                                 error!();
 598                                 continue;
 599                             }
 600                         }
 601                         i += 1;
 602                         if safe_get(v, i, total) & 192 != TAG_CONT_U8 {
 603                             error!();
 604                             continue;
 605                         }
 606                         i += 1;
 607                     }
 608                     4 => {
 609                         match (byte, safe_get(v, i, total)) {
 610                             (0xF0, 0x90...0xBF) => (),
 611                             (0xF1...0xF3, 0x80...0xBF) => (),
 612                             (0xF4, 0x80...0x8F) => (),
 613                             _ => {
 614                                 error!();
 615                                 continue;
 616                             }
 617                         }
 618                         i += 1;
 619                         if safe_get(v, i, total) & 192 != TAG_CONT_U8 {
 620                             error!();
 621                             continue;
 622                         }
 623                         i += 1;
 624                         if safe_get(v, i, total) & 192 != TAG_CONT_U8 {
 625                             error!();
 626                             continue;
 627                         }
 628                         i += 1;
 629                     }
 630                     _ => {
 631                         error!();
 632                         continue;
 633                     }
 634                 }
 635             }
 636         }
 637         if subseqidx < total {
 638             unsafe { res.as_mut_vec().extend_from_slice(&v[subseqidx..total]) };
 639         }
 640         Cow::Owned(res)
 641     }
 642
 643     /// Decode a UTF-16 encoded vector `v` into a `String`, returning `Err`
 644     /// if `v` contains any invalid data.
 645     ///
 646     /// # Examples
 647     ///
 648     /// Basic usage:
 649     ///
 650     /// ```
 651     /// // 𝄞music
 652     /// let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
 653     ///           0x0073, 0x0069, 0x0063];
 654     /// assert_eq!(String::from("𝄞music"),
 655     ///            String::from_utf16(v).unwrap());
 656     ///
 657     /// // 𝄞mu<invalid>ic
 658     /// let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
 659     ///           0xD800, 0x0069, 0x0063];
 660     /// assert!(String::from_utf16(v).is_err());
 661     /// ```
 662     #[stable(feature = "rust1", since = "1.0.0")]
 663     pub fn from_utf16(v: &[u16]) -> Result<String, FromUtf16Error> {
 664         decode_utf16(v.iter().cloned()).collect::<Result<_, _>>().map_err(|_| FromUtf16Error(()))
 665     }
 666
 667     /// Decode a UTF-16 encoded vector `v` into a string, replacing
 668     /// invalid data with the replacement character (U+FFFD).
 669     ///
 670     /// # Examples
 671     ///
 672     /// Basic usage:
 673     ///
 674     /// ```
 675     /// // 𝄞mus<invalid>ic<invalid>
 676     /// let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
 677     ///           0x0073, 0xDD1E, 0x0069, 0x0063,
 678     ///           0xD834];
 679     ///
 680     /// assert_eq!(String::from("𝄞mus\u{FFFD}ic\u{FFFD}"),
 681     ///            String::from_utf16_lossy(v));
 682     /// ```
 683     #[inline]
 684     #[stable(feature = "rust1", since = "1.0.0")]
 685     pub fn from_utf16_lossy(v: &[u16]) -> String {
 686         decode_utf16(v.iter().cloned()).map(|r| r.unwrap_or(REPLACEMENT_CHARACTER)).collect()
 687     }
 688
 689     /// Creates a new `String` from a length, capacity, and pointer.
 690     ///
 691     /// # Safety
 692     ///
 693     /// This is highly unsafe, due to the number of invariants that aren't
 694     /// checked:
 695     ///
 696     /// * The memory at `ptr` needs to have been previously allocated by the
 697     ///   same allocator the standard library uses.
 698     /// * `length` needs to be less than or equal to `capacity`.
 699     /// * `capacity` needs to be the correct value.
 700     ///
 701     /// Violating these may cause problems like corrupting the allocator's
 702     /// internal datastructures.
 703     ///
 704     /// The ownership of `ptr` is effectively transferred to the
 705     /// `String` which may then deallocate, reallocate or change the
 706     /// contents of memory pointed to by the pointer at will. Ensure
 707     /// that nothing else uses the pointer after calling this
 708     /// function.
 709     ///
 710     /// # Examples
 711     ///
 712     /// Basic usage:
 713     ///
 714     /// ```
 715     /// use std::mem;
 716     ///
 717     /// unsafe {
 718     ///     let s = String::from("hello");
 719     ///     let ptr = s.as_ptr();
 720     ///     let len = s.len();
 721     ///     let capacity = s.capacity();
 722     ///
 723     ///     mem::forget(s);
 724     ///
 725     ///     let s = String::from_raw_parts(ptr as *mut _, len, capacity);
 726     ///
 727     ///     assert_eq!(String::from("hello"), s);
 728     /// }
 729     /// ```
 730     #[inline]
 731     #[stable(feature = "rust1", since = "1.0.0")]
 732     pub unsafe fn from_raw_parts(buf: *mut u8, length: usize, capacity: usize) -> String {
 733         String { vec: Vec::from_raw_parts(buf, length, capacity) }
 734     }
 735
 736     /// Converts a vector of bytes to a `String` without checking that the
 737     /// string contains valid UTF-8.
 738     ///
 739     /// See the safe version, [`from_utf8()`], for more details.
 740     ///
 741     /// [`from_utf8()`]: struct.String.html#method.from_utf8
 742     ///
 743     /// # Safety
 744     ///
 745     /// This function is unsafe because it does not check that the bytes passed
 746     /// to it are valid UTF-8. If this constraint is violated, it may cause
 747     /// memory unsafety issues with future users of the `String`, as the rest of
 748     /// the standard library assumes that `String`s are valid UTF-8.
 749     ///
 750     /// # Examples
 751     ///
 752     /// Basic usage:
 753     ///
 754     /// ```
 755     /// // some bytes, in a vector
 756     /// let sparkle_heart = vec![240, 159, 146, 150];
 757     ///
 758     /// let sparkle_heart = unsafe {
 759     ///     String::from_utf8_unchecked(sparkle_heart)
 760     /// };
 761     ///
 762     /// assert_eq!("💖", sparkle_heart);
 763     /// ```
 764     #[inline]
 765     #[stable(feature = "rust1", since = "1.0.0")]
 766     pub unsafe fn from_utf8_unchecked(bytes: Vec<u8>) -> String {
 767         String { vec: bytes }
 768     }
 769
 770     /// Converts a `String` into a byte vector.
 771     ///
 772     /// This consumes the `String`, so we do not need to copy its contents.
 773     ///
 774     /// # Examples
 775     ///
 776     /// Basic usage:
 777     ///
 778     /// ```
 779     /// let s = String::from("hello");
 780     /// let bytes = s.into_bytes();
 781     ///
 782     /// assert_eq!(&[104, 101, 108, 108, 111][..], &bytes[..]);
 783     /// ```
 784     #[inline]
 785     #[stable(feature = "rust1", since = "1.0.0")]
 786     pub fn into_bytes(self) -> Vec<u8> {
 787         self.vec
 788     }
 789
 790     /// Extracts a string slice containing the entire string.
 791     #[inline]
 792     #[stable(feature = "string_as_str", since = "1.7.0")]
 793     pub fn as_str(&self) -> &str {
 794         self
 795     }
 796
 797     /// Extracts a string slice containing the entire string.
 798     #[inline]
 799     #[stable(feature = "string_as_str", since = "1.7.0")]
 800     pub fn as_mut_str(&mut self) -> &mut str {
 801         self
 802     }
 803
 804     /// Appends a given string slice onto the end of this `String`.
 805     ///
 806     /// # Examples
 807     ///
 808     /// Basic usage:
 809     ///
 810     /// ```
 811     /// let mut s = String::from("foo");
 812     ///
 813     /// s.push_str("bar");
 814     ///
 815     /// assert_eq!("foobar", s);
 816     /// ```
 817     #[inline]
 818     #[stable(feature = "rust1", since = "1.0.0")]
 819     pub fn push_str(&mut self, string: &str) {
 820         self.vec.extend_from_slice(string.as_bytes())
 821     }
 822
 823     /// Returns this `String`'s capacity, in bytes.
 824     ///
 825     /// # Examples
 826     ///
 827     /// Basic usage:
 828     ///
 829     /// ```
 830     /// let s = String::with_capacity(10);
 831     ///
 832     /// assert!(s.capacity() >= 10);
 833     /// ```
 834     #[inline]
 835     #[stable(feature = "rust1", since = "1.0.0")]
 836     pub fn capacity(&self) -> usize {
 837         self.vec.capacity()
 838     }
 839
 840     /// Ensures that this `String`'s capacity is at least `additional` bytes
 841     /// larger than its length.
 842     ///
 843     /// The capacity may be increased by more than `additional` bytes if it
 844     /// chooses, to prevent frequent reallocations.
 845     ///
 846     /// If you do not want this "at least" behavior, see the [`reserve_exact()`]
 847     /// method.
 848     ///
 849     /// [`reserve_exact()`]: #method.reserve_exact
 850     ///
 851     /// # Panics
 852     ///
 853     /// Panics if the new capacity overflows `usize`.
 854     ///
 855     /// # Examples
 856     ///
 857     /// Basic usage:
 858     ///
 859     /// ```
 860     /// let mut s = String::new();
 861     ///
 862     /// s.reserve(10);
 863     ///
 864     /// assert!(s.capacity() >= 10);
 865     /// ```
 866     ///
 867     /// This may not actually increase the capacity:
 868     ///
 869     /// ```
 870     /// let mut s = String::with_capacity(10);
 871     /// s.push('a');
 872     /// s.push('b');
 873     ///
 874     /// // s now has a length of 2 and a capacity of 10
 875     /// assert_eq!(2, s.len());
 876     /// assert_eq!(10, s.capacity());
 877     ///
 878     /// // Since we already have an extra 8 capacity, calling this...
 879     /// s.reserve(8);
 880     ///
 881     /// // ... doesn't actually increase.
 882     /// assert_eq!(10, s.capacity());
 883     /// ```
 884     #[inline]
 885     #[stable(feature = "rust1", since = "1.0.0")]
 886     pub fn reserve(&mut self, additional: usize) {
 887         self.vec.reserve(additional)
 888     }
 889
 890     /// Ensures that this `String`'s capacity is `additional` bytes
 891     /// larger than its length.
 892     ///
 893     /// Consider using the [`reserve()`] method unless you absolutely know
 894     /// better than the allocator.
 895     ///
 896     /// [`reserve()`]: #method.reserve
 897     ///
 898     /// # Panics
 899     ///
 900     /// Panics if the new capacity overflows `usize`.
 901     ///
 902     /// # Examples
 903     ///
 904     /// Basic usage:
 905     ///
 906     /// ```
 907     /// let mut s = String::new();
 908     ///
 909     /// s.reserve_exact(10);
 910     ///
 911     /// assert!(s.capacity() >= 10);
 912     /// ```
 913     ///
 914     /// This may not actually increase the capacity:
 915     ///
 916     /// ```
 917     /// let mut s = String::with_capacity(10);
 918     /// s.push('a');
 919     /// s.push('b');
 920     ///
 921     /// // s now has a length of 2 and a capacity of 10
 922     /// assert_eq!(2, s.len());
 923     /// assert_eq!(10, s.capacity());
 924     ///
 925     /// // Since we already have an extra 8 capacity, calling this...
 926     /// s.reserve_exact(8);
 927     ///
 928     /// // ... doesn't actually increase.
 929     /// assert_eq!(10, s.capacity());
 930     /// ```
 931     #[inline]
 932     #[stable(feature = "rust1", since = "1.0.0")]
 933     pub fn reserve_exact(&mut self, additional: usize) {
 934         self.vec.reserve_exact(additional)
 935     }
 936
 937     /// Shrinks the capacity of this `String` to match its length.
 938     ///
 939     /// # Examples
 940     ///
 941     /// Basic usage:
 942     ///
 943     /// ```
 944     /// let mut s = String::from("foo");
 945     ///
 946     /// s.reserve(100);
 947     /// assert!(s.capacity() >= 100);
 948     ///
 949     /// s.shrink_to_fit();
 950     /// assert_eq!(3, s.capacity());
 951     /// ```
 952     #[inline]
 953     #[stable(feature = "rust1", since = "1.0.0")]
 954     pub fn shrink_to_fit(&mut self) {
 955         self.vec.shrink_to_fit()
 956     }
 957
 958     /// Appends the given `char` to the end of this `String`.
 959     ///
 960     /// # Examples
 961     ///
 962     /// Basic usage:
 963     ///
 964     /// ```
 965     /// let mut s = String::from("abc");
 966     ///
 967     /// s.push('1');
 968     /// s.push('2');
 969     /// s.push('3');
 970     ///
 971     /// assert_eq!("abc123", s);
 972     /// ```
 973     #[inline]
 974     #[stable(feature = "rust1", since = "1.0.0")]
 975     pub fn push(&mut self, ch: char) {
 976         match ch.len_utf8() {
 977             1 => self.vec.push(ch as u8),
 978             _ => self.vec.extend_from_slice(ch.encode_utf8().as_slice()),
 979         }
 980     }
 981
 982     /// Returns a byte slice of this `String`'s contents.
 983     ///
 984     /// # Examples
 985     ///
 986     /// Basic usage:
 987     ///
 988     /// ```
 989     /// let s = String::from("hello");
 990     ///
 991     /// assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());
 992     /// ```
 993     #[inline]
 994     #[stable(feature = "rust1", since = "1.0.0")]
 995     pub fn as_bytes(&self) -> &[u8] {
 996         &self.vec
 997     }
 998
 999     /// Shortens this `String` to the specified length.
1000     ///
1001     /// If `new_len` is greater than the string's current length, this has no
1002     /// effect.
1003     ///
1004     /// # Panics
1005     ///
1006     /// Panics if `new_len` does not lie on a [`char`] boundary.
1007     ///
1008     /// [`char`]: ../../std/primitive.char.html
1009     ///
1010     /// # Examples
1011     ///
1012     /// Basic usage:
1013     ///
1014     /// ```
1015     /// let mut s = String::from("hello");
1016     ///
1017     /// s.truncate(2);
1018     ///
1019     /// assert_eq!("he", s);
1020     /// ```
1021     #[inline]
1022     #[stable(feature = "rust1", since = "1.0.0")]
1023     pub fn truncate(&mut self, new_len: usize) {
1024         if new_len <= self.len() {
1025             assert!(self.is_char_boundary(new_len));
1026             self.vec.truncate(new_len)
1027         }
1028     }
1029
1030     /// Removes the last character from the string buffer and returns it.
1031     ///
1032     /// Returns `None` if this `String` is empty.
1033     ///
1034     /// # Examples
1035     ///
1036     /// Basic usage:
1037     ///
1038     /// ```
1039     /// let mut s = String::from("foo");
1040     ///
1041     /// assert_eq!(s.pop(), Some('o'));
1042     /// assert_eq!(s.pop(), Some('o'));
1043     /// assert_eq!(s.pop(), Some('f'));
1044     ///
1045     /// assert_eq!(s.pop(), None);
1046     /// ```
1047     #[inline]
1048     #[stable(feature = "rust1", since = "1.0.0")]
1049     pub fn pop(&mut self) -> Option<char> {
1050         let ch = match self.chars().rev().next() {
1051             Some(ch) => ch,
1052             None => return None,
1053         };
1054         let newlen = self.len() - ch.len_utf8();
1055         unsafe {
1056             self.vec.set_len(newlen);
1057         }
1058         Some(ch)
1059     }
1060
1061     /// Removes a `char` from this `String` at a byte position and returns it.
1062     ///
1063     /// This is an `O(n)` operation, as it requires copying every element in the
1064     /// buffer.
1065     ///
1066     /// # Panics
1067     ///
1068     /// Panics if `idx` is larger than or equal to the `String`'s length,
1069     /// or if it does not lie on a [`char`] boundary.
1070     ///
1071     /// [`char`]: ../../std/primitive.char.html
1072     ///
1073     /// # Examples
1074     ///
1075     /// Basic usage:
1076     ///
1077     /// ```
1078     /// let mut s = String::from("foo");
1079     ///
1080     /// assert_eq!(s.remove(0), 'f');
1081     /// assert_eq!(s.remove(1), 'o');
1082     /// assert_eq!(s.remove(0), 'o');
1083     /// ```
1084     #[inline]
1085     #[stable(feature = "rust1", since = "1.0.0")]
1086     pub fn remove(&mut self, idx: usize) -> char {
1087         let ch = match self[idx..].chars().next() {
1088             Some(ch) => ch,
1089             None => panic!("cannot remove a char from the end of a string"),
1090         };
1091
1092         let next = idx + ch.len_utf8();
1093         let len = self.len();
1094         unsafe {
1095             ptr::copy(self.vec.as_ptr().offset(next as isize),
1096                       self.vec.as_mut_ptr().offset(idx as isize),
1097                       len - next);
1098             self.vec.set_len(len - (next - idx));
1099         }
1100         ch
1101     }
1102
1103     /// Inserts a character into this `String` at a byte position.
1104     ///
1105     /// This is an `O(n)` operation as it requires copying every element in the
1106     /// buffer.
1107     ///
1108     /// # Panics
1109     ///
1110     /// Panics if `idx` is larger than the `String`'s length, or if it does not
1111     /// lie on a [`char`] boundary.
1112     ///
1113     /// [`char`]: ../../std/primitive.char.html
1114     ///
1115     /// # Examples
1116     ///
1117     /// Basic usage:
1118     ///
1119     /// ```
1120     /// let mut s = String::with_capacity(3);
1121     ///
1122     /// s.insert(0, 'f');
1123     /// s.insert(1, 'o');
1124     /// s.insert(2, 'o');
1125     ///
1126     /// assert_eq!("foo", s);
1127     /// ```
1128     #[inline]
1129     #[stable(feature = "rust1", since = "1.0.0")]
1130     pub fn insert(&mut self, idx: usize, ch: char) {
1131         let len = self.len();
1132         assert!(idx <= len);
1133         assert!(self.is_char_boundary(idx));
1134         let bits = ch.encode_utf8();
1135
1136         unsafe {
1137             self.insert_bytes(idx, bits.as_slice());
1138         }
1139     }
1140
1141     unsafe fn insert_bytes(&mut self, idx: usize, bytes: &[u8]) {
1142         let len = self.len();
1143         let amt = bytes.len();
1144         self.vec.reserve(amt);
1145
1146         ptr::copy(self.vec.as_ptr().offset(idx as isize),
1147                   self.vec.as_mut_ptr().offset((idx + amt) as isize),
1148                   len - idx);
1149         ptr::copy(bytes.as_ptr(),
1150                   self.vec.as_mut_ptr().offset(idx as isize),
1151                   amt);
1152         self.vec.set_len(len + amt);
1153     }
1154
1155     /// Inserts a string slice into this `String` at a byte position.
1156     ///
1157     /// This is an `O(n)` operation as it requires copying every element in the
1158     /// buffer.
1159     ///
1160     /// # Panics
1161     ///
1162     /// Panics if `idx` is larger than the `String`'s length, or if it does not
1163     /// lie on a [`char`] boundary.
1164     ///
1165     /// [`char`]: ../../std/primitive.char.html
1166     ///
1167     /// # Examples
1168     ///
1169     /// Basic usage:
1170     ///
1171     /// ```
1172     /// #![feature(insert_str)]
1173     ///
1174     /// let mut s = String::from("bar");
1175     ///
1176     /// s.insert_str(0, "foo");
1177     ///
1178     /// assert_eq!("foobar", s);
1179     /// ```
1180     #[inline]
1181     #[unstable(feature = "insert_str",
1182                reason = "recent addition",
1183                issue = "0")]
1184     pub fn insert_str(&mut self, idx: usize, string: &str) {
1185         let len = self.len();
1186         assert!(idx <= len);
1187         assert!(self.is_char_boundary(idx));
1188
1189         unsafe {
1190             self.insert_bytes(idx, string.as_bytes());
1191         }
1192     }
1193
1194     /// Returns a mutable reference to the contents of this `String`.
1195     ///
1196     /// # Safety
1197     ///
1198     /// This function is unsafe because it does not check that the bytes passed
1199     /// to it are valid UTF-8. If this constraint is violated, it may cause
1200     /// memory unsafety issues with future users of the `String`, as the rest of
1201     /// the standard library assumes that `String`s are valid UTF-8.
1202     ///
1203     /// # Examples
1204     ///
1205     /// Basic usage:
1206     ///
1207     /// ```
1208     /// let mut s = String::from("hello");
1209     ///
1210     /// unsafe {
1211     ///     let vec = s.as_mut_vec();
1212     ///     assert_eq!(&[104, 101, 108, 108, 111][..], &vec[..]);
1213     ///
1214     ///     vec.reverse();
1215     /// }
1216     /// assert_eq!(s, "olleh");
1217     /// ```
1218     #[inline]
1219     #[stable(feature = "rust1", since = "1.0.0")]
1220     pub unsafe fn as_mut_vec(&mut self) -> &mut Vec<u8> {
1221         &mut self.vec
1222     }
1223
1224     /// Returns the length of this `String`, in bytes.
1225     ///
1226     /// # Examples
1227     ///
1228     /// Basic usage:
1229     ///
1230     /// ```
1231     /// let a = String::from("foo");
1232     ///
1233     /// assert_eq!(a.len(), 3);
1234     /// ```
1235     #[inline]
1236     #[stable(feature = "rust1", since = "1.0.0")]
1237     pub fn len(&self) -> usize {
1238         self.vec.len()
1239     }
1240
1241     /// Returns `true` if this `String` has a length of zero.
1242     ///
1243     /// Returns `false` otherwise.
1244     ///
1245     /// # Examples
1246     ///
1247     /// Basic usage:
1248     ///
1249     /// ```
1250     /// let mut v = String::new();
1251     /// assert!(v.is_empty());
1252     ///
1253     /// v.push('a');
1254     /// assert!(!v.is_empty());
1255     /// ```
1256     #[inline]
1257     #[stable(feature = "rust1", since = "1.0.0")]
1258     pub fn is_empty(&self) -> bool {
1259         self.len() == 0
1260     }
1261
1262     /// Truncates this `String`, removing all contents.
1263     ///
1264     /// While this means the `String` will have a length of zero, it does not
1265     /// touch its capacity.
1266     ///
1267     /// # Examples
1268     ///
1269     /// Basic usage:
1270     ///
1271     /// ```
1272     /// let mut s = String::from("foo");
1273     ///
1274     /// s.clear();
1275     ///
1276     /// assert!(s.is_empty());
1277     /// assert_eq!(0, s.len());
1278     /// assert_eq!(3, s.capacity());
1279     /// ```
1280     #[inline]
1281     #[stable(feature = "rust1", since = "1.0.0")]
1282     pub fn clear(&mut self) {
1283         self.vec.clear()
1284     }
1285
1286     /// Create a draining iterator that removes the specified range in the string
1287     /// and yields the removed chars.
1288     ///
1289     /// Note: The element range is removed even if the iterator is not
1290     /// consumed until the end.
1291     ///
1292     /// # Panics
1293     ///
1294     /// Panics if the starting point or end point do not lie on a [`char`]
1295     /// boundary, or if they're out of bounds.
1296     ///
1297     /// [`char`]: ../../std/primitive.char.html
1298     ///
1299     /// # Examples
1300     ///
1301     /// Basic usage:
1302     ///
1303     /// ```
1304     /// let mut s = String::from("α is alpha, β is beta");
1305     /// let beta_offset = s.find('β').unwrap_or(s.len());
1306     ///
1307     /// // Remove the range up until the β from the string
1308     /// let t: String = s.drain(..beta_offset).collect();
1309     /// assert_eq!(t, "α is alpha, ");
1310     /// assert_eq!(s, "β is beta");
1311     ///
1312     /// // A full range clears the string
1313     /// s.drain(..);
1314     /// assert_eq!(s, "");
1315     /// ```
1316     #[stable(feature = "drain", since = "1.6.0")]
1317     pub fn drain<R>(&mut self, range: R) -> Drain
1318         where R: RangeArgument<usize>
1319     {
1320         // Memory safety
1321         //
1322         // The String version of Drain does not have the memory safety issues
1323         // of the vector version. The data is just plain bytes.
1324         // Because the range removal happens in Drop, if the Drain iterator is leaked,
1325         // the removal will not happen.
1326         let len = self.len();
1327         let start = *range.start().unwrap_or(&0);
1328         let end = *range.end().unwrap_or(&len);
1329
1330         // Take out two simultaneous borrows. The &mut String won't be accessed
1331         // until iteration is over, in Drop.
1332         let self_ptr = self as *mut _;
1333         // slicing does the appropriate bounds checks
1334         let chars_iter = self[start..end].chars();
1335
1336         Drain {
1337             start: start,
1338             end: end,
1339             iter: chars_iter,
1340             string: self_ptr,
1341         }
1342     }
1343
1344     /// Converts this `String` into a `Box<str>`.
1345     ///
1346     /// This will drop any excess capacity.
1347     ///
1348     /// # Examples
1349     ///
1350     /// Basic usage:
1351     ///
1352     /// ```
1353     /// let s = String::from("hello");
1354     ///
1355     /// let b = s.into_boxed_str();
1356     /// ```
1357     #[stable(feature = "box_str", since = "1.4.0")]
1358     pub fn into_boxed_str(self) -> Box<str> {
1359         let slice = self.vec.into_boxed_slice();
1360         unsafe { mem::transmute::<Box<[u8]>, Box<str>>(slice) }
1361     }
1362 }
1363
1364 impl FromUtf8Error {
1365     /// Returns the bytes that were attempted to convert to a `String`.
1366     ///
1367     /// This method is carefully constructed to avoid allocation. It will
1368     /// consume the error, moving out the bytes, so that a copy of the bytes
1369     /// does not need to be made.
1370     ///
1371     /// # Examples
1372     ///
1373     /// Basic usage:
1374     ///
1375     /// ```
1376     /// // some invalid bytes, in a vector
1377     /// let bytes = vec![0, 159];
1378     ///
1379     /// let value = String::from_utf8(bytes);
1380     ///
1381     /// assert_eq!(vec![0, 159], value.unwrap_err().into_bytes());
1382     /// ```
1383     #[stable(feature = "rust1", since = "1.0.0")]
1384     pub fn into_bytes(self) -> Vec<u8> {
1385         self.bytes
1386     }
1387
1388     /// Fetch a `Utf8Error` to get more details about the conversion failure.
1389     ///
1390     /// The [`Utf8Error`] type provided by [`std::str`] represents an error that may
1391     /// occur when converting a slice of [`u8`]s to a [`&str`]. In this sense, it's
1392     /// an analogue to `FromUtf8Error`. See its documentation for more details
1393     /// on using it.
1394     ///
1395     /// [`Utf8Error`]: ../../std/str/struct.Utf8Error.html
1396     /// [`std::str`]: ../../std/str/index.html
1397     /// [`u8`]: ../../std/primitive.u8.html
1398     /// [`&str`]: ../../std/primitive.str.html
1399     ///
1400     /// # Examples
1401     ///
1402     /// Basic usage:
1403     ///
1404     /// ```
1405     /// // some invalid bytes, in a vector
1406     /// let bytes = vec![0, 159];
1407     ///
1408     /// let error = String::from_utf8(bytes).unwrap_err().utf8_error();
1409     ///
1410     /// // the first byte is invalid here
1411     /// assert_eq!(1, error.valid_up_to());
1412     /// ```
1413     #[stable(feature = "rust1", since = "1.0.0")]
1414     pub fn utf8_error(&self) -> Utf8Error {
1415         self.error
1416     }
1417 }
1418
1419 #[stable(feature = "rust1", since = "1.0.0")]
1420 impl fmt::Display for FromUtf8Error {
1421     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1422         fmt::Display::fmt(&self.error, f)
1423     }
1424 }
1425
1426 #[stable(feature = "rust1", since = "1.0.0")]
1427 impl fmt::Display for FromUtf16Error {
1428     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1429         fmt::Display::fmt("invalid utf-16: lone surrogate found", f)
1430     }
1431 }
1432
1433 #[stable(feature = "rust1", since = "1.0.0")]
1434 impl Clone for String {
1435     fn clone(&self) -> Self {
1436         String { vec: self.vec.clone() }
1437     }
1438
1439     fn clone_from(&mut self, source: &Self) {
1440         self.vec.clone_from(&source.vec);
1441     }
1442 }
1443
1444 #[stable(feature = "rust1", since = "1.0.0")]
1445 impl FromIterator<char> for String {
1446     fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> String {
1447         let mut buf = String::new();
1448         buf.extend(iter);
1449         buf
1450     }
1451 }
1452
1453 #[stable(feature = "rust1", since = "1.0.0")]
1454 impl<'a> FromIterator<&'a str> for String {
1455     fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> String {
1456         let mut buf = String::new();
1457         buf.extend(iter);
1458         buf
1459     }
1460 }
1461
1462 #[stable(feature = "extend_string", since = "1.4.0")]
1463 impl FromIterator<String> for String {
1464     fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> String {
1465         let mut buf = String::new();
1466         buf.extend(iter);
1467         buf
1468     }
1469 }
1470
1471 #[stable(feature = "rust1", since = "1.0.0")]
1472 impl Extend<char> for String {
1473     fn extend<I: IntoIterator<Item = char>>(&mut self, iter: I) {
1474         let iterator = iter.into_iter();
1475         let (lower_bound, _) = iterator.size_hint();
1476         self.reserve(lower_bound);
1477         for ch in iterator {
1478             self.push(ch)
1479         }
1480     }
1481 }
1482
1483 #[stable(feature = "extend_ref", since = "1.2.0")]
1484 impl<'a> Extend<&'a char> for String {
1485     fn extend<I: IntoIterator<Item = &'a char>>(&mut self, iter: I) {
1486         self.extend(iter.into_iter().cloned());
1487     }
1488 }
1489
1490 #[stable(feature = "rust1", since = "1.0.0")]
1491 impl<'a> Extend<&'a str> for String {
1492     fn extend<I: IntoIterator<Item = &'a str>>(&mut self, iter: I) {
1493         for s in iter {
1494             self.push_str(s)
1495         }
1496     }
1497 }
1498
1499 #[stable(feature = "extend_string", since = "1.4.0")]
1500 impl Extend<String> for String {
1501     fn extend<I: IntoIterator<Item = String>>(&mut self, iter: I) {
1502         for s in iter {
1503             self.push_str(&s)
1504         }
1505     }
1506 }
1507
1508 /// A convenience impl that delegates to the impl for `&str`
1509 #[unstable(feature = "pattern",
1510            reason = "API not fully fleshed out and ready to be stabilized",
1511            issue = "27721")]
1512 impl<'a, 'b> Pattern<'a> for &'b String {
1513     type Searcher = <&'b str as Pattern<'a>>::Searcher;
1514
1515     fn into_searcher(self, haystack: &'a str) -> <&'b str as Pattern<'a>>::Searcher {
1516         self[..].into_searcher(haystack)
1517     }
1518
1519     #[inline]
1520     fn is_contained_in(self, haystack: &'a str) -> bool {
1521         self[..].is_contained_in(haystack)
1522     }
1523
1524     #[inline]
1525     fn is_prefix_of(self, haystack: &'a str) -> bool {
1526         self[..].is_prefix_of(haystack)
1527     }
1528 }
1529
1530 #[stable(feature = "rust1", since = "1.0.0")]
1531 impl PartialEq for String {
1532     #[inline]
1533     fn eq(&self, other: &String) -> bool {
1534         PartialEq::eq(&self[..], &other[..])
1535     }
1536     #[inline]
1537     fn ne(&self, other: &String) -> bool {
1538         PartialEq::ne(&self[..], &other[..])
1539     }
1540 }
1541
1542 macro_rules! impl_eq {
1543     ($lhs:ty, $rhs: ty) => {
1544         #[stable(feature = "rust1", since = "1.0.0")]
1545         impl<'a, 'b> PartialEq<$rhs> for $lhs {
1546             #[inline]
1547             fn eq(&self, other: &$rhs) -> bool { PartialEq::eq(&self[..], &other[..]) }
1548             #[inline]
1549             fn ne(&self, other: &$rhs) -> bool { PartialEq::ne(&self[..], &other[..]) }
1550         }
1551
1552         #[stable(feature = "rust1", since = "1.0.0")]
1553         impl<'a, 'b> PartialEq<$lhs> for $rhs {
1554             #[inline]
1555             fn eq(&self, other: &$lhs) -> bool { PartialEq::eq(&self[..], &other[..]) }
1556             #[inline]
1557             fn ne(&self, other: &$lhs) -> bool { PartialEq::ne(&self[..], &other[..]) }
1558         }
1559
1560     }
1561 }
1562
1563 impl_eq! { String, str }
1564 impl_eq! { String, &'a str }
1565 impl_eq! { Cow<'a, str>, str }
1566 impl_eq! { Cow<'a, str>, &'b str }
1567 impl_eq! { Cow<'a, str>, String }
1568
1569 #[stable(feature = "rust1", since = "1.0.0")]
1570 impl Default for String {
1571     #[inline]
1572     fn default() -> String {
1573         String::new()
1574     }
1575 }
1576
1577 #[stable(feature = "rust1", since = "1.0.0")]
1578 impl fmt::Display for String {
1579     #[inline]
1580     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1581         fmt::Display::fmt(&**self, f)
1582     }
1583 }
1584
1585 #[stable(feature = "rust1", since = "1.0.0")]
1586 impl fmt::Debug for String {
1587     #[inline]
1588     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1589         fmt::Debug::fmt(&**self, f)
1590     }
1591 }
1592
1593 #[stable(feature = "rust1", since = "1.0.0")]
1594 impl hash::Hash for String {
1595     #[inline]
1596     fn hash<H: hash::Hasher>(&self, hasher: &mut H) {
1597         (**self).hash(hasher)
1598     }
1599 }
1600
1601 #[stable(feature = "rust1", since = "1.0.0")]
1602 impl<'a> Add<&'a str> for String {
1603     type Output = String;
1604
1605     #[inline]
1606     fn add(mut self, other: &str) -> String {
1607         self.push_str(other);
1608         self
1609     }
1610 }
1611
1612 #[stable(feature = "stringaddassign", since = "1.12.0")]
1613 impl<'a> AddAssign<&'a str> for String {
1614     #[inline]
1615     fn add_assign(&mut self, other: &str) {
1616         self.push_str(other);
1617     }
1618 }
1619
1620 #[stable(feature = "rust1", since = "1.0.0")]
1621 impl ops::Index<ops::Range<usize>> for String {
1622     type Output = str;
1623
1624     #[inline]
1625     fn index(&self, index: ops::Range<usize>) -> &str {
1626         &self[..][index]
1627     }
1628 }
1629 #[stable(feature = "rust1", since = "1.0.0")]
1630 impl ops::Index<ops::RangeTo<usize>> for String {
1631     type Output = str;
1632
1633     #[inline]
1634     fn index(&self, index: ops::RangeTo<usize>) -> &str {
1635         &self[..][index]
1636     }
1637 }
1638 #[stable(feature = "rust1", since = "1.0.0")]
1639 impl ops::Index<ops::RangeFrom<usize>> for String {
1640     type Output = str;
1641
1642     #[inline]
1643     fn index(&self, index: ops::RangeFrom<usize>) -> &str {
1644         &self[..][index]
1645     }
1646 }
1647 #[stable(feature = "rust1", since = "1.0.0")]
1648 impl ops::Index<ops::RangeFull> for String {
1649     type Output = str;
1650
1651     #[inline]
1652     fn index(&self, _index: ops::RangeFull) -> &str {
1653         unsafe { str::from_utf8_unchecked(&self.vec) }
1654     }
1655 }
1656 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1657 impl ops::Index<ops::RangeInclusive<usize>> for String {
1658     type Output = str;
1659
1660     #[inline]
1661     fn index(&self, index: ops::RangeInclusive<usize>) -> &str {
1662         Index::index(&**self, index)
1663     }
1664 }
1665 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1666 impl ops::Index<ops::RangeToInclusive<usize>> for String {
1667     type Output = str;
1668
1669     #[inline]
1670     fn index(&self, index: ops::RangeToInclusive<usize>) -> &str {
1671         Index::index(&**self, index)
1672     }
1673 }
1674
1675 #[stable(feature = "derefmut_for_string", since = "1.2.0")]
1676 impl ops::IndexMut<ops::Range<usize>> for String {
1677     #[inline]
1678     fn index_mut(&mut self, index: ops::Range<usize>) -> &mut str {
1679         &mut self[..][index]
1680     }
1681 }
1682 #[stable(feature = "derefmut_for_string", since = "1.2.0")]
1683 impl ops::IndexMut<ops::RangeTo<usize>> for String {
1684     #[inline]
1685     fn index_mut(&mut self, index: ops::RangeTo<usize>) -> &mut str {
1686         &mut self[..][index]
1687     }
1688 }
1689 #[stable(feature = "derefmut_for_string", since = "1.2.0")]
1690 impl ops::IndexMut<ops::RangeFrom<usize>> for String {
1691     #[inline]
1692     fn index_mut(&mut self, index: ops::RangeFrom<usize>) -> &mut str {
1693         &mut self[..][index]
1694     }
1695 }
1696 #[stable(feature = "derefmut_for_string", since = "1.2.0")]
1697 impl ops::IndexMut<ops::RangeFull> for String {
1698     #[inline]
1699     fn index_mut(&mut self, _index: ops::RangeFull) -> &mut str {
1700         unsafe { mem::transmute(&mut *self.vec) }
1701     }
1702 }
1703 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1704 impl ops::IndexMut<ops::RangeInclusive<usize>> for String {
1705     #[inline]
1706     fn index_mut(&mut self, index: ops::RangeInclusive<usize>) -> &mut str {
1707         IndexMut::index_mut(&mut **self, index)
1708     }
1709 }
1710 #[unstable(feature = "inclusive_range", reason = "recently added, follows RFC", issue = "28237")]
1711 impl ops::IndexMut<ops::RangeToInclusive<usize>> for String {
1712     #[inline]
1713     fn index_mut(&mut self, index: ops::RangeToInclusive<usize>) -> &mut str {
1714         IndexMut::index_mut(&mut **self, index)
1715     }
1716 }
1717
1718 #[stable(feature = "rust1", since = "1.0.0")]
1719 impl ops::Deref for String {
1720     type Target = str;
1721
1722     #[inline]
1723     fn deref(&self) -> &str {
1724         unsafe { str::from_utf8_unchecked(&self.vec) }
1725     }
1726 }
1727
1728 #[stable(feature = "derefmut_for_string", since = "1.2.0")]
1729 impl ops::DerefMut for String {
1730     #[inline]
1731     fn deref_mut(&mut self) -> &mut str {
1732         unsafe { mem::transmute(&mut *self.vec) }
1733     }
1734 }
1735
1736 /// An error when parsing a `String`.
1737 ///
1738 /// This `enum` is slightly awkward: it will never actually exist. This error is
1739 /// part of the type signature of the implementation of [`FromStr`] on
1740 /// [`String`]. The return type of [`from_str()`], requires that an error be
1741 /// defined, but, given that a [`String`] can always be made into a new
1742 /// [`String`] without error, this type will never actually be returned. As
1743 /// such, it is only here to satisfy said signature, and is useless otherwise.
1744 ///
1745 /// [`FromStr`]: ../../std/str/trait.FromStr.html
1746 /// [`String`]: struct.String.html
1747 /// [`from_str()`]: ../../std/str/trait.FromStr.html#tymethod.from_str
1748 #[stable(feature = "str_parse_error", since = "1.5.0")]
1749 #[derive(Copy)]
1750 pub enum ParseError {}
1751
1752 #[stable(feature = "rust1", since = "1.0.0")]
1753 impl FromStr for String {
1754     type Err = ParseError;
1755     #[inline]
1756     fn from_str(s: &str) -> Result<String, ParseError> {
1757         Ok(String::from(s))
1758     }
1759 }
1760
1761 #[stable(feature = "str_parse_error", since = "1.5.0")]
1762 impl Clone for ParseError {
1763     fn clone(&self) -> ParseError {
1764         match *self {}
1765     }
1766 }
1767
1768 #[stable(feature = "str_parse_error", since = "1.5.0")]
1769 impl fmt::Debug for ParseError {
1770     fn fmt(&self, _: &mut fmt::Formatter) -> fmt::Result {
1771         match *self {}
1772     }
1773 }
1774
1775 #[stable(feature = "str_parse_error2", since = "1.8.0")]
1776 impl fmt::Display for ParseError {
1777     fn fmt(&self, _: &mut fmt::Formatter) -> fmt::Result {
1778         match *self {}
1779     }
1780 }
1781
1782 #[stable(feature = "str_parse_error", since = "1.5.0")]
1783 impl PartialEq for ParseError {
1784     fn eq(&self, _: &ParseError) -> bool {
1785         match *self {}
1786     }
1787 }
1788
1789 #[stable(feature = "str_parse_error", since = "1.5.0")]
1790 impl Eq for ParseError {}
1791
1792 /// A trait for converting a value to a `String`.
1793 ///
1794 /// This trait is automatically implemented for any type which implements the
1795 /// [`Display`] trait. As such, `ToString` shouldn't be implemented directly:
1796 /// [`Display`] should be implemented instead, and you get the `ToString`
1797 /// implementation for free.
1798 ///
1799 /// [`Display`]: ../../std/fmt/trait.Display.html
1800 #[stable(feature = "rust1", since = "1.0.0")]
1801 pub trait ToString {
1802     /// Converts the given value to a `String`.
1803     ///
1804     /// # Examples
1805     ///
1806     /// Basic usage:
1807     ///
1808     /// ```
1809     /// let i = 5;
1810     /// let five = String::from("5");
1811     ///
1812     /// assert_eq!(five, i.to_string());
1813     /// ```
1814     #[stable(feature = "rust1", since = "1.0.0")]
1815     fn to_string(&self) -> String;
1816 }
1817
1818 #[stable(feature = "rust1", since = "1.0.0")]
1819 impl<T: fmt::Display + ?Sized> ToString for T {
1820     #[inline]
1821     default fn to_string(&self) -> String {
1822         use core::fmt::Write;
1823         let mut buf = String::new();
1824         let _ = buf.write_fmt(format_args!("{}", self));
1825         buf.shrink_to_fit();
1826         buf
1827     }
1828 }
1829
1830 #[stable(feature = "str_to_string_specialization", since = "1.9.0")]
1831 impl ToString for str {
1832     #[inline]
1833     fn to_string(&self) -> String {
1834         String::from(self)
1835     }
1836 }
1837
1838 #[stable(feature = "rust1", since = "1.0.0")]
1839 impl AsRef<str> for String {
1840     #[inline]
1841     fn as_ref(&self) -> &str {
1842         self
1843     }
1844 }
1845
1846 #[stable(feature = "rust1", since = "1.0.0")]
1847 impl AsRef<[u8]> for String {
1848     #[inline]
1849     fn as_ref(&self) -> &[u8] {
1850         self.as_bytes()
1851     }
1852 }
1853
1854 #[stable(feature = "rust1", since = "1.0.0")]
1855 impl<'a> From<&'a str> for String {
1856     fn from(s: &'a str) -> String {
1857         s.to_owned()
1858     }
1859 }
1860
1861 #[stable(feature = "rust1", since = "1.0.0")]
1862 impl<'a> From<&'a str> for Cow<'a, str> {
1863     #[inline]
1864     fn from(s: &'a str) -> Cow<'a, str> {
1865         Cow::Borrowed(s)
1866     }
1867 }
1868
1869 #[stable(feature = "rust1", since = "1.0.0")]
1870 impl<'a> From<String> for Cow<'a, str> {
1871     #[inline]
1872     fn from(s: String) -> Cow<'a, str> {
1873         Cow::Owned(s)
1874     }
1875 }
1876
1877 #[stable(feature = "cow_str_from_iter", since = "1.12.0")]
1878 impl<'a> FromIterator<char> for Cow<'a, str> {
1879     fn from_iter<I: IntoIterator<Item = char>>(it: I) -> Cow<'a, str> {
1880         Cow::Owned(FromIterator::from_iter(it))
1881     }
1882 }
1883
1884 #[stable(feature = "cow_str_from_iter", since = "1.12.0")]
1885 impl<'a, 'b> FromIterator<&'b str> for Cow<'a, str> {
1886     fn from_iter<I: IntoIterator<Item = &'b str>>(it: I) -> Cow<'a, str> {
1887         Cow::Owned(FromIterator::from_iter(it))
1888     }
1889 }
1890
1891 #[stable(feature = "cow_str_from_iter", since = "1.12.0")]
1892 impl<'a> FromIterator<String> for Cow<'a, str> {
1893     fn from_iter<I: IntoIterator<Item = String>>(it: I) -> Cow<'a, str> {
1894         Cow::Owned(FromIterator::from_iter(it))
1895     }
1896 }
1897
1898 #[stable(feature = "rust1", since = "1.0.0")]
1899 impl Into<Vec<u8>> for String {
1900     fn into(self) -> Vec<u8> {
1901         self.into_bytes()
1902     }
1903 }
1904
1905 #[stable(feature = "stringfromchars", since = "1.12.0")]
1906 impl<'a> From<&'a [char]> for String {
1907     #[inline]
1908     fn from(v: &'a [char]) -> String {
1909         let mut s = String::with_capacity(v.len());
1910         for c in v {
1911             s.push(*c);
1912         }
1913         s
1914     }
1915 }
1916
1917 #[stable(feature = "stringfromchars", since = "1.12.0")]
1918 impl From<Vec<char>> for String {
1919     #[inline]
1920     fn from(v: Vec<char>) -> String {
1921         String::from(v.as_slice())
1922     }
1923 }
1924
1925 #[stable(feature = "rust1", since = "1.0.0")]
1926 impl fmt::Write for String {
1927     #[inline]
1928     fn write_str(&mut self, s: &str) -> fmt::Result {
1929         self.push_str(s);
1930         Ok(())
1931     }
1932
1933     #[inline]
1934     fn write_char(&mut self, c: char) -> fmt::Result {
1935         self.push(c);
1936         Ok(())
1937     }
1938 }
1939
1940 /// A draining iterator for `String`.
1941 ///
1942 /// This struct is created by the [`drain()`] method on [`String`]. See its
1943 /// documentation for more.
1944 ///
1945 /// [`drain()`]: struct.String.html#method.drain
1946 /// [`String`]: struct.String.html
1947 #[stable(feature = "drain", since = "1.6.0")]
1948 pub struct Drain<'a> {
1949     /// Will be used as &'a mut String in the destructor
1950     string: *mut String,
1951     /// Start of part to remove
1952     start: usize,
1953     /// End of part to remove
1954     end: usize,
1955     /// Current remaining range to remove
1956     iter: Chars<'a>,
1957 }
1958
1959 #[stable(feature = "drain", since = "1.6.0")]
1960 unsafe impl<'a> Sync for Drain<'a> {}
1961 #[stable(feature = "drain", since = "1.6.0")]
1962 unsafe impl<'a> Send for Drain<'a> {}
1963
1964 #[stable(feature = "drain", since = "1.6.0")]
1965 impl<'a> Drop for Drain<'a> {
1966     fn drop(&mut self) {
1967         unsafe {
1968             // Use Vec::drain. "Reaffirm" the bounds checks to avoid
1969             // panic code being inserted again.
1970             let self_vec = (*self.string).as_mut_vec();
1971             if self.start <= self.end && self.end <= self_vec.len() {
1972                 self_vec.drain(self.start..self.end);
1973             }
1974         }
1975     }
1976 }
1977
1978 #[stable(feature = "drain", since = "1.6.0")]
1979 impl<'a> Iterator for Drain<'a> {
1980     type Item = char;
1981
1982     #[inline]
1983     fn next(&mut self) -> Option<char> {
1984         self.iter.next()
1985     }
1986
1987     fn size_hint(&self) -> (usize, Option<usize>) {
1988         self.iter.size_hint()
1989     }
1990 }
1991
1992 #[stable(feature = "drain", since = "1.6.0")]
1993 impl<'a> DoubleEndedIterator for Drain<'a> {
1994     #[inline]
1995     fn next_back(&mut self) -> Option<char> {
1996         self.iter.next_back()
1997     }
1998 }