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     ///
 859     /// # Examples
 860     ///
 861     /// Basic usage:
 862     ///
 863     /// ```
 864     /// let text = "Zażółć gęślą jaźń";
 865     ///
 866     /// let utf8_len = text.len();
 867     /// let utf16_len = text.encode_utf16().count();
 868     ///
 869     /// assert!(utf16_len <= utf8_len);
 870     /// ```
 871     #[stable(feature = "encode_utf16", since = "1.8.0")]
 872     pub fn encode_utf16(&self) -> EncodeUtf16 {
 873         EncodeUtf16 { encoder: Utf16Encoder::new(self[..].chars()) }
 874     }
 875
 876     /// Returns `true` if the given pattern matches a sub-slice of
 877     /// this string slice.
 878     ///
 879     /// Returns `false` if it does not.
 880     ///
 881     /// # Examples
 882     ///
 883     /// Basic usage:
 884     ///
 885     /// ```
 886     /// let bananas = "bananas";
 887     ///
 888     /// assert!(bananas.contains("nana"));
 889     /// assert!(!bananas.contains("apples"));
 890     /// ```
 891     #[stable(feature = "rust1", since = "1.0.0")]
 892     #[inline]
 893     pub fn contains<'a, P: Pattern<'a>>(&'a self, pat: P) -> bool {
 894         core_str::StrExt::contains(self, pat)
 895     }
 896
 897     /// Returns `true` if the given pattern matches a prefix of this
 898     /// string slice.
 899     ///
 900     /// Returns `false` if it does not.
 901     ///
 902     /// # Examples
 903     ///
 904     /// Basic usage:
 905     ///
 906     /// ```
 907     /// let bananas = "bananas";
 908     ///
 909     /// assert!(bananas.starts_with("bana"));
 910     /// assert!(!bananas.starts_with("nana"));
 911     /// ```
 912     #[stable(feature = "rust1", since = "1.0.0")]
 913     pub fn starts_with<'a, P: Pattern<'a>>(&'a self, pat: P) -> bool {
 914         core_str::StrExt::starts_with(self, pat)
 915     }
 916
 917     /// Returns `true` if the given pattern matches a suffix of this
 918     /// string slice.
 919     ///
 920     /// Returns `false` if it does not.
 921     ///
 922     /// # Examples
 923     ///
 924     /// Basic usage:
 925     ///
 926     /// ```
 927     /// let bananas = "bananas";
 928     ///
 929     /// assert!(bananas.ends_with("anas"));
 930     /// assert!(!bananas.ends_with("nana"));
 931     /// ```
 932     #[stable(feature = "rust1", since = "1.0.0")]
 933     pub fn ends_with<'a, P: Pattern<'a>>(&'a self, pat: P) -> bool
 934         where P::Searcher: ReverseSearcher<'a>
 935     {
 936         core_str::StrExt::ends_with(self, pat)
 937     }
 938
 939     /// Returns the byte index of the first character of this string slice that
 940     /// matches the pattern.
 941     ///
 942     /// Returns [`None`] if the pattern doesn't match.
 943     ///
 944     /// The pattern can be a `&str`, [`char`], or a closure that determines if
 945     /// a character matches.
 946     ///
 947     /// [`char`]: primitive.char.html
 948     /// [`None`]: option/enum.Option.html#variant.None
 949     ///
 950     /// # Examples
 951     ///
 952     /// Simple patterns:
 953     ///
 954     /// ```
 955     /// let s = "Löwe 老虎 Léopard";
 956     ///
 957     /// assert_eq!(s.find('L'), Some(0));
 958     /// assert_eq!(s.find('é'), Some(14));
 959     /// assert_eq!(s.find("Léopard"), Some(13));
 960     /// ```
 961     ///
 962     /// More complex patterns with closures:
 963     ///
 964     /// ```
 965     /// let s = "Löwe 老虎 Léopard";
 966     ///
 967     /// assert_eq!(s.find(char::is_whitespace), Some(5));
 968     /// assert_eq!(s.find(char::is_lowercase), Some(1));
 969     /// ```
 970     ///
 971     /// Not finding the pattern:
 972     ///
 973     /// ```
 974     /// let s = "Löwe 老虎 Léopard";
 975     /// let x: &[_] = &['1', '2'];
 976     ///
 977     /// assert_eq!(s.find(x), None);
 978     /// ```
 979     #[stable(feature = "rust1", since = "1.0.0")]
 980     #[inline]
 981     pub fn find<'a, P: Pattern<'a>>(&'a self, pat: P) -> Option<usize> {
 982         core_str::StrExt::find(self, pat)
 983     }
 984
 985     /// Returns the byte index of the last character of this string slice that
 986     /// matches the pattern.
 987     ///
 988     /// Returns [`None`] if the pattern doesn't match.
 989     ///
 990     /// The pattern can be a `&str`, [`char`], or a closure that determines if
 991     /// a character matches.
 992     ///
 993     /// [`char`]: primitive.char.html
 994     /// [`None`]: option/enum.Option.html#variant.None
 995     ///
 996     /// # Examples
 997     ///
 998     /// Simple patterns:
 999     ///
1000     /// ```
1001     /// let s = "Löwe 老虎 Léopard";
1002     ///
1003     /// assert_eq!(s.rfind('L'), Some(13));
1004     /// assert_eq!(s.rfind('é'), Some(14));
1005     /// ```
1006     ///
1007     /// More complex patterns with closures:
1008     ///
1009     /// ```
1010     /// let s = "Löwe 老虎 Léopard";
1011     ///
1012     /// assert_eq!(s.rfind(char::is_whitespace), Some(12));
1013     /// assert_eq!(s.rfind(char::is_lowercase), Some(20));
1014     /// ```
1015     ///
1016     /// Not finding the pattern:
1017     ///
1018     /// ```
1019     /// let s = "Löwe 老虎 Léopard";
1020     /// let x: &[_] = &['1', '2'];
1021     ///
1022     /// assert_eq!(s.rfind(x), None);
1023     /// ```
1024     #[stable(feature = "rust1", since = "1.0.0")]
1025     #[inline]
1026     pub fn rfind<'a, P: Pattern<'a>>(&'a self, pat: P) -> Option<usize>
1027         where P::Searcher: ReverseSearcher<'a>
1028     {
1029         core_str::StrExt::rfind(self, pat)
1030     }
1031
1032     /// An iterator over substrings of this string slice, separated by
1033     /// characters matched by a pattern.
1034     ///
1035     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1036     /// split.
1037     ///
1038     /// # Iterator behavior
1039     ///
1040     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1041     /// allows a reverse search and forward/reverse search yields the same
1042     /// elements. This is true for, eg, [`char`] but not for `&str`.
1043     ///
1044     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1045     ///
1046     /// If the pattern allows a reverse search but its results might differ
1047     /// from a forward search, the [`rsplit`] method can be used.
1048     ///
1049     /// [`char`]: primitive.char.html
1050     /// [`rsplit`]: #method.rsplit
1051     ///
1052     /// # Examples
1053     ///
1054     /// Simple patterns:
1055     ///
1056     /// ```
1057     /// let v: Vec<&str> = "Mary had a little lamb".split(' ').collect();
1058     /// assert_eq!(v, ["Mary", "had", "a", "little", "lamb"]);
1059     ///
1060     /// let v: Vec<&str> = "".split('X').collect();
1061     /// assert_eq!(v, [""]);
1062     ///
1063     /// let v: Vec<&str> = "lionXXtigerXleopard".split('X').collect();
1064     /// assert_eq!(v, ["lion", "", "tiger", "leopard"]);
1065     ///
1066     /// let v: Vec<&str> = "lion::tiger::leopard".split("::").collect();
1067     /// assert_eq!(v, ["lion", "tiger", "leopard"]);
1068     ///
1069     /// let v: Vec<&str> = "abc1def2ghi".split(char::is_numeric).collect();
1070     /// assert_eq!(v, ["abc", "def", "ghi"]);
1071     ///
1072     /// let v: Vec<&str> = "lionXtigerXleopard".split(char::is_uppercase).collect();
1073     /// assert_eq!(v, ["lion", "tiger", "leopard"]);
1074     /// ```
1075     ///
1076     /// A more complex pattern, using a closure:
1077     ///
1078     /// ```
1079     /// let v: Vec<&str> = "abc1defXghi".split(|c| c == '1' || c == 'X').collect();
1080     /// assert_eq!(v, ["abc", "def", "ghi"]);
1081     /// ```
1082     ///
1083     /// If a string contains multiple contiguous separators, you will end up
1084     /// with empty strings in the output:
1085     ///
1086     /// ```
1087     /// let x = "||||a||b|c".to_string();
1088     /// let d: Vec<_> = x.split('|').collect();
1089     ///
1090     /// assert_eq!(d, &["", "", "", "", "a", "", "b", "c"]);
1091     /// ```
1092     ///
1093     /// Contiguous separators are separated by the empty string.
1094     ///
1095     /// ```
1096     /// let x = "(///)".to_string();
1097     /// let d: Vec<_> = x.split('/').collect();
1098     ///
1099     /// assert_eq!(d, &["(", "", "", ")"]);
1100     /// ```
1101     ///
1102     /// Separators at the start or end of a string are neighbored
1103     /// by empty strings.
1104     ///
1105     /// ```
1106     /// let d: Vec<_> = "010".split("0").collect();
1107     /// assert_eq!(d, &["", "1", ""]);
1108     /// ```
1109     ///
1110     /// When the empty string is used as a separator, it separates
1111     /// every character in the string, along with the beginning
1112     /// and end of the string.
1113     ///
1114     /// ```
1115     /// let f: Vec<_> = "rust".split("").collect();
1116     /// assert_eq!(f, &["", "r", "u", "s", "t", ""]);
1117     /// ```
1118     ///
1119     /// Contiguous separators can lead to possibly surprising behavior
1120     /// when whitespace is used as the separator. This code is correct:
1121     ///
1122     /// ```
1123     /// let x = "    a  b c".to_string();
1124     /// let d: Vec<_> = x.split(' ').collect();
1125     ///
1126     /// assert_eq!(d, &["", "", "", "", "a", "", "b", "c"]);
1127     /// ```
1128     ///
1129     /// It does _not_ give you:
1130     ///
1131     /// ```,ignore
1132     /// assert_eq!(d, &["a", "b", "c"]);
1133     /// ```
1134     ///
1135     /// Use [`split_whitespace`] for this behavior.
1136     ///
1137     /// [`split_whitespace`]: #method.split_whitespace
1138     #[stable(feature = "rust1", since = "1.0.0")]
1139     #[inline]
1140     pub fn split<'a, P: Pattern<'a>>(&'a self, pat: P) -> Split<'a, P> {
1141         core_str::StrExt::split(self, pat)
1142     }
1143
1144     /// An iterator over substrings of the given string slice, separated by
1145     /// characters matched by a pattern and yielded in reverse order.
1146     ///
1147     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1148     /// split.
1149     ///
1150     /// [`char`]: primitive.char.html
1151     ///
1152     /// # Iterator behavior
1153     ///
1154     /// The returned iterator requires that the pattern supports a reverse
1155     /// search, and it will be a [`DoubleEndedIterator`] if a forward/reverse
1156     /// search yields the same elements.
1157     ///
1158     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1159     ///
1160     /// For iterating from the front, the [`split`] method can be used.
1161     ///
1162     /// [`split`]: #method.split
1163     ///
1164     /// # Examples
1165     ///
1166     /// Simple patterns:
1167     ///
1168     /// ```
1169     /// let v: Vec<&str> = "Mary had a little lamb".rsplit(' ').collect();
1170     /// assert_eq!(v, ["lamb", "little", "a", "had", "Mary"]);
1171     ///
1172     /// let v: Vec<&str> = "".rsplit('X').collect();
1173     /// assert_eq!(v, [""]);
1174     ///
1175     /// let v: Vec<&str> = "lionXXtigerXleopard".rsplit('X').collect();
1176     /// assert_eq!(v, ["leopard", "tiger", "", "lion"]);
1177     ///
1178     /// let v: Vec<&str> = "lion::tiger::leopard".rsplit("::").collect();
1179     /// assert_eq!(v, ["leopard", "tiger", "lion"]);
1180     /// ```
1181     ///
1182     /// A more complex pattern, using a closure:
1183     ///
1184     /// ```
1185     /// let v: Vec<&str> = "abc1defXghi".rsplit(|c| c == '1' || c == 'X').collect();
1186     /// assert_eq!(v, ["ghi", "def", "abc"]);
1187     /// ```
1188     #[stable(feature = "rust1", since = "1.0.0")]
1189     #[inline]
1190     pub fn rsplit<'a, P: Pattern<'a>>(&'a self, pat: P) -> RSplit<'a, P>
1191         where P::Searcher: ReverseSearcher<'a>
1192     {
1193         core_str::StrExt::rsplit(self, pat)
1194     }
1195
1196     /// An iterator over substrings of the given string slice, separated by
1197     /// characters matched by a pattern.
1198     ///
1199     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1200     /// split.
1201     ///
1202     /// Equivalent to [`split`], except that the trailing substring
1203     /// is skipped if empty.
1204     ///
1205     /// [`split`]: #method.split
1206     ///
1207     /// This method can be used for string data that is _terminated_,
1208     /// rather than _separated_ by a pattern.
1209     ///
1210     /// # Iterator behavior
1211     ///
1212     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1213     /// allows a reverse search and forward/reverse search yields the same
1214     /// elements. This is true for, eg, [`char`] but not for `&str`.
1215     ///
1216     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1217     /// [`char`]: primitive.char.html
1218     ///
1219     /// If the pattern allows a reverse search but its results might differ
1220     /// from a forward search, the [`rsplit_terminator`] method can be used.
1221     ///
1222     /// [`rsplit_terminator`]: #method.rsplit_terminator
1223     ///
1224     /// # Examples
1225     ///
1226     /// Basic usage:
1227     ///
1228     /// ```
1229     /// let v: Vec<&str> = "A.B.".split_terminator('.').collect();
1230     /// assert_eq!(v, ["A", "B"]);
1231     ///
1232     /// let v: Vec<&str> = "A..B..".split_terminator(".").collect();
1233     /// assert_eq!(v, ["A", "", "B", ""]);
1234     /// ```
1235     #[stable(feature = "rust1", since = "1.0.0")]
1236     #[inline]
1237     pub fn split_terminator<'a, P: Pattern<'a>>(&'a self, pat: P) -> SplitTerminator<'a, P> {
1238         core_str::StrExt::split_terminator(self, pat)
1239     }
1240
1241     /// An iterator over substrings of `self`, separated by characters
1242     /// matched by a pattern and yielded in reverse order.
1243     ///
1244     /// The pattern can be a simple `&str`, [`char`], or a closure that
1245     /// determines the split.
1246     /// Additional libraries might provide more complex patterns like
1247     /// regular expressions.
1248     ///
1249     /// [`char`]: primitive.char.html
1250     ///
1251     /// Equivalent to [`split`], except that the trailing substring is
1252     /// skipped if empty.
1253     ///
1254     /// [`split`]: #method.split
1255     ///
1256     /// This method can be used for string data that is _terminated_,
1257     /// rather than _separated_ by a pattern.
1258     ///
1259     /// # Iterator behavior
1260     ///
1261     /// The returned iterator requires that the pattern supports a
1262     /// reverse search, and it will be double ended if a forward/reverse
1263     /// search yields the same elements.
1264     ///
1265     /// For iterating from the front, the [`split_terminator`] method can be
1266     /// used.
1267     ///
1268     /// [`split_terminator`]: #method.split_terminator
1269     ///
1270     /// # Examples
1271     ///
1272     /// ```
1273     /// let v: Vec<&str> = "A.B.".rsplit_terminator('.').collect();
1274     /// assert_eq!(v, ["B", "A"]);
1275     ///
1276     /// let v: Vec<&str> = "A..B..".rsplit_terminator(".").collect();
1277     /// assert_eq!(v, ["", "B", "", "A"]);
1278     /// ```
1279     #[stable(feature = "rust1", since = "1.0.0")]
1280     #[inline]
1281     pub fn rsplit_terminator<'a, P: Pattern<'a>>(&'a self, pat: P) -> RSplitTerminator<'a, P>
1282         where P::Searcher: ReverseSearcher<'a>
1283     {
1284         core_str::StrExt::rsplit_terminator(self, pat)
1285     }
1286
1287     /// An iterator over substrings of the given string slice, separated by a
1288     /// pattern, restricted to returning at most `n` items.
1289     ///
1290     /// If `n` substrings are returned, the last substring (the `n`th substring)
1291     /// will contain the remainder of the string.
1292     ///
1293     /// The pattern can be a `&str`, [`char`], or a closure that determines the
1294     /// split.
1295     ///
1296     /// [`char`]: primitive.char.html
1297     ///
1298     /// # Iterator behavior
1299     ///
1300     /// The returned iterator will not be double ended, because it is
1301     /// not efficient to support.
1302     ///
1303     /// If the pattern allows a reverse search, the [`rsplitn`] method can be
1304     /// used.
1305     ///
1306     /// [`rsplitn`]: #method.rsplitn
1307     ///
1308     /// # Examples
1309     ///
1310     /// Simple patterns:
1311     ///
1312     /// ```
1313     /// let v: Vec<&str> = "Mary had a little lambda".splitn(3, ' ').collect();
1314     /// assert_eq!(v, ["Mary", "had", "a little lambda"]);
1315     ///
1316     /// let v: Vec<&str> = "lionXXtigerXleopard".splitn(3, "X").collect();
1317     /// assert_eq!(v, ["lion", "", "tigerXleopard"]);
1318     ///
1319     /// let v: Vec<&str> = "abcXdef".splitn(1, 'X').collect();
1320     /// assert_eq!(v, ["abcXdef"]);
1321     ///
1322     /// let v: Vec<&str> = "".splitn(1, 'X').collect();
1323     /// assert_eq!(v, [""]);
1324     /// ```
1325     ///
1326     /// A more complex pattern, using a closure:
1327     ///
1328     /// ```
1329     /// let v: Vec<&str> = "abc1defXghi".splitn(2, |c| c == '1' || c == 'X').collect();
1330     /// assert_eq!(v, ["abc", "defXghi"]);
1331     /// ```
1332     #[stable(feature = "rust1", since = "1.0.0")]
1333     #[inline]
1334     pub fn splitn<'a, P: Pattern<'a>>(&'a self, n: usize, pat: P) -> SplitN<'a, P> {
1335         core_str::StrExt::splitn(self, n, pat)
1336     }
1337
1338     /// An iterator over substrings of this string slice, separated by a
1339     /// pattern, starting from the end of the string, restricted to returning
1340     /// at most `n` items.
1341     ///
1342     /// If `n` substrings are returned, the last substring (the `n`th substring)
1343     /// will contain the remainder of the string.
1344     ///
1345     /// The pattern can be a `&str`, [`char`], or a closure that
1346     /// determines the split.
1347     ///
1348     /// [`char`]: primitive.char.html
1349     ///
1350     /// # Iterator behavior
1351     ///
1352     /// The returned iterator will not be double ended, because it is not
1353     /// efficient to support.
1354     ///
1355     /// For splitting from the front, the [`splitn`] method can be used.
1356     ///
1357     /// [`splitn`]: #method.splitn
1358     ///
1359     /// # Examples
1360     ///
1361     /// Simple patterns:
1362     ///
1363     /// ```
1364     /// let v: Vec<&str> = "Mary had a little lamb".rsplitn(3, ' ').collect();
1365     /// assert_eq!(v, ["lamb", "little", "Mary had a"]);
1366     ///
1367     /// let v: Vec<&str> = "lionXXtigerXleopard".rsplitn(3, 'X').collect();
1368     /// assert_eq!(v, ["leopard", "tiger", "lionX"]);
1369     ///
1370     /// let v: Vec<&str> = "lion::tiger::leopard".rsplitn(2, "::").collect();
1371     /// assert_eq!(v, ["leopard", "lion::tiger"]);
1372     /// ```
1373     ///
1374     /// A more complex pattern, using a closure:
1375     ///
1376     /// ```
1377     /// let v: Vec<&str> = "abc1defXghi".rsplitn(2, |c| c == '1' || c == 'X').collect();
1378     /// assert_eq!(v, ["ghi", "abc1def"]);
1379     /// ```
1380     #[stable(feature = "rust1", since = "1.0.0")]
1381     #[inline]
1382     pub fn rsplitn<'a, P: Pattern<'a>>(&'a self, n: usize, pat: P) -> RSplitN<'a, P>
1383         where P::Searcher: ReverseSearcher<'a>
1384     {
1385         core_str::StrExt::rsplitn(self, n, pat)
1386     }
1387
1388     /// An iterator over the disjoint matches of a pattern within the given string
1389     /// slice.
1390     ///
1391     /// The pattern can be a `&str`, [`char`], or a closure that
1392     /// determines if a character matches.
1393     ///
1394     /// [`char`]: primitive.char.html
1395     ///
1396     /// # Iterator behavior
1397     ///
1398     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1399     /// allows a reverse search and forward/reverse search yields the same
1400     /// elements. This is true for, eg, [`char`] but not for `&str`.
1401     ///
1402     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1403     /// [`char`]: primitive.char.html
1404     ///
1405     /// If the pattern allows a reverse search but its results might differ
1406     /// from a forward search, the [`rmatches`] method can be used.
1407     ///
1408     /// [`rmatches`]: #method.rmatches
1409     ///
1410     /// # Examples
1411     ///
1412     /// Basic usage:
1413     ///
1414     /// ```
1415     /// let v: Vec<&str> = "abcXXXabcYYYabc".matches("abc").collect();
1416     /// assert_eq!(v, ["abc", "abc", "abc"]);
1417     ///
1418     /// let v: Vec<&str> = "1abc2abc3".matches(char::is_numeric).collect();
1419     /// assert_eq!(v, ["1", "2", "3"]);
1420     /// ```
1421     #[stable(feature = "str_matches", since = "1.2.0")]
1422     #[inline]
1423     pub fn matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> Matches<'a, P> {
1424         core_str::StrExt::matches(self, pat)
1425     }
1426
1427     /// An iterator over the disjoint matches of a pattern within this string slice,
1428     /// yielded in reverse order.
1429     ///
1430     /// The pattern can be a `&str`, [`char`], or a closure that determines if
1431     /// a character matches.
1432     ///
1433     /// [`char`]: primitive.char.html
1434     ///
1435     /// # Iterator behavior
1436     ///
1437     /// The returned iterator requires that the pattern supports a reverse
1438     /// search, and it will be a [`DoubleEndedIterator`] if a forward/reverse
1439     /// search yields the same elements.
1440     ///
1441     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1442     ///
1443     /// For iterating from the front, the [`matches`] method can be used.
1444     ///
1445     /// [`matches`]: #method.matches
1446     ///
1447     /// # Examples
1448     ///
1449     /// Basic usage:
1450     ///
1451     /// ```
1452     /// let v: Vec<&str> = "abcXXXabcYYYabc".rmatches("abc").collect();
1453     /// assert_eq!(v, ["abc", "abc", "abc"]);
1454     ///
1455     /// let v: Vec<&str> = "1abc2abc3".rmatches(char::is_numeric).collect();
1456     /// assert_eq!(v, ["3", "2", "1"]);
1457     /// ```
1458     #[stable(feature = "str_matches", since = "1.2.0")]
1459     #[inline]
1460     pub fn rmatches<'a, P: Pattern<'a>>(&'a self, pat: P) -> RMatches<'a, P>
1461         where P::Searcher: ReverseSearcher<'a>
1462     {
1463         core_str::StrExt::rmatches(self, pat)
1464     }
1465
1466     /// An iterator over the disjoint matches of a pattern within this string
1467     /// slice as well as the index that the match starts at.
1468     ///
1469     /// For matches of `pat` within `self` that overlap, only the indices
1470     /// corresponding to the first match are returned.
1471     ///
1472     /// The pattern can be a `&str`, [`char`], or a closure that determines
1473     /// if a character matches.
1474     ///
1475     /// [`char`]: primitive.char.html
1476     ///
1477     /// # Iterator behavior
1478     ///
1479     /// The returned iterator will be a [`DoubleEndedIterator`] if the pattern
1480     /// allows a reverse search and forward/reverse search yields the same
1481     /// elements. This is true for, eg, [`char`] but not for `&str`.
1482     ///
1483     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1484     ///
1485     /// If the pattern allows a reverse search but its results might differ
1486     /// from a forward search, the [`rmatch_indices`] method can be used.
1487     ///
1488     /// [`rmatch_indices`]: #method.rmatch_indices
1489     ///
1490     /// # Examples
1491     ///
1492     /// Basic usage:
1493     ///
1494     /// ```
1495     /// let v: Vec<_> = "abcXXXabcYYYabc".match_indices("abc").collect();
1496     /// assert_eq!(v, [(0, "abc"), (6, "abc"), (12, "abc")]);
1497     ///
1498     /// let v: Vec<_> = "1abcabc2".match_indices("abc").collect();
1499     /// assert_eq!(v, [(1, "abc"), (4, "abc")]);
1500     ///
1501     /// let v: Vec<_> = "ababa".match_indices("aba").collect();
1502     /// assert_eq!(v, [(0, "aba")]); // only the first `aba`
1503     /// ```
1504     #[stable(feature = "str_match_indices", since = "1.5.0")]
1505     #[inline]
1506     pub fn match_indices<'a, P: Pattern<'a>>(&'a self, pat: P) -> MatchIndices<'a, P> {
1507         core_str::StrExt::match_indices(self, pat)
1508     }
1509
1510     /// An iterator over the disjoint matches of a pattern within `self`,
1511     /// yielded in reverse order along with the index of the match.
1512     ///
1513     /// For matches of `pat` within `self` that overlap, only the indices
1514     /// corresponding to the last match are returned.
1515     ///
1516     /// The pattern can be a `&str`, [`char`], or a closure that determines if a
1517     /// character matches.
1518     ///
1519     /// [`char`]: primitive.char.html
1520     ///
1521     /// # Iterator behavior
1522     ///
1523     /// The returned iterator requires that the pattern supports a reverse
1524     /// search, and it will be a [`DoubleEndedIterator`] if a forward/reverse
1525     /// search yields the same elements.
1526     ///
1527     /// [`DoubleEndedIterator`]: iter/trait.DoubleEndedIterator.html
1528     ///
1529     /// For iterating from the front, the [`match_indices`] method can be used.
1530     ///
1531     /// [`match_indices`]: #method.match_indices
1532     ///
1533     /// # Examples
1534     ///
1535     /// Basic usage:
1536     ///
1537     /// ```
1538     /// let v: Vec<_> = "abcXXXabcYYYabc".rmatch_indices("abc").collect();
1539     /// assert_eq!(v, [(12, "abc"), (6, "abc"), (0, "abc")]);
1540     ///
1541     /// let v: Vec<_> = "1abcabc2".rmatch_indices("abc").collect();
1542     /// assert_eq!(v, [(4, "abc"), (1, "abc")]);
1543     ///
1544     /// let v: Vec<_> = "ababa".rmatch_indices("aba").collect();
1545     /// assert_eq!(v, [(2, "aba")]); // only the last `aba`
1546     /// ```
1547     #[stable(feature = "str_match_indices", since = "1.5.0")]
1548     #[inline]
1549     pub fn rmatch_indices<'a, P: Pattern<'a>>(&'a self, pat: P) -> RMatchIndices<'a, P>
1550         where P::Searcher: ReverseSearcher<'a>
1551     {
1552         core_str::StrExt::rmatch_indices(self, pat)
1553     }
1554
1555     /// Returns a string slice with leading and trailing whitespace removed.
1556     ///
1557     /// 'Whitespace' is defined according to the terms of the Unicode Derived
1558     /// Core Property `White_Space`.
1559     ///
1560     /// # Examples
1561     ///
1562     /// Basic usage:
1563     ///
1564     /// ```
1565     /// let s = " Hello\tworld\t";
1566     ///
1567     /// assert_eq!("Hello\tworld", s.trim());
1568     /// ```
1569     #[stable(feature = "rust1", since = "1.0.0")]
1570     pub fn trim(&self) -> &str {
1571         UnicodeStr::trim(self)
1572     }
1573
1574     /// Returns a string slice with leading whitespace removed.
1575     ///
1576     /// 'Whitespace' is defined according to the terms of the Unicode Derived
1577     /// Core Property `White_Space`.
1578     ///
1579     /// # Text directionality
1580     ///
1581     /// A string is a sequence of bytes. 'Left' in this context means the first
1582     /// position of that byte string; for a language like Arabic or Hebrew
1583     /// which are 'right to left' rather than 'left to right', this will be
1584     /// the _right_ side, not the left.
1585     ///
1586     /// # Examples
1587     ///
1588     /// Basic usage:
1589     ///
1590     /// ```
1591     /// let s = " Hello\tworld\t";
1592     ///
1593     /// assert_eq!("Hello\tworld\t", s.trim_left());
1594     /// ```
1595     ///
1596     /// Directionality:
1597     ///
1598     /// ```
1599     /// let s = "  English";
1600     /// assert!(Some('E') == s.trim_left().chars().next());
1601     ///
1602     /// let s = "  עברית";
1603     /// assert!(Some('ע') == s.trim_left().chars().next());
1604     /// ```
1605     #[stable(feature = "rust1", since = "1.0.0")]
1606     pub fn trim_left(&self) -> &str {
1607         UnicodeStr::trim_left(self)
1608     }
1609
1610     /// Returns a string slice with trailing whitespace removed.
1611     ///
1612     /// 'Whitespace' is defined according to the terms of the Unicode Derived
1613     /// Core Property `White_Space`.
1614     ///
1615     /// # Text directionality
1616     ///
1617     /// A string is a sequence of bytes. 'Right' in this context means the last
1618     /// position of that byte string; for a language like Arabic or Hebrew
1619     /// which are 'right to left' rather than 'left to right', this will be
1620     /// the _left_ side, not the right.
1621     ///
1622     /// # Examples
1623     ///
1624     /// Basic usage:
1625     ///
1626     /// ```
1627     /// let s = " Hello\tworld\t";
1628     ///
1629     /// assert_eq!(" Hello\tworld", s.trim_right());
1630     /// ```
1631     ///
1632     /// Directionality:
1633     ///
1634     /// ```
1635     /// let s = "English  ";
1636     /// assert!(Some('h') == s.trim_right().chars().rev().next());
1637     ///
1638     /// let s = "עברית  ";
1639     /// assert!(Some('ת') == s.trim_right().chars().rev().next());
1640     /// ```
1641     #[stable(feature = "rust1", since = "1.0.0")]
1642     pub fn trim_right(&self) -> &str {
1643         UnicodeStr::trim_right(self)
1644     }
1645
1646     /// Returns a string slice with all prefixes and suffixes that match a
1647     /// pattern repeatedly removed.
1648     ///
1649     /// The pattern can be a [`char`] or a closure that determines if a
1650     /// character matches.
1651     ///
1652     /// [`char`]: primitive.char.html
1653     ///
1654     /// # Examples
1655     ///
1656     /// Simple patterns:
1657     ///
1658     /// ```
1659     /// assert_eq!("11foo1bar11".trim_matches('1'), "foo1bar");
1660     /// assert_eq!("123foo1bar123".trim_matches(char::is_numeric), "foo1bar");
1661     ///
1662     /// let x: &[_] = &['1', '2'];
1663     /// assert_eq!("12foo1bar12".trim_matches(x), "foo1bar");
1664     /// ```
1665     ///
1666     /// A more complex pattern, using a closure:
1667     ///
1668     /// ```
1669     /// assert_eq!("1foo1barXX".trim_matches(|c| c == '1' || c == 'X'), "foo1bar");
1670     /// ```
1671     #[stable(feature = "rust1", since = "1.0.0")]
1672     pub fn trim_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str
1673         where P::Searcher: DoubleEndedSearcher<'a>
1674     {
1675         core_str::StrExt::trim_matches(self, pat)
1676     }
1677
1678     /// Returns a string slice with all prefixes that match a pattern
1679     /// repeatedly removed.
1680     ///
1681     /// The pattern can be a `&str`, [`char`], or a closure that determines if
1682     /// a character matches.
1683     ///
1684     /// [`char`]: primitive.char.html
1685     ///
1686     /// # Text directionality
1687     ///
1688     /// A string is a sequence of bytes. 'Left' in this context means the first
1689     /// position of that byte string; for a language like Arabic or Hebrew
1690     /// which are 'right to left' rather than 'left to right', this will be
1691     /// the _right_ side, not the left.
1692     ///
1693     /// # Examples
1694     ///
1695     /// Basic usage:
1696     ///
1697     /// ```
1698     /// assert_eq!("11foo1bar11".trim_left_matches('1'), "foo1bar11");
1699     /// assert_eq!("123foo1bar123".trim_left_matches(char::is_numeric), "foo1bar123");
1700     ///
1701     /// let x: &[_] = &['1', '2'];
1702     /// assert_eq!("12foo1bar12".trim_left_matches(x), "foo1bar12");
1703     /// ```
1704     #[stable(feature = "rust1", since = "1.0.0")]
1705     pub fn trim_left_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str {
1706         core_str::StrExt::trim_left_matches(self, pat)
1707     }
1708
1709     /// Returns a string slice with all suffixes that match a pattern
1710     /// repeatedly removed.
1711     ///
1712     /// The pattern can be a `&str`, [`char`], or a closure that
1713     /// determines if a character matches.
1714     ///
1715     /// [`char`]: primitive.char.html
1716     ///
1717     /// # Text directionality
1718     ///
1719     /// A string is a sequence of bytes. 'Right' in this context means the last
1720     /// position of that byte string; for a language like Arabic or Hebrew
1721     /// which are 'right to left' rather than 'left to right', this will be
1722     /// the _left_ side, not the right.
1723     ///
1724     /// # Examples
1725     ///
1726     /// Simple patterns:
1727     ///
1728     /// ```
1729     /// assert_eq!("11foo1bar11".trim_right_matches('1'), "11foo1bar");
1730     /// assert_eq!("123foo1bar123".trim_right_matches(char::is_numeric), "123foo1bar");
1731     ///
1732     /// let x: &[_] = &['1', '2'];
1733     /// assert_eq!("12foo1bar12".trim_right_matches(x), "12foo1bar");
1734     /// ```
1735     ///
1736     /// A more complex pattern, using a closure:
1737     ///
1738     /// ```
1739     /// assert_eq!("1fooX".trim_left_matches(|c| c == '1' || c == 'X'), "fooX");
1740     /// ```
1741     #[stable(feature = "rust1", since = "1.0.0")]
1742     pub fn trim_right_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str
1743         where P::Searcher: ReverseSearcher<'a>
1744     {
1745         core_str::StrExt::trim_right_matches(self, pat)
1746     }
1747
1748     /// Parses this string slice into another type.
1749     ///
1750     /// Because `parse` is so general, it can cause problems with type
1751     /// inference. As such, `parse` is one of the few times you'll see
1752     /// the syntax affectionately known as the 'turbofish': `::<>`. This
1753     /// helps the inference algorithm understand specifically which type
1754     /// you're trying to parse into.
1755     ///
1756     /// `parse` can parse any type that implements the [`FromStr`] trait.
1757     ///
1758     /// [`FromStr`]: str/trait.FromStr.html
1759     ///
1760     /// # Errors
1761     ///
1762     /// Will return [`Err`] if it's not possible to parse this string slice into
1763     /// the desired type.
1764     ///
1765     /// [`Err`]: str/trait.FromStr.html#associatedtype.Err
1766     ///
1767     /// # Examples
1768     ///
1769     /// Basic usage
1770     ///
1771     /// ```
1772     /// let four: u32 = "4".parse().unwrap();
1773     ///
1774     /// assert_eq!(4, four);
1775     /// ```
1776     ///
1777     /// Using the 'turbofish' instead of annotating `four`:
1778     ///
1779     /// ```
1780     /// let four = "4".parse::<u32>();
1781     ///
1782     /// assert_eq!(Ok(4), four);
1783     /// ```
1784     ///
1785     /// Failing to parse:
1786     ///
1787     /// ```
1788     /// let nope = "j".parse::<u32>();
1789     ///
1790     /// assert!(nope.is_err());
1791     /// ```
1792     #[inline]
1793     #[stable(feature = "rust1", since = "1.0.0")]
1794     pub fn parse<F: FromStr>(&self) -> Result<F, F::Err> {
1795         core_str::StrExt::parse(self)
1796     }
1797
1798     /// Converts a `Box<str>` into a `Box<[u8]>` without copying or allocating.
1799     ///
1800     /// # Examples
1801     ///
1802     /// Basic usage:
1803     ///
1804     /// ```
1805     /// let s = "this is a string";
1806     /// let boxed_str = s.to_owned().into_boxed_str();
1807     /// let boxed_bytes = boxed_str.into_boxed_bytes();
1808     /// assert_eq!(*boxed_bytes, *s.as_bytes());
1809     /// ```
1810     #[stable(feature = "str_box_extras", since = "1.20.0")]
1811     pub fn into_boxed_bytes(self: Box<str>) -> Box<[u8]> {
1812         self.into()
1813     }
1814
1815     /// Replaces all matches of a pattern with another string.
1816     ///
1817     /// `replace` creates a new [`String`], and copies the data from this string slice into it.
1818     /// While doing so, it attempts to find matches of a pattern. If it finds any, it
1819     /// replaces them with the replacement string slice.
1820     ///
1821     /// [`String`]: string/struct.String.html
1822     ///
1823     /// # Examples
1824     ///
1825     /// Basic usage:
1826     ///
1827     /// ```
1828     /// let s = "this is old";
1829     ///
1830     /// assert_eq!("this is new", s.replace("old", "new"));
1831     /// ```
1832     ///
1833     /// When the pattern doesn't match:
1834     ///
1835     /// ```
1836     /// let s = "this is old";
1837     /// assert_eq!(s, s.replace("cookie monster", "little lamb"));
1838     /// ```
1839     #[stable(feature = "rust1", since = "1.0.0")]
1840     #[inline]
1841     pub fn replace<'a, P: Pattern<'a>>(&'a self, from: P, to: &str) -> String {
1842         let mut result = String::new();
1843         let mut last_end = 0;
1844         for (start, part) in self.match_indices(from) {
1845             result.push_str(unsafe { self.slice_unchecked(last_end, start) });
1846             result.push_str(to);
1847             last_end = start + part.len();
1848         }
1849         result.push_str(unsafe { self.slice_unchecked(last_end, self.len()) });
1850         result
1851     }
1852
1853     /// Replaces first N matches of a pattern with another string.
1854     ///
1855     /// `replacen` creates a new [`String`], and copies the data from this string slice into it.
1856     /// While doing so, it attempts to find matches of a pattern. If it finds any, it
1857     /// replaces them with the replacement string slice at most `count` times.
1858     ///
1859     /// [`String`]: string/struct.String.html
1860     ///
1861     /// # Examples
1862     ///
1863     /// Basic usage:
1864     ///
1865     /// ```
1866     /// let s = "foo foo 123 foo";
1867     /// assert_eq!("new new 123 foo", s.replacen("foo", "new", 2));
1868     /// assert_eq!("faa fao 123 foo", s.replacen('o', "a", 3));
1869     /// assert_eq!("foo foo new23 foo", s.replacen(char::is_numeric, "new", 1));
1870     /// ```
1871     ///
1872     /// When the pattern doesn't match:
1873     ///
1874     /// ```
1875     /// let s = "this is old";
1876     /// assert_eq!(s, s.replacen("cookie monster", "little lamb", 10));
1877     /// ```
1878     #[stable(feature = "str_replacen", since = "1.16.0")]
1879     pub fn replacen<'a, P: Pattern<'a>>(&'a self, pat: P, to: &str, count: usize) -> String {
1880         // Hope to reduce the times of re-allocation
1881         let mut result = String::with_capacity(32);
1882         let mut last_end = 0;
1883         for (start, part) in self.match_indices(pat).take(count) {
1884             result.push_str(unsafe { self.slice_unchecked(last_end, start) });
1885             result.push_str(to);
1886             last_end = start + part.len();
1887         }
1888         result.push_str(unsafe { self.slice_unchecked(last_end, self.len()) });
1889         result
1890     }
1891
1892     /// Returns the lowercase equivalent of this string slice, as a new [`String`].
1893     ///
1894     /// 'Lowercase' is defined according to the terms of the Unicode Derived Core Property
1895     /// `Lowercase`.
1896     ///
1897     /// Since some characters can expand into multiple characters when changing
1898     /// the case, this function returns a [`String`] instead of modifying the
1899     /// parameter in-place.
1900     ///
1901     /// [`String`]: string/struct.String.html
1902     ///
1903     /// # Examples
1904     ///
1905     /// Basic usage:
1906     ///
1907     /// ```
1908     /// let s = "HELLO";
1909     ///
1910     /// assert_eq!("hello", s.to_lowercase());
1911     /// ```
1912     ///
1913     /// A tricky example, with sigma:
1914     ///
1915     /// ```
1916     /// let sigma = "Σ";
1917     ///
1918     /// assert_eq!("σ", sigma.to_lowercase());
1919     ///
1920     /// // but at the end of a word, it's ς, not σ:
1921     /// let odysseus = "ὈΔΥΣΣΕΎΣ";
1922     ///
1923     /// assert_eq!("ὀδυσσεύς", odysseus.to_lowercase());
1924     /// ```
1925     ///
1926     /// Languages without case are not changed:
1927     ///
1928     /// ```
1929     /// let new_year = "农历新年";
1930     ///
1931     /// assert_eq!(new_year, new_year.to_lowercase());
1932     /// ```
1933     #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
1934     pub fn to_lowercase(&self) -> String {
1935         let mut s = String::with_capacity(self.len());
1936         for (i, c) in self[..].char_indices() {
1937             if c == 'Σ' {
1938                 // Σ maps to σ, except at the end of a word where it maps to ς.
1939                 // This is the only conditional (contextual) but language-independent mapping
1940                 // in `SpecialCasing.txt`,
1941                 // so hard-code it rather than have a generic "condition" mechanism.
1942                 // See https://github.com/rust-lang/rust/issues/26035
1943                 map_uppercase_sigma(self, i, &mut s)
1944             } else {
1945                 s.extend(c.to_lowercase());
1946             }
1947         }
1948         return s;
1949
1950         fn map_uppercase_sigma(from: &str, i: usize, to: &mut String) {
1951             // See http://www.unicode.org/versions/Unicode7.0.0/ch03.pdf#G33992
1952             // for the definition of `Final_Sigma`.
1953             debug_assert!('Σ'.len_utf8() == 2);
1954             let is_word_final = case_ignoreable_then_cased(from[..i].chars().rev()) &&
1955                                 !case_ignoreable_then_cased(from[i + 2..].chars());
1956             to.push_str(if is_word_final { "ς" } else { "σ" });
1957         }
1958
1959         fn case_ignoreable_then_cased<I: Iterator<Item = char>>(iter: I) -> bool {
1960             use std_unicode::derived_property::{Cased, Case_Ignorable};
1961             match iter.skip_while(|&c| Case_Ignorable(c)).next() {
1962                 Some(c) => Cased(c),
1963                 None => false,
1964             }
1965         }
1966     }
1967
1968     /// Returns the uppercase equivalent of this string slice, as a new [`String`].
1969     ///
1970     /// 'Uppercase' is defined according to the terms of the Unicode Derived Core Property
1971     /// `Uppercase`.
1972     ///
1973     /// Since some characters can expand into multiple characters when changing
1974     /// the case, this function returns a [`String`] instead of modifying the
1975     /// parameter in-place.
1976     ///
1977     /// [`String`]: string/struct.String.html
1978     ///
1979     /// # Examples
1980     ///
1981     /// Basic usage:
1982     ///
1983     /// ```
1984     /// let s = "hello";
1985     ///
1986     /// assert_eq!("HELLO", s.to_uppercase());
1987     /// ```
1988     ///
1989     /// Scripts without case are not changed:
1990     ///
1991     /// ```
1992     /// let new_year = "农历新年";
1993     ///
1994     /// assert_eq!(new_year, new_year.to_uppercase());
1995     /// ```
1996     #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
1997     pub fn to_uppercase(&self) -> String {
1998         let mut s = String::with_capacity(self.len());
1999         s.extend(self.chars().flat_map(|c| c.to_uppercase()));
2000         return s;
2001     }
2002
2003     /// Escapes each char in `s` with [`char::escape_debug`].
2004     ///
2005     /// [`char::escape_debug`]: primitive.char.html#method.escape_debug
2006     #[unstable(feature = "str_escape",
2007                reason = "return type may change to be an iterator",
2008                issue = "27791")]
2009     pub fn escape_debug(&self) -> String {
2010         self.chars().flat_map(|c| c.escape_debug()).collect()
2011     }
2012
2013     /// Escapes each char in `s` with [`char::escape_default`].
2014     ///
2015     /// [`char::escape_default`]: primitive.char.html#method.escape_default
2016     #[unstable(feature = "str_escape",
2017                reason = "return type may change to be an iterator",
2018                issue = "27791")]
2019     pub fn escape_default(&self) -> String {
2020         self.chars().flat_map(|c| c.escape_default()).collect()
2021     }
2022
2023     /// Escapes each char in `s` with [`char::escape_unicode`].
2024     ///
2025     /// [`char::escape_unicode`]: primitive.char.html#method.escape_unicode
2026     #[unstable(feature = "str_escape",
2027                reason = "return type may change to be an iterator",
2028                issue = "27791")]
2029     pub fn escape_unicode(&self) -> String {
2030         self.chars().flat_map(|c| c.escape_unicode()).collect()
2031     }
2032
2033     /// Converts a [`Box<str>`] into a [`String`] without copying or allocating.
2034     ///
2035     /// [`String`]: string/struct.String.html
2036     /// [`Box<str>`]: boxed/struct.Box.html
2037     ///
2038     /// # Examples
2039     ///
2040     /// Basic usage:
2041     ///
2042     /// ```
2043     /// let string = String::from("birthday gift");
2044     /// let boxed_str = string.clone().into_boxed_str();
2045     ///
2046     /// assert_eq!(boxed_str.into_string(), string);
2047     /// ```
2048     #[stable(feature = "box_str", since = "1.4.0")]
2049     pub fn into_string(self: Box<str>) -> String {
2050         unsafe {
2051             let slice = mem::transmute::<Box<str>, Box<[u8]>>(self);
2052             String::from_utf8_unchecked(slice.into_vec())
2053         }
2054     }
2055
2056     /// Create a [`String`] by repeating a string `n` times.
2057     ///
2058     /// [`String`]: string/struct.String.html
2059     ///
2060     /// # Examples
2061     ///
2062     /// Basic usage:
2063     ///
2064     /// ```
2065     /// assert_eq!("abc".repeat(4), String::from("abcabcabcabc"));
2066     /// ```
2067     #[stable(feature = "repeat_str", since = "1.16.0")]
2068     pub fn repeat(&self, n: usize) -> String {
2069         let mut s = String::with_capacity(self.len() * n);
2070         s.extend((0..n).map(|_| self));
2071         s
2072     }
2073 }
2074
2075 /// Converts a boxed slice of bytes to a boxed string slice without checking
2076 /// that the string contains valid UTF-8.
2077 ///
2078 /// # Examples
2079 ///
2080 /// Basic usage:
2081 ///
2082 /// ```
2083 /// let smile_utf8 = Box::new([226, 152, 186]);
2084 /// let smile = unsafe { std::str::from_boxed_utf8_unchecked(smile_utf8) };
2085 ///
2086 /// assert_eq!("☺", &*smile);
2087 /// ```
2088 #[stable(feature = "str_box_extras", since = "1.20.0")]
2089 pub unsafe fn from_boxed_utf8_unchecked(v: Box<[u8]>) -> Box<str> {
2090     mem::transmute(v)
2091 }