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