src/liballoc/str.rs

   1 // Copyright 2012-2017 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 //! Unicode string slices.
  12 //!
  13 //! The `&str` type is one of the two main string types, the other being `String`.
  14 //! Unlike its `String` counterpart, its contents are borrowed.
  15 //!
  16 //! # Basic Usage
  17 //!
  18 //! A basic string declaration of `&str` type:
  19 //!
  20 //! ```
  21 //! let hello_world = "Hello, World!";
  22 //! ```
  23 //!
  24 //! Here we have declared a string literal, also known as a string slice.
  25 //! String literals have a static lifetime, which means the string `hello_world`
  26 //! is guaranteed to be valid for the duration of the entire program.
  27 //! We can explicitly specify `hello_world`'s lifetime as well:
  28 //!
  29 //! ```
  30 //! let hello_world: &'static str = "Hello, world!";
  31 //! ```
  32 //!
  33 //! *[See also the `str` primitive type](../../std/primitive.str.html).*
  34
  35 #![stable(feature = "rust1", since = "1.0.0")]
  36
  37 // Many of the usings in this module are only used in the test configuration.
  38 // It's cleaner to just turn off the unused_imports warning than to fix them.
  39 #![allow(unused_imports)]
  40
  41 use core::fmt;
  42 use core::str as core_str;
  43 use core::str::pattern::Pattern;
  44 use core::str::pattern::{Searcher, ReverseSearcher, DoubleEndedSearcher};
  45 use core::mem;
  46 use core::iter::FusedIterator;
  47 use std_unicode::str::{UnicodeStr, Utf16Encoder};
  48
  49 use vec_deque::VecDeque;
  50 use borrow::{Borrow, ToOwned};
  51 use string::String;
  52 use std_unicode;
  53 use vec::Vec;
  54 use slice::{SliceConcatExt, SliceIndex};
  55 use boxed::Box;
  56
  57 #[stable(feature = "rust1", since = "1.0.0")]
  58 pub use core::str::{FromStr, Utf8Error};
  59 #[allow(deprecated)]
  60 #[stable(feature = "rust1", since = "1.0.0")]
  61 pub use core::str::{Lines, LinesAny};
  62 #[stable(feature = "rust1", since = "1.0.0")]
  63 pub use core::str::{Split, RSplit};
  64 #[stable(feature = "rust1", since = "1.0.0")]
  65 pub use core::str::{SplitN, RSplitN};
  66 #[stable(feature = "rust1", since = "1.0.0")]
  67 pub use core::str::{SplitTerminator, RSplitTerminator};
  68 #[stable(feature = "rust1", since = "1.0.0")]
  69 pub use core::str::{Matches, RMatches};
  70 #[stable(feature = "rust1", since = "1.0.0")]
  71 pub use core::str::{MatchIndices, RMatchIndices};
  72 #[stable(feature = "rust1", since = "1.0.0")]
  73 pub use core::str::{from_utf8, from_utf8_mut, Chars, CharIndices, Bytes};
  74 #[stable(feature = "rust1", since = "1.0.0")]
  75 pub use core::str::{from_utf8_unchecked, from_utf8_unchecked_mut, ParseBoolError};
  76 #[stable(feature = "rust1", since = "1.0.0")]
  77 pub use std_unicode::str::SplitWhitespace;
  78 #[stable(feature = "rust1", since = "1.0.0")]
  79 pub use core::str::pattern;
  80
  81
  82 #[unstable(feature = "slice_concat_ext",
  83            reason = "trait should not have to exist",
  84            issue = "27747")]
  85 impl<S: Borrow<str>> SliceConcatExt<str> for [S] {
  86     type Output = String;
  87
  88     fn concat(&self) -> String {
  89         if self.is_empty() {
  90             return String::new();
  91         }
  92
  93         // `len` calculation may overflow but push_str will check boundaries
  94         let len = self.iter().map(|s| s.borrow().len()).sum();
  95         let mut result = String::with_capacity(len);
  96
  97         for s in self {
  98             result.push_str(s.borrow())
  99         }
 100
 101         result
 102     }
 103
 104     fn join(&self, sep: &str) -> String {
 105         if self.is_empty() {
 106             return String::new();
 107         }
 108
 109         // concat is faster
 110         if sep.is_empty() {
 111             return self.concat();
 112         }
 113
 114         // this is wrong without the guarantee that `self` is non-empty
 115         // `len` calculation may overflow but push_str but will check boundaries
 116         let len = sep.len() * (self.len() - 1) +
 117                   self.iter().map(|s| s.borrow().len()).sum::<usize>();
 118         let mut result = String::with_capacity(len);
 119         let mut first = true;
 120
 121         for s in self {
 122             if first {
 123                 first = false;
 124             } else {
 125                 result.push_str(sep);
 126             }
 127             result.push_str(s.borrow());
 128         }
 129         result
 130     }
 131
 132     fn connect(&self, sep: &str) -> String {
 133         self.join(sep)
 134     }
 135 }
 136
 137 /// An iterator of [`u16`] over the string encoded as UTF-16.
 138 ///
 139 /// [`u16`]: ../../std/primitive.u16.html
 140 ///
 141 /// This struct is created by the [`encode_utf16`] method on [`str`].
 142 /// See its documentation for more.
 143 ///
 144 /// [`encode_utf16`]: ../../std/primitive.str.html#method.encode_utf16
 145 /// [`str`]: ../../std/primitive.str.html
 146 #[derive(Clone)]
 147 #[stable(feature = "encode_utf16", since = "1.8.0")]
 148 pub struct EncodeUtf16<'a> {
 149     encoder: Utf16Encoder<Chars<'a>>,
 150 }
 151
 152 #[stable(feature = "collection_debug", since = "1.17.0")]
 153 impl<'a> fmt::Debug for EncodeUtf16<'a> {
 154     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 155         f.pad("EncodeUtf16 { .. }")
 156     }
 157 }
 158
 159 #[stable(feature = "encode_utf16", since = "1.8.0")]
 160 impl<'a> Iterator for EncodeUtf16<'a> {
 161     type Item = u16;
 162
 163     #[inline]
 164     fn next(&mut self) -> Option<u16> {
 165         self.encoder.next()
 166     }
 167
 168     #[inline]
 169     fn size_hint(&self) -> (usize, Option<usize>) {
 170         self.encoder.size_hint()
 171     }
 172 }
 173
 174 #[unstable(feature = "fused", issue = "35602")]
 175 impl<'a> FusedIterator for EncodeUtf16<'a> {}
 176
 177 #[stable(feature = "rust1", since = "1.0.0")]
 178 impl Borrow<str> for String {
 179     #[inline]
 180     fn borrow(&self) -> &str {
 181         &self[..]
 182     }
 183 }
 184
 185 #[stable(feature = "rust1", since = "1.0.0")]
 186 impl ToOwned for str {
 187     type Owned = String;
 188     fn to_owned(&self) -> String {
 189         unsafe { String::from_utf8_unchecked(self.as_bytes().to_owned()) }
 190     }
 191
 192     fn clone_into(&self, target: &mut String) {
 193         let mut b = mem::replace(target, String::new()).into_bytes();
 194         self.as_bytes().clone_into(&mut b);
 195         *target = unsafe { String::from_utf8_unchecked(b) }
 196     }
 197 }
 198
 199 /// Methods for string slices.
 200 #[lang = "str"]
 201 #[cfg(not(test))]
 202 impl str {
 203     /// Returns the length of `self`.
 204     ///
 205     /// This length is in bytes, not [`char`]s or graphemes. In other words,
 206     /// it may not be what a human considers the length of the string.
 207     ///
 208     /// [`char`]: primitive.char.html
 209     ///
 210     /// # Examples
 211     ///
 212     /// Basic usage:
 213     ///
 214     /// ```
 215     /// let len = "foo".len();
 216     /// assert_eq!(3, len);
 217     ///
 218     /// let len = "ƒoo".len(); // fancy f!
 219     /// assert_eq!(4, len);
 220     /// ```
 221     #[stable(feature = "rust1", since = "1.0.0")]
 222     #[inline]
 223     pub fn len(&self) -> usize {
 224         core_str::StrExt::len(self)
 225     }
 226
 227     /// Returns `true` if `self` has a length of zero bytes.
 228     ///
 229     /// # Examples
 230     ///
 231     /// Basic usage:
 232     ///
 233     /// ```
 234     /// let s = "";
 235     /// assert!(s.is_empty());
 236     ///
 237     /// let s = "not empty";
 238     /// assert!(!s.is_empty());
 239     /// ```
 240     #[inline]
 241     #[stable(feature = "rust1", since = "1.0.0")]
 242     pub fn is_empty(&self) -> bool {
 243         core_str::StrExt::is_empty(self)
 244     }
 245
 246     /// Checks that `index`-th byte lies at the start and/or end of a
 247     /// UTF-8 code point sequence.
 248     ///
 249     /// The start and end of the string (when `index == self.len()`) are
 250     /// considered to be
 251     /// boundaries.
 252     ///
 253     /// Returns `false` if `index` is greater than `self.len()`.
 254     ///
 255     /// # Examples
 256     ///
 257     /// ```
 258     /// let s = "Löwe 老虎 Léopard";
 259     /// assert!(s.is_char_boundary(0));
 260     /// // start of `老`
 261     /// assert!(s.is_char_boundary(6));
 262     /// assert!(s.is_char_boundary(s.len()));
 263     ///
 264     /// // second byte of `ö`
 265     /// assert!(!s.is_char_boundary(2));
 266     ///
 267     /// // third byte of `老`
 268     /// assert!(!s.is_char_boundary(8));
 269     /// ```
 270     #[stable(feature = "is_char_boundary", since = "1.9.0")]
 271     #[inline]
 272     pub fn is_char_boundary(&self, index: usize) -> bool {
 273         core_str::StrExt::is_char_boundary(self, index)
 274     }
 275
 276     /// Converts a string slice to a byte slice. To convert the byte slice back
 277     /// into a string slice, use the [`str::from_utf8`] function.
 278     ///
 279     /// [`str::from_utf8`]: ./str/fn.from_utf8.html
 280     ///
 281     /// # Examples
 282     ///
 283     /// Basic usage:
 284     ///
 285     /// ```
 286     /// let bytes = "bors".as_bytes();
 287     /// assert_eq!(b"bors", bytes);
 288     /// ```
 289     #[stable(feature = "rust1", since = "1.0.0")]
 290     #[inline(always)]
 291     pub fn as_bytes(&self) -> &[u8] {
 292         core_str::StrExt::as_bytes(self)
 293     }
 294
 295     /// Converts a mutable string slice to a mutable byte slice. To convert the
 296     /// mutable byte slice back into a mutable string slice, use the
 297     /// [`str::from_utf8_mut`] function.
 298     ///
 299     /// [`str::from_utf8_mut`]: ./str/fn.from_utf8_mut.html
 300     ///
 301     /// # Examples
 302     ///
 303     /// Basic usage:
 304     ///
 305     /// ```
 306     /// let mut s = String::from("Hello");
 307     /// let bytes = unsafe { s.as_bytes_mut() };
 308     ///
 309     /// assert_eq!(b"Hello", bytes);
 310     /// ```
 311     ///
 312     /// Mutability:
 313     ///
 314     /// ```
 315     /// let mut s = String::from("🗻∈🌏");
 316     ///
 317     /// unsafe {
 318     ///     let bytes = s.as_bytes_mut();
 319     ///
 320     ///     bytes[0] = 0xF0;
 321     ///     bytes[1] = 0x9F;
 322     ///     bytes[2] = 0x8D;
 323     ///     bytes[3] = 0x94;
 324     /// }
 325     ///
 326     /// assert_eq!("🍔∈🌏", s);
 327     /// ```
 328     #[stable(feature = "str_mut_extras", since = "1.20.0")]
 329     #[inline(always)]
 330     pub unsafe fn as_bytes_mut(&mut self) -> &mut [u8] {
 331         core_str::StrExt::as_bytes_mut(self)
 332     }
 333
 334     /// Converts a string slice to a raw pointer.
 335     ///
 336     /// As string slices are a slice of bytes, the raw pointer points to a
 337     /// [`u8`]. This pointer will be pointing to the first byte of the string
 338     /// slice.
 339     ///
 340     /// [`u8`]: primitive.u8.html
 341     ///
 342     /// # Examples
 343     ///
 344     /// Basic usage:
 345     ///
 346     /// ```
 347     /// let s = "Hello";
 348     /// let ptr = s.as_ptr();
 349     /// ```
 350     #[stable(feature = "rust1", since = "1.0.0")]
 351     #[inline]
 352     pub fn as_ptr(&self) -> *const u8 {
 353         core_str::StrExt::as_ptr(self)
 354     }
 355
 356     /// Returns a subslice of `str`.
 357     ///
 358     /// This is the non-panicking alternative to indexing the `str`. Returns
 359     /// [`None`] whenever equivalent indexing operation would panic.
 360     ///
 361     /// [`None`]: option/enum.Option.html#variant.None
 362     ///
 363     /// # Examples
 364     ///
 365     /// ```
 366     /// let mut v = String::from("🗻∈🌏");
 367     ///
 368     /// assert_eq!(Some("🗻"), v.get(0..4));
 369     ///
 370     /// // indices not on UTF-8 sequence boundaries
 371     /// assert!(v.get_mut(1..).is_none());
 372     /// assert!(v.get_mut(..8).is_none());
 373     ///
 374     /// // out of bounds
 375     /// assert!(v.get_mut(..42).is_none());
 376     /// ```
 377     #[stable(feature = "str_checked_slicing", since = "1.20.0")]
 378     #[inline]
 379     pub fn get<I: SliceIndex<str>>(&self, i: I) -> Option<&I::Output> {
 380         core_str::StrExt::get(self, i)
 381     }
 382
 383     /// Returns a mutable subslice of `str`.
 384     ///
 385     /// This is the non-panicking alternative to indexing the `str`. Returns
 386     /// [`None`] whenever equivalent indexing operation would panic.
 387     ///
 388     /// [`None`]: option/enum.Option.html#variant.None
 389     ///
 390     /// # Examples
 391     ///
 392     /// ```
 393     /// use std::ascii::AsciiExt;
 394     ///
 395     /// let mut v = String::from("hello");
 396     /// // correct length
 397     /// assert!(v.get_mut(0..5).is_some());
 398     /// // out of bounds
 399     /// assert!(v.get_mut(..42).is_none());
 400     /// assert_eq!(Some("he"), v.get_mut(0..2).map(|v| &*v));
 401     ///
 402     /// assert_eq!("hello", v);
 403     /// {
 404     ///     let s = v.get_mut(0..2);
 405     ///     let s = s.map(|s| {
 406     ///         s.make_ascii_uppercase();
 407     ///         &*s
 408     ///     });
 409     ///     assert_eq!(Some("HE"), s);
 410     /// }
 411     /// assert_eq!("HEllo", v);
 412     /// ```
 413     #[stable(feature = "str_checked_slicing", since = "1.20.0")]
 414     #[inline]
 415     pub fn get_mut<I: SliceIndex<str>>(&mut self, i: I) -> Option<&mut I::Output> {
 416         core_str::StrExt::get_mut(self, i)
 417     }
 418
 419     /// Returns a unchecked subslice of `str`.
 420     ///
 421     /// This is the unchecked alternative to indexing the `str`.
 422     ///
 423     /// # Safety
 424     ///
 425     /// Callers of this function are responsible that these preconditions are
 426     /// satisfied:
 427     ///
 428     /// * The starting index must come before the ending index;
 429     /// * Indexes must be within bounds of the original slice;
 430     /// * Indexes must lie on UTF-8 sequence boundaries.
 431     ///
 432     /// Failing that, the returned string slice may reference invalid memory or
 433     /// violate the invariants communicated by the `str` type.
 434     ///
 435     /// # Examples
 436     ///
 437     /// ```
 438     /// let v = "🗻∈🌏";
 439     /// unsafe {
 440     ///     assert_eq!("🗻", v.get_unchecked(0..4));
 441     ///     assert_eq!("∈", v.get_unchecked(4..7));
 442     ///     assert_eq!("🌏", v.get_unchecked(7..11));
 443     /// }
 444     /// ```
 445     #[stable(feature = "str_checked_slicing", since = "1.20.0")]
 446     #[inline]
 447     pub unsafe fn get_unchecked<I: SliceIndex<str>>(&self, i: I) -> &I::Output {
 448         core_str::StrExt::get_unchecked(self, i)
 449     }
 450
 451     /// Returns a mutable, unchecked subslice of `str`.
 452     ///
 453     /// This is the unchecked alternative to indexing the `str`.
 454     ///
 455     /// # Safety
 456     ///
 457     /// Callers of this function are responsible that these preconditions are
 458     /// satisfied:
 459     ///
 460     /// * The starting index must come before the ending index;
 461     /// * Indexes must be within bounds of the original slice;
 462     /// * Indexes must lie on UTF-8 sequence boundaries.
 463     ///
 464     /// Failing that, the returned string slice may reference invalid memory or
 465     /// violate the invariants communicated by the `str` type.
 466     ///
 467     /// # Examples
 468     ///
 469     /// ```
 470     /// let mut v = String::from("🗻∈🌏");
 471     /// unsafe {
 472     ///     assert_eq!("🗻", v.get_unchecked_mut(0..4));
 473     ///     assert_eq!("∈", v.get_unchecked_mut(4..7));
 474     ///     assert_eq!("🌏", v.get_unchecked_mut(7..11));
 475     /// }
 476     /// ```
 477     #[stable(feature = "str_checked_slicing", since = "1.20.0")]
 478     #[inline]
 479     pub unsafe fn get_unchecked_mut<I: SliceIndex<str>>(&mut self, i: I) -> &mut I::Output {
 480         core_str::StrExt::get_unchecked_mut(self, i)
 481     }
 482
 483     /// Creates a string slice from another string slice, bypassing safety
 484     /// checks.
 485     ///
 486     /// This is generally not recommended, use with caution! For a safe
 487     /// alternative see [`str`] and [`Index`].
 488     ///
 489     /// [`str`]: primitive.str.html
 490     /// [`Index`]: ops/trait.Index.html
 491     ///
 492     /// This new slice goes from `begin` to `end`, including `begin` but
 493     /// excluding `end`.
 494     ///
 495     /// To get a mutable string slice instead, see the
 496     /// [`slice_mut_unchecked`] method.
 497     ///
 498     /// [`slice_mut_unchecked`]: #method.slice_mut_unchecked
 499     ///
 500     /// # Safety
 501     ///
 502     /// Callers of this function are responsible that three preconditions are
 503     /// satisfied:
 504     ///
 505     /// * `begin` must come before `end`.
 506     /// * `begin` and `end` must be byte positions within the string slice.
 507     /// * `begin` and `end` must lie on UTF-8 sequence boundaries.
 508     ///
 509     /// # Examples
 510     ///
 511     /// Basic usage:
 512     ///
 513     /// ```
 514     /// let s = "Löwe 老虎 Léopard";
 515     ///
 516     /// unsafe {
 517     ///     assert_eq!("Löwe 老虎 Léopard", s.slice_unchecked(0, 21));
 518     /// }
 519     ///
 520     /// let s = "Hello, world!";
 521     ///
 522     /// unsafe {
 523     ///     assert_eq!("world", s.slice_unchecked(7, 12));
 524     /// }
 525     /// ```
 526     #[stable(feature = "rust1", since = "1.0.0")]
 527     #[inline]
 528     pub unsafe fn slice_unchecked(&self, begin: usize, end: usize) -> &str {
 529         core_str::StrExt::slice_unchecked(self, begin, end)
 530     }
 531
 532     /// Creates a string slice from another string slice, bypassing safety
 533     /// checks.
 534     /// This is generally not recommended, use with caution! For a safe
 535     /// alternative see [`str`] and [`IndexMut`].
 536     ///
 537     /// [`str`]: primitive.str.html
 538     /// [`IndexMut`]: ops/trait.IndexMut.html
 539     ///
 540     /// This new slice goes from `begin` to `end`, including `begin` but
 541     /// excluding `end`.
 542     ///
 543     /// To get an immutable string slice instead, see the
 544     /// [`slice_unchecked`] method.
 545     ///
 546     /// [`slice_unchecked`]: #method.slice_unchecked
 547     ///
 548     /// # Safety
 549     ///
 550     /// Callers of this function are responsible that three preconditions are
 551     /// satisfied:
 552     ///
 553     /// * `begin` must come before `end`.
 554     /// * `begin` and `end` must be byte positions within the string slice.
 555     /// * `begin` and `end` must lie on UTF-8 sequence boundaries.
 556     #[stable(feature = "str_slice_mut", since = "1.5.0")]
 557     #[inline]
 558     pub unsafe fn slice_mut_unchecked(&mut self, begin: usize, end: usize) -> &mut str {
 559         core_str::StrExt::slice_mut_unchecked(self, begin, end)
 560     }
 561
 562     /// Divide one string slice into two at an index.
 563     ///
 564     /// The argument, `mid`, should be a byte offset from the start of the
 565     /// string. It must also be on the boundary of a UTF-8 code point.
 566     ///
 567     /// The two slices returned go from the start of the string slice to `mid`,
 568     /// and from `mid` to the end of the string slice.
 569     ///
 570     /// To get mutable string slices instead, see the [`split_at_mut`]
 571     /// method.
 572     ///
 573     /// [`split_at_mut`]: #method.split_at_mut
 574     ///
 575     /// # Panics
 576     ///
 577     /// Panics if `mid` is not on a UTF-8 code point boundary, or if it is
 578     /// beyond the last code point of the string slice.
 579     ///
 580     /// # Examples
 581     ///
 582     /// Basic usage:
 583     ///
 584     /// ```
 585     /// let s = "Per Martin-Löf";
 586     ///
 587     /// let (first, last) = s.split_at(3);
 588     ///
 589     /// assert_eq!("Per", first);
 590     /// assert_eq!(" Martin-Löf", last);
 591     /// ```
 592     #[inline]
 593     #[stable(feature = "str_split_at", since = "1.4.0")]
 594     pub fn split_at(&self, mid: usize) -> (&str, &str) {
 595         core_str::StrExt::split_at(self, mid)
 596     }
 597
 598     /// Divide one mutable string slice into two at an index.
 599     ///
 600     /// The argument, `mid`, should be a byte offset from the start of the
 601     /// string. It must also be on the boundary of a UTF-8 code point.
 602     ///
 603     /// The two slices returned go from the start of the string slice to `mid`,
 604     /// and from `mid` to the end of the string slice.
 605     ///
 606     /// To get immutable string slices instead, see the [`split_at`] method.
 607     ///
 608     /// [`split_at`]: #method.split_at
 609     ///
 610     /// # Panics
 611     ///
 612     /// Panics if `mid` is not on a UTF-8 code point boundary, or if it is
 613     /// beyond the last code point of the string slice.
 614     ///
 615     /// # Examples
 616     ///
 617     /// Basic usage:
 618     ///
 619     /// ```
 620     /// use std::ascii::AsciiExt;
 621     ///
 622     /// let mut s = "Per Martin-Löf".to_string();
 623     /// {
 624     ///     let (first, last) = s.split_at_mut(3);
 625     ///     first.make_ascii_uppercase();
 626     ///     assert_eq!("PER", first);
 627     ///     assert_eq!(" Martin-Löf", last);
 628     /// }
 629     /// assert_eq!("PER Martin-Löf", s);
 630     /// ```
 631     #[inline]
 632     #[stable(feature = "str_split_at", since = "1.4.0")]
 633     pub fn split_at_mut(&mut self, mid: usize) -> (&mut str, &mut str) {
 634         core_str::StrExt::split_at_mut(self, mid)
 635     }
 636
 637     /// Returns an iterator over the [`char`]s of a string slice.
 638     ///
 639     /// As a string slice consists of valid UTF-8, we can iterate through a
 640     /// string slice by [`char`]. This method returns such an iterator.
 641     ///
 642     /// It's important to remember that [`char`] represents a Unicode Scalar
 643     /// Value, and may not match your idea of what a 'character' is. Iteration
 644     /// over grapheme clusters may be what you actually want.
 645     ///
 646     /// [`char`]: primitive.char.html
 647     ///
 648     /// # Examples
 649     ///
 650     /// Basic usage:
 651     ///
 652     /// ```
 653     /// let word = "goodbye";
 654     ///
 655     /// let count = word.chars().count();
 656     /// assert_eq!(7, count);
 657     ///
 658     /// let mut chars = word.chars();
 659     ///
 660     /// assert_eq!(Some('g'), chars.next());
 661     /// assert_eq!(Some('o'), chars.next());
 662     /// assert_eq!(Some('o'), chars.next());
 663     /// assert_eq!(Some('d'), chars.next());
 664     /// assert_eq!(Some('b'), chars.next());
 665     /// assert_eq!(Some('y'), chars.next());
 666     /// assert_eq!(Some('e'), chars.next());
 667     ///
 668     /// assert_eq!(None, chars.next());
 669     /// ```
 670     ///
 671     /// Remember, [`char`]s may not match your human intuition about characters:
 672     ///
 673     /// ```
 674     /// let y = "y̆";
 675     ///
 676     /// let mut chars = y.chars();
 677     ///
 678     /// assert_eq!(Some('y'), chars.next()); // not 'y̆'
 679     /// assert_eq!(Some('\u{0306}'), chars.next());
 680     ///
 681     /// assert_eq!(None, chars.next());
 682     /// ```
 683     #[stable(feature = "rust1", since = "1.0.0")]
 684     #[inline]
 685     pub fn chars(&self) -> Chars {
 686         core_str::StrExt::chars(self)
 687     }
 688     /// Returns an iterator over the [`char`]s of a string slice, and their
 689     /// positions.
 690     ///
 691     /// As a string slice consists of valid UTF-8, we can iterate through a
 692     /// string slice by [`char`]. This method returns an iterator of both
 693     /// these [`char`]s, as well as their byte positions.
 694     ///
 695     /// The iterator yields tuples. The position is first, the [`char`] is
 696     /// second.
 697     ///
 698     /// [`char`]: primitive.char.html
 699     ///
 700     /// # Examples
 701     ///
 702     /// Basic usage:
 703     ///
 704     /// ```
 705     /// let word = "goodbye";
 706     ///
 707     /// let count = word.char_indices().count();
 708     /// assert_eq!(7, count);
 709     ///
 710     /// let mut char_indices = word.char_indices();
 711     ///
 712     /// assert_eq!(Some((0, 'g')), char_indices.next());
 713     /// assert_eq!(Some((1, 'o')), char_indices.next());
 714     /// assert_eq!(Some((2, 'o')), char_indices.next());
 715     /// assert_eq!(Some((3, 'd')), char_indices.next());
 716     /// assert_eq!(Some((4, 'b')), char_indices.next());
 717     /// assert_eq!(Some((5, 'y')), char_indices.next());
 718     /// assert_eq!(Some((6, 'e')), char_indices.next());
 719     ///
 720     /// assert_eq!(None, char_indices.next());
 721     /// ```
 722     ///
 723     /// Remember, [`char`]s may not match your human intuition about characters:
 724     ///
 725     /// ```
 726     /// let y = "y̆";
 727     ///
 728     /// let mut char_indices = y.char_indices();
 729     ///
 730     /// assert_eq!(Some((0, 'y')), char_indices.next()); // not (0, 'y̆')
 731     /// assert_eq!(Some((1, '\u{0306}')), char_indices.next());
 732     ///
 733     /// assert_eq!(None, char_indices.next());
 734     /// ```
 735     #[stable(feature = "rust1", since = "1.0.0")]
 736     #[inline]
 737     pub fn char_indices(&self) -> CharIndices {
 738         core_str::StrExt::char_indices(self)
 739     }
 740
 741     /// An iterator over the bytes of a string slice.
 742     ///
 743     /// As a string slice consists of a sequence of bytes, we can iterate
 744     /// through a string slice by byte. This method returns such an iterator.
 745     ///
 746     /// # Examples
 747     ///
 748     /// Basic usage:
 749     ///
 750     /// ```
 751     /// let mut bytes = "bors".bytes();
 752     ///
 753     /// assert_eq!(Some(b'b'), bytes.next());
 754     /// assert_eq!(Some(b'o'), bytes.next());
 755     /// assert_eq!(Some(b'r'), bytes.next());
 756     /// assert_eq!(Some(b's'), bytes.next());
 757     ///
 758     /// assert_eq!(None, bytes.next());
 759     /// ```
 760     #[stable(feature = "rust1", since = "1.0.0")]
 761     #[inline]
 762     pub fn bytes(&self) -> Bytes {
 763         core_str::StrExt::bytes(self)
 764     }
 765
 766     /// Split a string slice by whitespace.
 767     ///
 768     /// The iterator returned will return string slices that are sub-slices of
 769     /// the original string slice, separated by any amount of whitespace.
 770     ///
 771     /// 'Whitespace' is defined according to the terms of the Unicode Derived
 772     /// Core Property `White_Space`.
 773     ///
 774     /// # Examples
 775     ///
 776     /// Basic usage:
 777     ///
 778     /// ```
 779     /// let mut iter = "A few words".split_whitespace();
 780     ///
 781     /// assert_eq!(Some("A"), iter.next());
 782     /// assert_eq!(Some("few"), iter.next());
 783     /// assert_eq!(Some("words"), iter.next());
 784     ///
 785     /// assert_eq!(None, iter.next());
 786     /// ```
 787     ///
 788     /// All kinds of whitespace are considered:
 789     ///
 790     /// ```
 791     /// let mut iter = " Mary   had\ta\u{2009}little  \n\t lamb".split_whitespace();
 792     /// assert_eq!(Some("Mary"), iter.next());
 793     /// assert_eq!(Some("had"), iter.next());
 794     /// assert_eq!(Some("a"), iter.next());
 795     /// assert_eq!(Some("little"), iter.next());
 796     /// assert_eq!(Some("lamb"), iter.next());
 797     ///
 798     /// assert_eq!(None, iter.next());
 799     /// ```
 800     #[stable(feature = "split_whitespace", since = "1.1.0")]
 801     #[inline]
 802     pub fn split_whitespace(&self) -> SplitWhitespace {
 803         UnicodeStr::split_whitespace(self)
 804     }
 805
 806     /// An iterator over the lines of a string, as string slices.
 807     ///
 808     /// Lines are ended with either a newline (`\n`) or a carriage return with
 809     /// a line feed (`\r\n`).
 810     ///
 811     /// The final line ending is optional.
 812     ///
 813     /// # Examples
 814     ///
 815     /// Basic usage:
 816     ///
 817     /// ```
 818     /// let text = "foo\r\nbar\n\nbaz\n";
 819     /// let mut lines = text.lines();
 820     ///
 821     /// assert_eq!(Some("foo"), lines.next());
 822     /// assert_eq!(Some("bar"), lines.next());
 823     /// assert_eq!(Some(""), lines.next());
 824     /// assert_eq!(Some("baz"), lines.next());
 825     ///
 826     /// assert_eq!(None, lines.next());
 827     /// ```
 828     ///
 829     /// The final line ending isn't required:
 830     ///
 831     /// ```
 832     /// let text = "foo\nbar\n\r\nbaz";
 833     /// let mut lines = text.lines();
 834     ///
 835     /// assert_eq!(Some("foo"), lines.next());
 836     /// assert_eq!(Some("bar"), lines.next());
 837     /// assert_eq!(Some(""), lines.next());
 838     /// assert_eq!(Some("baz"), lines.next());
 839     ///
 840     /// assert_eq!(None, lines.next());
 841     /// ```
 842     #[stable(feature = "rust1", since = "1.0.0")]
 843     #[inline]
 844     pub fn lines(&self) -> Lines {
 845         core_str::StrExt::lines(self)
 846     }
 847
 848     /// An iterator over the lines of a string.
 849     #[stable(feature = "rust1", since = "1.0.0")]
 850     #[rustc_deprecated(since = "1.4.0", reason = "use lines() instead now")]
 851     #[inline]
 852     #[allow(deprecated)]
 853     pub fn lines_any(&self) -> LinesAny {
 854         core_str::StrExt::lines_any(self)
 855     }
 856
 857     /// Returns an iterator of `u16` over the string encoded as UTF-16.
 858     #[stable(feature = "encode_utf16", since = "1.8.0")]
 859     pub fn encode_utf16(&self) -> EncodeUtf16 {
 860         EncodeUtf16 { encoder: Utf16Encoder::new(self[..].chars()) }
 861     }
 862
 863     /// Returns `true` if the given pattern matches a sub-slice of
 864     /// this string slice.
 865     ///
 866     /// Returns `false` if it does not.
 867     ///
 868     /// # Examples
 869     ///
 870     /// Basic usage:
 871     ///
 872     /// ```
 873     /// let bananas = "bananas";
 874     ///
 875     /// assert!(bananas.contains("nana"));
 876     /// assert!(!bananas.contains("apples"));
 877     /// ```
 878     #[stable(feature = "rust1", since = "1.0.0")]
 879     #[inline]
 880     pub fn contains<'a, P: Pattern<'a>>(&'a self, pat: P) -> bool {
 881         core_str::StrExt::contains(self, pat)
 882     }
 883
 884     /// Returns `true` if the given pattern matches a prefix of this
 885     /// string slice.
 886     ///
 887     /// Returns `false` if it does not.
 888     ///
 889     /// # Examples
 890     ///
 891     /// Basic usage:
 892     ///
 893     /// ```
 894     /// let bananas = "bananas";
 895     ///
 896     /// assert!(bananas.starts_with("bana"));
 897     /// assert!(!bananas.starts_with("nana"));
 898     /// ```
 899     #[stable(feature = "rust1", since = "1.0.0")]
 900     pub fn starts_with<'a, P: Pattern<'a>>(&'a self, pat: P) -> bool {
 901         core_str::StrExt::starts_with(self, pat)
 902     }
 903
 904     /// Returns `true` if the given pattern matches a suffix of this
 905     /// string slice.
 906     ///
 907     /// Returns `false` if it does not.
 908     ///
 909     /// # Examples
 910     ///
 911     /// Basic usage:
 912     ///
 913     /// ```
 914     /// let bananas = "bananas";
 915     ///
 916     /// assert!(bananas.ends_with("anas"));
 917     /// assert!(!bananas.ends_with("nana"));
 918     /// ```
 919     #[stable(feature = "rust1", since = "1.0.0")]
 920     pub fn ends_with<'a, P: Pattern<'a>>(&'a self, pat: P) -> bool
 921         where P::Searcher: ReverseSearcher<'a>
 922     {
 923         core_str::StrExt::ends_with(self, pat)
 924     }
 925
 926     /// Returns the byte index of the first character of this string slice that
 927     /// matches the pattern.
 928     ///
 929     /// Returns [`None`] if the pattern doesn't match.
 930     ///
 931     /// The pattern can be a `&str`, [`char`], or a closure that determines if
 932     /// a character matches.
 933     ///
 934     /// [`char`]: primitive.char.html
 935     /// [`None`]: option/enum.Option.html#variant.None
 936     ///
 937     /// # Examples
 938     ///
 939     /// Simple patterns:
 940     ///
 941     /// ```
 942     /// let s = "Löwe 老虎 Léopard";
 943     ///
 944     /// assert_eq!(s.find('L'), Some(0));
 945     /// assert_eq!(s.find('é'), Some(14));
 946     /// assert_eq!(s.find("Léopard"), Some(13));
 947     /// ```
 948     ///
 949     /// More complex patterns with closures:
 950     ///
 951     /// ```
 952     /// let s = "Löwe 老虎 Léopard";
 953     ///
 954     /// assert_eq!(s.find(char::is_whitespace), Some(5));
 955     /// assert_eq!(s.find(char::is_lowercase), Some(1));
 956     /// ```
 957     ///
 958     /// Not finding the pattern:
 959     ///
 960     /// ```
 961     /// let s = "Löwe 老虎 Léopard";
 962     /// let x: &[_] = &['1', '2'];
 963     ///
 964     /// assert_eq!(s.find(x), None);
 965     /// ```
 966     #[stable(feature = "rust1", since = "1.0.0")]
 967     #[inline]
 968     pub fn find<'a, P: Pattern<'a>>(&'a self, pat: P) -> Option<usize> {
 969         core_str::StrExt::find(self, pat)
 970     }
 971
 972     /// Returns the byte index of the last character of this string slice that
 973     /// matches the pattern.
 974     ///
 975     /// Returns [`None`] if the pattern doesn't match.
 976     ///
 977     /// The pattern can be a `&str`, [`char`], or a closure that determines if
 978     /// a character matches.
 979     ///
 980     /// [`char`]: primitive.char.html
 981     /// [`None`]: option/enum.Option.html#variant.None
 982     ///
 983     /// # Examples
 984     ///
 985     /// Simple patterns:
 986     ///
 987     /// ```
 988     /// let s = "Löwe 老虎 Léopard";
 989     ///
 990     /// assert_eq!(s.rfind('L'), Some(13));
 991     /// assert_eq!(s.rfind('é'), Some(14));
 992     /// ```
 993     ///
 994     /// More complex patterns with closures:
 995     ///
 996     /// ```
 997     /// let s = "Löwe 老虎 Léopard";
 998     ///
 999     /// assert_eq!(s.rfind(char::is_whitespace), Some(12));
1000     /// assert_eq!(s.rfind(char::is_lowercase), Some(20));
1001     /// ```
1002     ///
1003     /// Not finding the pattern:
1004     ///
1005     /// ```
1006     /// let s = "Löwe 老虎 Léopard";
1007     /// let x: &[_] = &['1', '2'];
1008     ///
1009     /// assert_eq!(s.rfind(x), None);
1010     /// ```
1011     #[stable(feature = "rust1", since = "1.0.0")]
1012     #[inline]
1013     pub fn rfind<'a, P: Pattern<'a>>(&'a self, pat: P) -> Option<usize>
1014         where P::Searcher: ReverseSearcher<'a>
1015     {
1016         core_str::StrExt::rfind(self, pat)
1017     }
1018
1019     /// An iterator over substrings of this string slice, separated by
1020     /// characters matched by a pattern.
1021     ///
1022     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1023     /// split.
1024     ///
1025     /// # Iterator behavior
1026     ///
1027     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1028     /// allows a reverse search and forward/reverse search yields the same
1029     /// elements. This is true for, eg, [`char`] but not for `&str`.
1030     ///
1031     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1032     ///
1033     /// If the pattern allows a reverse search but its results might differ
1034     /// from a forward search, the [`rsplit`] method can be used.
1035     ///
1036     /// [`char`]: primitive.char.html
1037     /// [`rsplit`]: #method.rsplit
1038     ///
1039     /// # Examples
1040     ///
1041     /// Simple patterns:
1042     ///
1043     /// ```
1044     /// let v: Vec<&str> = "Mary had a little lamb".split(' ').collect();
1045     /// assert_eq!(v, ["Mary", "had", "a", "little", "lamb"]);
1046     ///
1047     /// let v: Vec<&str> = "".split('X').collect();
1048     /// assert_eq!(v, [""]);
1049     ///
1050     /// let v: Vec<&str> = "lionXXtigerXleopard".split('X').collect();
1051     /// assert_eq!(v, ["lion", "", "tiger", "leopard"]);
1052     ///
1053     /// let v: Vec<&str> = "lion::tiger::leopard".split("::").collect();
1054     /// assert_eq!(v, ["lion", "tiger", "leopard"]);
1055     ///
1056     /// let v: Vec<&str> = "abc1def2ghi".split(char::is_numeric).collect();
1057     /// assert_eq!(v, ["abc", "def", "ghi"]);
1058     ///
1059     /// let v: Vec<&str> = "lionXtigerXleopard".split(char::is_uppercase).collect();
1060     /// assert_eq!(v, ["lion", "tiger", "leopard"]);
1061     /// ```
1062     ///
1063     /// A more complex pattern, using a closure:
1064     ///
1065     /// ```
1066     /// let v: Vec<&str> = "abc1defXghi".split(|c| c == '1' || c == 'X').collect();
1067     /// assert_eq!(v, ["abc", "def", "ghi"]);
1068     /// ```
1069     ///
1070     /// If a string contains multiple contiguous separators, you will end up
1071     /// with empty strings in the output:
1072     ///
1073     /// ```
1074     /// let x = "||||a||b|c".to_string();
1075     /// let d: Vec<_> = x.split('|').collect();
1076     ///
1077     /// assert_eq!(d, &["", "", "", "", "a", "", "b", "c"]);
1078     /// ```
1079     ///
1080     /// Contiguous separators are separated by the empty string.
1081     ///
1082     /// ```
1083     /// let x = "(///)".to_string();
1084     /// let d: Vec<_> = x.split('/').collect();
1085     ///
1086     /// assert_eq!(d, &["(", "", "", ")"]);
1087     /// ```
1088     ///
1089     /// Separators at the start or end of a string are neighbored
1090     /// by empty strings.
1091     ///
1092     /// ```
1093     /// let d: Vec<_> = "010".split("0").collect();
1094     /// assert_eq!(d, &["", "1", ""]);
1095     /// ```
1096     ///
1097     /// When the empty string is used as a separator, it separates
1098     /// every character in the string, along with the beginning
1099     /// and end of the string.
1100     ///
1101     /// ```
1102     /// let f: Vec<_> = "rust".split("").collect();
1103     /// assert_eq!(f, &["", "r", "u", "s", "t", ""]);
1104     /// ```
1105     ///
1106     /// Contiguous separators can lead to possibly surprising behavior
1107     /// when whitespace is used as the separator. This code is correct:
1108     ///
1109     /// ```
1110     /// let x = "    a  b c".to_string();
1111     /// let d: Vec<_> = x.split(' ').collect();
1112     ///
1113     /// assert_eq!(d, &["", "", "", "", "a", "", "b", "c"]);
1114     /// ```
1115     ///
1116     /// It does _not_ give you:
1117     ///
1118     /// ```,ignore
1119     /// assert_eq!(d, &["a", "b", "c"]);
1120     /// ```
1121     ///
1122     /// Use [`split_whitespace`] for this behavior.
1123     ///
1124     /// [`split_whitespace`]: #method.split_whitespace
1125     #[stable(feature = "rust1", since = "1.0.0")]
1126     #[inline]
1127     pub fn split<'a, P: Pattern<'a>>(&'a self, pat: P) -> Split<'a, P> {
1128         core_str::StrExt::split(self, pat)
1129     }
1130
1131     /// An iterator over substrings of the given string slice, separated by
1132     /// characters matched by a pattern and yielded in reverse order.
1133     ///
1134     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1135     /// split.
1136     ///
1137     /// [`char`]: primitive.char.html
1138     ///
1139     /// # Iterator behavior
1140     ///
1141     /// The returned iterator requires that the pattern supports a reverse
1142     /// search, and it will be a [`DoubleEndedIterator`] if a forward/reverse
1143     /// search yields the same elements.
1144     ///
1145     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1146     ///
1147     /// For iterating from the front, the [`split`] method can be used.
1148     ///
1149     /// [`split`]: #method.split
1150     ///
1151     /// # Examples
1152     ///
1153     /// Simple patterns:
1154     ///
1155     /// ```
1156     /// let v: Vec<&str> = "Mary had a little lamb".rsplit(' ').collect();
1157     /// assert_eq!(v, ["lamb", "little", "a", "had", "Mary"]);
1158     ///
1159     /// let v: Vec<&str> = "".rsplit('X').collect();
1160     /// assert_eq!(v, [""]);
1161     ///
1162     /// let v: Vec<&str> = "lionXXtigerXleopard".rsplit('X').collect();
1163     /// assert_eq!(v, ["leopard", "tiger", "", "lion"]);
1164     ///
1165     /// let v: Vec<&str> = "lion::tiger::leopard".rsplit("::").collect();
1166     /// assert_eq!(v, ["leopard", "tiger", "lion"]);
1167     /// ```
1168     ///
1169     /// A more complex pattern, using a closure:
1170     ///
1171     /// ```
1172     /// let v: Vec<&str> = "abc1defXghi".rsplit(|c| c == '1' || c == 'X').collect();
1173     /// assert_eq!(v, ["ghi", "def", "abc"]);
1174     /// ```
1175     #[stable(feature = "rust1", since = "1.0.0")]
1176     #[inline]
1177     pub fn rsplit<'a, P: Pattern<'a>>(&'a self, pat: P) -> RSplit<'a, P>
1178         where P::Searcher: ReverseSearcher<'a>
1179     {
1180         core_str::StrExt::rsplit(self, pat)
1181     }
1182
1183     /// An iterator over substrings of the given string slice, separated by
1184     /// characters matched by a pattern.
1185     ///
1186     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1187     /// split.
1188     ///
1189     /// Equivalent to [`split`], except that the trailing substring
1190     /// is skipped if empty.
1191     ///
1192     /// [`split`]: #method.split
1193     ///
1194     /// This method can be used for string data that is _terminated_,
1195     /// rather than _separated_ by a pattern.
1196     ///
1197     /// # Iterator behavior
1198     ///
1199     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1200     /// allows a reverse search and forward/reverse search yields the same
1201     /// elements. This is true for, eg, [`char`] but not for `&str`.
1202     ///
1203     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1204     /// [`char`]: primitive.char.html
1205     ///
1206     /// If the pattern allows a reverse search but its results might differ
1207     /// from a forward search, the [`rsplit_terminator`] method can be used.
1208     ///
1209     /// [`rsplit_terminator`]: #method.rsplit_terminator
1210     ///
1211     /// # Examples
1212     ///
1213     /// Basic usage:
1214     ///
1215     /// ```
1216     /// let v: Vec<&str> = "A.B.".split_terminator('.').collect();
1217     /// assert_eq!(v, ["A", "B"]);
1218     ///
1219     /// let v: Vec<&str> = "A..B..".split_terminator(".").collect();
1220     /// assert_eq!(v, ["A", "", "B", ""]);
1221     /// ```
1222     #[stable(feature = "rust1", since = "1.0.0")]
1223     #[inline]
1224     pub fn split_terminator<'a, P: Pattern<'a>>(&'a self, pat: P) -> SplitTerminator<'a, P> {
1225         core_str::StrExt::split_terminator(self, pat)
1226     }
1227
1228     /// An iterator over substrings of `self`, separated by characters
1229     /// matched by a pattern and yielded in reverse order.
1230     ///
1231     /// The pattern can be a simple `&str`, [`char`], or a closure that
1232     /// determines the split.
1233     /// Additional libraries might provide more complex patterns like
1234     /// regular expressions.
1235     ///
1236     /// [`char`]: primitive.char.html
1237     ///
1238     /// Equivalent to [`split`], except that the trailing substring is
1239     /// skipped if empty.
1240     ///
1241     /// [`split`]: #method.split
1242     ///
1243     /// This method can be used for string data that is _terminated_,
1244     /// rather than _separated_ by a pattern.
1245     ///
1246     /// # Iterator behavior
1247     ///
1248     /// The returned iterator requires that the pattern supports a
1249     /// reverse search, and it will be double ended if a forward/reverse
1250     /// search yields the same elements.
1251     ///
1252     /// For iterating from the front, the [`split_terminator`] method can be
1253     /// used.
1254     ///
1255     /// [`split_terminator`]: #method.split_terminator
1256     ///
1257     /// # Examples
1258     ///
1259     /// ```
1260     /// let v: Vec<&str> = "A.B.".rsplit_terminator('.').collect();
1261     /// assert_eq!(v, ["B", "A"]);
1262     ///
1263     /// let v: Vec<&str> = "A..B..".rsplit_terminator(".").collect();
1264     /// assert_eq!(v, ["", "B", "", "A"]);
1265     /// ```
1266     #[stable(feature = "rust1", since = "1.0.0")]
1267     #[inline]
1268     pub fn rsplit_terminator<'a, P: Pattern<'a>>(&'a self, pat: P) -> RSplitTerminator<'a, P>
1269         where P::Searcher: ReverseSearcher<'a>
1270     {
1271         core_str::StrExt::rsplit_terminator(self, pat)
1272     }
1273
1274     /// An iterator over substrings of the given string slice, separated by a
1275     /// pattern, restricted to returning at most `n` items.
1276     ///
1277     /// If `n` substrings are returned, the last substring (the `n`th substring)
1278     /// will contain the remainder of the string.
1279     ///
1280     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1281     /// split.
1282     ///
1283     /// [`char`]: primitive.char.html
1284     ///
1285     /// # Iterator behavior
1286     ///
1287     /// The returned iterator will not be double ended, because it is
1288     /// not efficient to support.
1289     ///
1290     /// If the pattern allows a reverse search, the [`rsplitn`] method can be
1291     /// used.
1292     ///
1293     /// [`rsplitn`]: #method.rsplitn
1294     ///
1295     /// # Examples
1296     ///
1297     /// Simple patterns:
1298     ///
1299     /// ```
1300     /// let v: Vec<&str> = "Mary had a little lambda".splitn(3, ' ').collect();
1301     /// assert_eq!(v, ["Mary", "had", "a little lambda"]);
1302     ///
1303     /// let v: Vec<&str> = "lionXXtigerXleopard".splitn(3, "X").collect();
1304     /// assert_eq!(v, ["lion", "", "tigerXleopard"]);
1305     ///
1306     /// let v: Vec<&str> = "abcXdef".splitn(1, 'X').collect();
1307     /// assert_eq!(v, ["abcXdef"]);
1308     ///
1309     /// let v: Vec<&str> = "".splitn(1, 'X').collect();
1310     /// assert_eq!(v, [""]);
1311     /// ```
1312     ///
1313     /// A more complex pattern, using a closure:
1314     ///
1315     /// ```
1316     /// let v: Vec<&str> = "abc1defXghi".splitn(2, |c| c == '1' || c == 'X').collect();
1317     /// assert_eq!(v, ["abc", "defXghi"]);
1318     /// ```
1319     #[stable(feature = "rust1", since = "1.0.0")]
1320     #[inline]
1321     pub fn splitn<'a, P: Pattern<'a>>(&'a self, n: usize, pat: P) -> SplitN<'a, P> {
1322         core_str::StrExt::splitn(self, n, pat)
1323     }
1324
1325     /// An iterator over substrings of this string slice, separated by a
1326     /// pattern, starting from the end of the string, restricted to returning
1327     /// at most `n` items.
1328     ///
1329     /// If `n` substrings are returned, the last substring (the `n`th substring)
1330     /// will contain the remainder of the string.
1331     ///
1332     /// The pattern can be a `&str`, [`char`], or a closure that
1333     /// determines the split.
1334     ///
1335     /// [`char`]: primitive.char.html
1336     ///
1337     /// # Iterator behavior
1338     ///
1339     /// The returned iterator will not be double ended, because it is not
1340     /// efficient to support.
1341     ///
1342     /// For splitting from the front, the [`splitn`] method can be used.
1343     ///
1344     /// [`splitn`]: #method.splitn
1345     ///
1346     /// # Examples
1347     ///
1348     /// Simple patterns:
1349     ///
1350     /// ```
1351     /// let v: Vec<&str> = "Mary had a little lamb".rsplitn(3, ' ').collect();
1352     /// assert_eq!(v, ["lamb", "little", "Mary had a"]);
1353     ///
1354     /// let v: Vec<&str> = "lionXXtigerXleopard".rsplitn(3, 'X').collect();
1355     /// assert_eq!(v, ["leopard", "tiger", "lionX"]);
1356     ///
1357     /// let v: Vec<&str> = "lion::tiger::leopard".rsplitn(2, "::").collect();
1358     /// assert_eq!(v, ["leopard", "lion::tiger"]);
1359     /// ```
1360     ///
1361     /// A more complex pattern, using a closure:
1362     ///
1363     /// ```
1364     /// let v: Vec<&str> = "abc1defXghi".rsplitn(2, |c| c == '1' || c == 'X').collect();
1365     /// assert_eq!(v, ["ghi", "abc1def"]);
1366     /// ```
1367     #[stable(feature = "rust1", since = "1.0.0")]
1368     #[inline]
1369     pub fn rsplitn<'a, P: Pattern<'a>>(&'a self, n: usize, pat: P) -> RSplitN<'a, P>
1370         where P::Searcher: ReverseSearcher<'a>
1371     {
1372         core_str::StrExt::rsplitn(self, n, pat)
1373     }
1374
1375     /// An iterator over the disjoint matches of a pattern within the given string
1376     /// slice.
1377     ///
1378     /// The pattern can be a `&str`, [`char`], or a closure that
1379     /// determines if a character matches.
1380     ///
1381     /// [`char`]: primitive.char.html
1382     ///
1383     /// # Iterator behavior
1384     ///
1385     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1386     /// allows a reverse search and forward/reverse search yields the same
1387     /// elements. This is true for, eg, [`char`] but not for `&str`.
1388     ///
1389     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1390     /// [`char`]: primitive.char.html
1391     ///
1392     /// If the pattern allows a reverse search but its results might differ
1393     /// from a forward search, the [`rmatches`] method can be used.
1394     ///
1395     /// [`rmatches`]: #method.rmatches
1396     ///
1397     /// # Examples
1398     ///
1399     /// Basic usage:
1400     ///
1401     /// ```
1402     /// let v: Vec<&str> = "abcXXXabcYYYabc".matches("abc").collect();
1403     /// assert_eq!(v, ["abc", "abc", "abc"]);
1404     ///
1405     /// let v: Vec<&str> = "1abc2abc3".matches(char::is_numeric).collect();
1406     /// assert_eq!(v, ["1", "2", "3"]);
1407     /// ```
1408     #[stable(feature = "str_matches", since = "1.2.0")]
1409     #[inline]
1410     pub fn matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> Matches<'a, P> {
1411         core_str::StrExt::matches(self, pat)
1412     }
1413
1414     /// An iterator over the disjoint matches of a pattern within this string slice,
1415     /// yielded in reverse order.
1416     ///
1417     /// The pattern can be a `&str`, [`char`], or a closure that determines if
1418     /// a character matches.
1419     ///
1420     /// [`char`]: primitive.char.html
1421     ///
1422     /// # Iterator behavior
1423     ///
1424     /// The returned iterator requires that the pattern supports a reverse
1425     /// search, and it will be a [`DoubleEndedIterator`] if a forward/reverse
1426     /// search yields the same elements.
1427     ///
1428     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1429     ///
1430     /// For iterating from the front, the [`matches`] method can be used.
1431     ///
1432     /// [`matches`]: #method.matches
1433     ///
1434     /// # Examples
1435     ///
1436     /// Basic usage:
1437     ///
1438     /// ```
1439     /// let v: Vec<&str> = "abcXXXabcYYYabc".rmatches("abc").collect();
1440     /// assert_eq!(v, ["abc", "abc", "abc"]);
1441     ///
1442     /// let v: Vec<&str> = "1abc2abc3".rmatches(char::is_numeric).collect();
1443     /// assert_eq!(v, ["3", "2", "1"]);
1444     /// ```
1445     #[stable(feature = "str_matches", since = "1.2.0")]
1446     #[inline]
1447     pub fn rmatches<'a, P: Pattern<'a>>(&'a self, pat: P) -> RMatches<'a, P>
1448         where P::Searcher: ReverseSearcher<'a>
1449     {
1450         core_str::StrExt::rmatches(self, pat)
1451     }
1452
1453     /// An iterator over the disjoint matches of a pattern within this string
1454     /// slice as well as the index that the match starts at.
1455     ///
1456     /// For matches of `pat` within `self` that overlap, only the indices
1457     /// corresponding to the first match are returned.
1458     ///
1459     /// The pattern can be a `&str`, [`char`], or a closure that determines
1460     /// if a character matches.
1461     ///
1462     /// [`char`]: primitive.char.html
1463     ///
1464     /// # Iterator behavior
1465     ///
1466     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1467     /// allows a reverse search and forward/reverse search yields the same
1468     /// elements. This is true for, eg, [`char`] but not for `&str`.
1469     ///
1470     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1471     ///
1472     /// If the pattern allows a reverse search but its results might differ
1473     /// from a forward search, the [`rmatch_indices`] method can be used.
1474     ///
1475     /// [`rmatch_indices`]: #method.rmatch_indices
1476     ///
1477     /// # Examples
1478     ///
1479     /// Basic usage:
1480     ///
1481     /// ```
1482     /// let v: Vec<_> = "abcXXXabcYYYabc".match_indices("abc").collect();
1483     /// assert_eq!(v, [(0, "abc"), (6, "abc"), (12, "abc")]);
1484     ///
1485     /// let v: Vec<_> = "1abcabc2".match_indices("abc").collect();
1486     /// assert_eq!(v, [(1, "abc"), (4, "abc")]);
1487     ///
1488     /// let v: Vec<_> = "ababa".match_indices("aba").collect();
1489     /// assert_eq!(v, [(0, "aba")]); // only the first `aba`
1490     /// ```
1491     #[stable(feature = "str_match_indices", since = "1.5.0")]
1492     #[inline]
1493     pub fn match_indices<'a, P: Pattern<'a>>(&'a self, pat: P) -> MatchIndices<'a, P> {
1494         core_str::StrExt::match_indices(self, pat)
1495     }
1496
1497     /// An iterator over the disjoint matches of a pattern within `self`,
1498     /// yielded in reverse order along with the index of the match.
1499     ///
1500     /// For matches of `pat` within `self` that overlap, only the indices
1501     /// corresponding to the last match are returned.
1502     ///
1503     /// The pattern can be a `&str`, [`char`], or a closure that determines if a
1504     /// character matches.
1505     ///
1506     /// [`char`]: primitive.char.html
1507     ///
1508     /// # Iterator behavior
1509     ///
1510     /// The returned iterator requires that the pattern supports a reverse
1511     /// search, and it will be a [`DoubleEndedIterator`] if a forward/reverse
1512     /// search yields the same elements.
1513     ///
1514     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1515     ///
1516     /// For iterating from the front, the [`match_indices`] method can be used.
1517     ///
1518     /// [`match_indices`]: #method.match_indices
1519     ///
1520     /// # Examples
1521     ///
1522     /// Basic usage:
1523     ///
1524     /// ```
1525     /// let v: Vec<_> = "abcXXXabcYYYabc".rmatch_indices("abc").collect();
1526     /// assert_eq!(v, [(12, "abc"), (6, "abc"), (0, "abc")]);
1527     ///
1528     /// let v: Vec<_> = "1abcabc2".rmatch_indices("abc").collect();
1529     /// assert_eq!(v, [(4, "abc"), (1, "abc")]);
1530     ///
1531     /// let v: Vec<_> = "ababa".rmatch_indices("aba").collect();
1532     /// assert_eq!(v, [(2, "aba")]); // only the last `aba`
1533     /// ```
1534     #[stable(feature = "str_match_indices", since = "1.5.0")]
1535     #[inline]
1536     pub fn rmatch_indices<'a, P: Pattern<'a>>(&'a self, pat: P) -> RMatchIndices<'a, P>
1537         where P::Searcher: ReverseSearcher<'a>
1538     {
1539         core_str::StrExt::rmatch_indices(self, pat)
1540     }
1541
1542     /// Returns a string slice with leading and trailing whitespace removed.
1543     ///
1544     /// 'Whitespace' is defined according to the terms of the Unicode Derived
1545     /// Core Property `White_Space`.
1546     ///
1547     /// # Examples
1548     ///
1549     /// Basic usage:
1550     ///
1551     /// ```
1552     /// let s = " Hello\tworld\t";
1553     ///
1554     /// assert_eq!("Hello\tworld", s.trim());
1555     /// ```
1556     #[stable(feature = "rust1", since = "1.0.0")]
1557     pub fn trim(&self) -> &str {
1558         UnicodeStr::trim(self)
1559     }
1560
1561     /// Returns a string slice with leading whitespace removed.
1562     ///
1563     /// 'Whitespace' is defined according to the terms of the Unicode Derived
1564     /// Core Property `White_Space`.
1565     ///
1566     /// # Text directionality
1567     ///
1568     /// A string is a sequence of bytes. 'Left' in this context means the first
1569     /// position of that byte string; for a language like Arabic or Hebrew
1570     /// which are 'right to left' rather than 'left to right', this will be
1571     /// the _right_ side, not the left.
1572     ///
1573     /// # Examples
1574     ///
1575     /// Basic usage:
1576     ///
1577     /// ```
1578     /// let s = " Hello\tworld\t";
1579     ///
1580     /// assert_eq!("Hello\tworld\t", s.trim_left());
1581     /// ```
1582     ///
1583     /// Directionality:
1584     ///
1585     /// ```
1586     /// let s = "  English";
1587     /// assert!(Some('E') == s.trim_left().chars().next());
1588     ///
1589     /// let s = "  עברית";
1590     /// assert!(Some('ע') == s.trim_left().chars().next());
1591     /// ```
1592     #[stable(feature = "rust1", since = "1.0.0")]
1593     pub fn trim_left(&self) -> &str {
1594         UnicodeStr::trim_left(self)
1595     }
1596
1597     /// Returns a string slice with trailing whitespace removed.
1598     ///
1599     /// 'Whitespace' is defined according to the terms of the Unicode Derived
1600     /// Core Property `White_Space`.
1601     ///
1602     /// # Text directionality
1603     ///
1604     /// A string is a sequence of bytes. 'Right' in this context means the last
1605     /// position of that byte string; for a language like Arabic or Hebrew
1606     /// which are 'right to left' rather than 'left to right', this will be
1607     /// the _left_ side, not the right.
1608     ///
1609     /// # Examples
1610     ///
1611     /// Basic usage:
1612     ///
1613     /// ```
1614     /// let s = " Hello\tworld\t";
1615     ///
1616     /// assert_eq!(" Hello\tworld", s.trim_right());
1617     /// ```
1618     ///
1619     /// Directionality:
1620     ///
1621     /// ```
1622     /// let s = "English  ";
1623     /// assert!(Some('h') == s.trim_right().chars().rev().next());
1624     ///
1625     /// let s = "עברית  ";
1626     /// assert!(Some('ת') == s.trim_right().chars().rev().next());
1627     /// ```
1628     #[stable(feature = "rust1", since = "1.0.0")]
1629     pub fn trim_right(&self) -> &str {
1630         UnicodeStr::trim_right(self)
1631     }
1632
1633     /// Returns a string slice with all prefixes and suffixes that match a
1634     /// pattern repeatedly removed.
1635     ///
1636     /// The pattern can be a [`char`] or a closure that determines if a
1637     /// character matches.
1638     ///
1639     /// [`char`]: primitive.char.html
1640     ///
1641     /// # Examples
1642     ///
1643     /// Simple patterns:
1644     ///
1645     /// ```
1646     /// assert_eq!("11foo1bar11".trim_matches('1'), "foo1bar");
1647     /// assert_eq!("123foo1bar123".trim_matches(char::is_numeric), "foo1bar");
1648     ///
1649     /// let x: &[_] = &['1', '2'];
1650     /// assert_eq!("12foo1bar12".trim_matches(x), "foo1bar");
1651     /// ```
1652     ///
1653     /// A more complex pattern, using a closure:
1654     ///
1655     /// ```
1656     /// assert_eq!("1foo1barXX".trim_matches(|c| c == '1' || c == 'X'), "foo1bar");
1657     /// ```
1658     #[stable(feature = "rust1", since = "1.0.0")]
1659     pub fn trim_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str
1660         where P::Searcher: DoubleEndedSearcher<'a>
1661     {
1662         core_str::StrExt::trim_matches(self, pat)
1663     }
1664
1665     /// Returns a string slice with all prefixes that match a pattern
1666     /// repeatedly removed.
1667     ///
1668     /// The pattern can be a `&str`, [`char`], or a closure that determines if
1669     /// a character matches.
1670     ///
1671     /// [`char`]: primitive.char.html
1672     ///
1673     /// # Text directionality
1674     ///
1675     /// A string is a sequence of bytes. 'Left' in this context means the first
1676     /// position of that byte string; for a language like Arabic or Hebrew
1677     /// which are 'right to left' rather than 'left to right', this will be
1678     /// the _right_ side, not the left.
1679     ///
1680     /// # Examples
1681     ///
1682     /// Basic usage:
1683     ///
1684     /// ```
1685     /// assert_eq!("11foo1bar11".trim_left_matches('1'), "foo1bar11");
1686     /// assert_eq!("123foo1bar123".trim_left_matches(char::is_numeric), "foo1bar123");
1687     ///
1688     /// let x: &[_] = &['1', '2'];
1689     /// assert_eq!("12foo1bar12".trim_left_matches(x), "foo1bar12");
1690     /// ```
1691     #[stable(feature = "rust1", since = "1.0.0")]
1692     pub fn trim_left_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str {
1693         core_str::StrExt::trim_left_matches(self, pat)
1694     }
1695
1696     /// Returns a string slice with all suffixes that match a pattern
1697     /// repeatedly removed.
1698     ///
1699     /// The pattern can be a `&str`, [`char`], or a closure that
1700     /// determines if a character matches.
1701     ///
1702     /// [`char`]: primitive.char.html
1703     ///
1704     /// # Text directionality
1705     ///
1706     /// A string is a sequence of bytes. 'Right' in this context means the last
1707     /// position of that byte string; for a language like Arabic or Hebrew
1708     /// which are 'right to left' rather than 'left to right', this will be
1709     /// the _left_ side, not the right.
1710     ///
1711     /// # Examples
1712     ///
1713     /// Simple patterns:
1714     ///
1715     /// ```
1716     /// assert_eq!("11foo1bar11".trim_right_matches('1'), "11foo1bar");
1717     /// assert_eq!("123foo1bar123".trim_right_matches(char::is_numeric), "123foo1bar");
1718     ///
1719     /// let x: &[_] = &['1', '2'];
1720     /// assert_eq!("12foo1bar12".trim_right_matches(x), "12foo1bar");
1721     /// ```
1722     ///
1723     /// A more complex pattern, using a closure:
1724     ///
1725     /// ```
1726     /// assert_eq!("1fooX".trim_left_matches(|c| c == '1' || c == 'X'), "fooX");
1727     /// ```
1728     #[stable(feature = "rust1", since = "1.0.0")]
1729     pub fn trim_right_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str
1730         where P::Searcher: ReverseSearcher<'a>
1731     {
1732         core_str::StrExt::trim_right_matches(self, pat)
1733     }
1734
1735     /// Parses this string slice into another type.
1736     ///
1737     /// Because `parse` is so general, it can cause problems with type
1738     /// inference. As such, `parse` is one of the few times you'll see
1739     /// the syntax affectionately known as the 'turbofish': `::<>`. This
1740     /// helps the inference algorithm understand specifically which type
1741     /// you're trying to parse into.
1742     ///
1743     /// `parse` can parse any type that implements the [`FromStr`] trait.
1744     ///
1745     /// [`FromStr`]: str/trait.FromStr.html
1746     ///
1747     /// # Errors
1748     ///
1749     /// Will return [`Err`] if it's not possible to parse this string slice into
1750     /// the desired type.
1751     ///
1752     /// [`Err`]: str/trait.FromStr.html#associatedtype.Err
1753     ///
1754     /// # Examples
1755     ///
1756     /// Basic usage
1757     ///
1758     /// ```
1759     /// let four: u32 = "4".parse().unwrap();
1760     ///
1761     /// assert_eq!(4, four);
1762     /// ```
1763     ///
1764     /// Using the 'turbofish' instead of annotating `four`:
1765     ///
1766     /// ```
1767     /// let four = "4".parse::<u32>();
1768     ///
1769     /// assert_eq!(Ok(4), four);
1770     /// ```
1771     ///
1772     /// Failing to parse:
1773     ///
1774     /// ```
1775     /// let nope = "j".parse::<u32>();
1776     ///
1777     /// assert!(nope.is_err());
1778     /// ```
1779     #[inline]
1780     #[stable(feature = "rust1", since = "1.0.0")]
1781     pub fn parse<F: FromStr>(&self) -> Result<F, F::Err> {
1782         core_str::StrExt::parse(self)
1783     }
1784
1785     /// Converts a `Box<str>` into a `Box<[u8]>` without copying or allocating.
1786     #[stable(feature = "str_box_extras", since = "1.20.0")]
1787     pub fn into_boxed_bytes(self: Box<str>) -> Box<[u8]> {
1788         self.into()
1789     }
1790
1791     /// Replaces all matches of a pattern with another string.
1792     ///
1793     /// `replace` creates a new [`String`], and copies the data from this string slice into it.
1794     /// While doing so, it attempts to find matches of a pattern. If it finds any, it
1795     /// replaces them with the replacement string slice.
1796     ///
1797     /// [`String`]: string/struct.String.html
1798     ///
1799     /// # Examples
1800     ///
1801     /// Basic usage:
1802     ///
1803     /// ```
1804     /// let s = "this is old";
1805     ///
1806     /// assert_eq!("this is new", s.replace("old", "new"));
1807     /// ```
1808     ///
1809     /// When the pattern doesn't match:
1810     ///
1811     /// ```
1812     /// let s = "this is old";
1813     /// assert_eq!(s, s.replace("cookie monster", "little lamb"));
1814     /// ```
1815     #[stable(feature = "rust1", since = "1.0.0")]
1816     #[inline]
1817     pub fn replace<'a, P: Pattern<'a>>(&'a self, from: P, to: &str) -> String {
1818         let mut result = String::new();
1819         let mut last_end = 0;
1820         for (start, part) in self.match_indices(from) {
1821             result.push_str(unsafe { self.slice_unchecked(last_end, start) });
1822             result.push_str(to);
1823             last_end = start + part.len();
1824         }
1825         result.push_str(unsafe { self.slice_unchecked(last_end, self.len()) });
1826         result
1827     }
1828
1829     /// Replaces first N matches of a pattern with another string.
1830     ///
1831     /// `replacen` creates a new [`String`], and copies the data from this string slice into it.
1832     /// While doing so, it attempts to find matches of a pattern. If it finds any, it
1833     /// replaces them with the replacement string slice at most `count` times.
1834     ///
1835     /// [`String`]: string/struct.String.html
1836     ///
1837     /// # Examples
1838     ///
1839     /// Basic usage:
1840     ///
1841     /// ```
1842     /// let s = "foo foo 123 foo";
1843     /// assert_eq!("new new 123 foo", s.replacen("foo", "new", 2));
1844     /// assert_eq!("faa fao 123 foo", s.replacen('o', "a", 3));
1845     /// assert_eq!("foo foo new23 foo", s.replacen(char::is_numeric, "new", 1));
1846     /// ```
1847     ///
1848     /// When the pattern doesn't match:
1849     ///
1850     /// ```
1851     /// let s = "this is old";
1852     /// assert_eq!(s, s.replacen("cookie monster", "little lamb", 10));
1853     /// ```
1854     #[stable(feature = "str_replacen", since = "1.16.0")]
1855     pub fn replacen<'a, P: Pattern<'a>>(&'a self, pat: P, to: &str, count: usize) -> String {
1856         // Hope to reduce the times of re-allocation
1857         let mut result = String::with_capacity(32);
1858         let mut last_end = 0;
1859         for (start, part) in self.match_indices(pat).take(count) {
1860             result.push_str(unsafe { self.slice_unchecked(last_end, start) });
1861             result.push_str(to);
1862             last_end = start + part.len();
1863         }
1864         result.push_str(unsafe { self.slice_unchecked(last_end, self.len()) });
1865         result
1866     }
1867
1868     /// Returns the lowercase equivalent of this string slice, as a new [`String`].
1869     ///
1870     /// 'Lowercase' is defined according to the terms of the Unicode Derived Core Property
1871     /// `Lowercase`.
1872     ///
1873     /// Since some characters can expand into multiple characters when changing
1874     /// the case, this function returns a [`String`] instead of modifying the
1875     /// parameter in-place.
1876     ///
1877     /// [`String`]: string/struct.String.html
1878     ///
1879     /// # Examples
1880     ///
1881     /// Basic usage:
1882     ///
1883     /// ```
1884     /// let s = "HELLO";
1885     ///
1886     /// assert_eq!("hello", s.to_lowercase());
1887     /// ```
1888     ///
1889     /// A tricky example, with sigma:
1890     ///
1891     /// ```
1892     /// let sigma = "Σ";
1893     ///
1894     /// assert_eq!("σ", sigma.to_lowercase());
1895     ///
1896     /// // but at the end of a word, it's ς, not σ:
1897     /// let odysseus = "ὈΔΥΣΣΕΎΣ";
1898     ///
1899     /// assert_eq!("ὀδυσσεύς", odysseus.to_lowercase());
1900     /// ```
1901     ///
1902     /// Languages without case are not changed:
1903     ///
1904     /// ```
1905     /// let new_year = "农历新年";
1906     ///
1907     /// assert_eq!(new_year, new_year.to_lowercase());
1908     /// ```
1909     #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
1910     pub fn to_lowercase(&self) -> String {
1911         let mut s = String::with_capacity(self.len());
1912         for (i, c) in self[..].char_indices() {
1913             if c == 'Σ' {
1914                 // Σ maps to σ, except at the end of a word where it maps to ς.
1915                 // This is the only conditional (contextual) but language-independent mapping
1916                 // in `SpecialCasing.txt`,
1917                 // so hard-code it rather than have a generic "condition" mechanism.
1918                 // See https://github.com/rust-lang/rust/issues/26035
1919                 map_uppercase_sigma(self, i, &mut s)
1920             } else {
1921                 s.extend(c.to_lowercase());
1922             }
1923         }
1924         return s;
1925
1926         fn map_uppercase_sigma(from: &str, i: usize, to: &mut String) {
1927             // See http://www.unicode.org/versions/Unicode7.0.0/ch03.pdf#G33992
1928             // for the definition of `Final_Sigma`.
1929             debug_assert!('Σ'.len_utf8() == 2);
1930             let is_word_final = case_ignoreable_then_cased(from[..i].chars().rev()) &&
1931                                 !case_ignoreable_then_cased(from[i + 2..].chars());
1932             to.push_str(if is_word_final { "ς" } else { "σ" });
1933         }
1934
1935         fn case_ignoreable_then_cased<I: Iterator<Item = char>>(iter: I) -> bool {
1936             use std_unicode::derived_property::{Cased, Case_Ignorable};
1937             match iter.skip_while(|&c| Case_Ignorable(c)).next() {
1938                 Some(c) => Cased(c),
1939                 None => false,
1940             }
1941         }
1942     }
1943
1944     /// Returns the uppercase equivalent of this string slice, as a new [`String`].
1945     ///
1946     /// 'Uppercase' is defined according to the terms of the Unicode Derived Core Property
1947     /// `Uppercase`.
1948     ///
1949     /// Since some characters can expand into multiple characters when changing
1950     /// the case, this function returns a [`String`] instead of modifying the
1951     /// parameter in-place.
1952     ///
1953     /// [`String`]: string/struct.String.html
1954     ///
1955     /// # Examples
1956     ///
1957     /// Basic usage:
1958     ///
1959     /// ```
1960     /// let s = "hello";
1961     ///
1962     /// assert_eq!("HELLO", s.to_uppercase());
1963     /// ```
1964     ///
1965     /// Scripts without case are not changed:
1966     ///
1967     /// ```
1968     /// let new_year = "农历新年";
1969     ///
1970     /// assert_eq!(new_year, new_year.to_uppercase());
1971     /// ```
1972     #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
1973     pub fn to_uppercase(&self) -> String {
1974         let mut s = String::with_capacity(self.len());
1975         s.extend(self.chars().flat_map(|c| c.to_uppercase()));
1976         return s;
1977     }
1978
1979     /// Escapes each char in `s` with [`char::escape_debug`].
1980     ///
1981     /// [`char::escape_debug`]: primitive.char.html#method.escape_debug
1982     #[unstable(feature = "str_escape",
1983                reason = "return type may change to be an iterator",
1984                issue = "27791")]
1985     pub fn escape_debug(&self) -> String {
1986         self.chars().flat_map(|c| c.escape_debug()).collect()
1987     }
1988
1989     /// Escapes each char in `s` with [`char::escape_default`].
1990     ///
1991     /// [`char::escape_default`]: primitive.char.html#method.escape_default
1992     #[unstable(feature = "str_escape",
1993                reason = "return type may change to be an iterator",
1994                issue = "27791")]
1995     pub fn escape_default(&self) -> String {
1996         self.chars().flat_map(|c| c.escape_default()).collect()
1997     }
1998
1999     /// Escapes each char in `s` with [`char::escape_unicode`].
2000     ///
2001     /// [`char::escape_unicode`]: primitive.char.html#method.escape_unicode
2002     #[unstable(feature = "str_escape",
2003                reason = "return type may change to be an iterator",
2004                issue = "27791")]
2005     pub fn escape_unicode(&self) -> String {
2006         self.chars().flat_map(|c| c.escape_unicode()).collect()
2007     }
2008
2009     /// Converts a [`Box<str>`] into a [`String`] without copying or allocating.
2010     ///
2011     /// [`String`]: string/struct.String.html
2012     /// [`Box<str>`]: boxed/struct.Box.html
2013     ///
2014     /// # Examples
2015     ///
2016     /// Basic usage:
2017     ///
2018     /// ```
2019     /// let string = String::from("birthday gift");
2020     /// let boxed_str = string.clone().into_boxed_str();
2021     ///
2022     /// assert_eq!(boxed_str.into_string(), string);
2023     /// ```
2024     #[stable(feature = "box_str", since = "1.4.0")]
2025     pub fn into_string(self: Box<str>) -> String {
2026         unsafe {
2027             let slice = mem::transmute::<Box<str>, Box<[u8]>>(self);
2028             String::from_utf8_unchecked(slice.into_vec())
2029         }
2030     }
2031
2032     /// Create a [`String`] by repeating a string `n` times.
2033     ///
2034     /// [`String`]: string/struct.String.html
2035     ///
2036     /// # Examples
2037     ///
2038     /// Basic usage:
2039     ///
2040     /// ```
2041     /// assert_eq!("abc".repeat(4), String::from("abcabcabcabc"));
2042     /// ```
2043     #[stable(feature = "repeat_str", since = "1.16.0")]
2044     pub fn repeat(&self, n: usize) -> String {
2045         let mut s = String::with_capacity(self.len() * n);
2046         s.extend((0..n).map(|_| self));
2047         s
2048     }
2049 }
2050
2051 /// Converts a boxed slice of bytes to a boxed string slice without checking
2052 /// that the string contains valid UTF-8.
2053 #[stable(feature = "str_box_extras", since = "1.20.0")]
2054 pub unsafe fn from_boxed_utf8_unchecked(v: Box<[u8]>) -> Box<str> {
2055     mem::transmute(v)
2056 }