library/alloc/src/str.rs

   1 //! Unicode string slices.
   2 //!
   3 //! *[See also the `str` primitive type](str).*
   4 //!
   5 //! The `&str` type is one of the two main string types, the other being `String`.
   6 //! Unlike its `String` counterpart, its contents are borrowed.
   7 //!
   8 //! # Basic Usage
   9 //!
  10 //! A basic string declaration of `&str` type:
  11 //!
  12 //! ```
  13 //! let hello_world = "Hello, World!";
  14 //! ```
  15 //!
  16 //! Here we have declared a string literal, also known as a string slice.
  17 //! String literals have a static lifetime, which means the string `hello_world`
  18 //! is guaranteed to be valid for the duration of the entire program.
  19 //! We can explicitly specify `hello_world`'s lifetime as well:
  20 //!
  21 //! ```
  22 //! let hello_world: &'static str = "Hello, world!";
  23 //! ```
  24
  25 #![stable(feature = "rust1", since = "1.0.0")]
  26 // Many of the usings in this module are only used in the test configuration.
  27 // It's cleaner to just turn off the unused_imports warning than to fix them.
  28 #![allow(unused_imports)]
  29
  30 use core::borrow::{Borrow, BorrowMut};
  31 use core::iter::FusedIterator;
  32 use core::mem;
  33 use core::ptr;
  34 use core::str::pattern::{DoubleEndedSearcher, Pattern, ReverseSearcher, Searcher};
  35 use core::unicode::conversions;
  36
  37 use crate::borrow::ToOwned;
  38 use crate::boxed::Box;
  39 use crate::slice::{Concat, Join, SliceIndex};
  40 use crate::string::String;
  41 use crate::vec::Vec;
  42
  43 #[stable(feature = "rust1", since = "1.0.0")]
  44 pub use core::str::pattern;
  45 #[stable(feature = "encode_utf16", since = "1.8.0")]
  46 pub use core::str::EncodeUtf16;
  47 #[stable(feature = "split_ascii_whitespace", since = "1.34.0")]
  48 pub use core::str::SplitAsciiWhitespace;
  49 #[stable(feature = "split_inclusive", since = "1.53.0")]
  50 pub use core::str::SplitInclusive;
  51 #[stable(feature = "rust1", since = "1.0.0")]
  52 pub use core::str::SplitWhitespace;
  53 #[stable(feature = "rust1", since = "1.0.0")]
  54 pub use core::str::{from_utf8, from_utf8_mut, Bytes, CharIndices, Chars};
  55 #[stable(feature = "rust1", since = "1.0.0")]
  56 pub use core::str::{from_utf8_unchecked, from_utf8_unchecked_mut, ParseBoolError};
  57 #[stable(feature = "str_escape", since = "1.34.0")]
  58 pub use core::str::{EscapeDebug, EscapeDefault, EscapeUnicode};
  59 #[stable(feature = "rust1", since = "1.0.0")]
  60 pub use core::str::{FromStr, Utf8Error};
  61 #[allow(deprecated)]
  62 #[stable(feature = "rust1", since = "1.0.0")]
  63 pub use core::str::{Lines, LinesAny};
  64 #[stable(feature = "rust1", since = "1.0.0")]
  65 pub use core::str::{MatchIndices, RMatchIndices};
  66 #[stable(feature = "rust1", since = "1.0.0")]
  67 pub use core::str::{Matches, RMatches};
  68 #[stable(feature = "rust1", since = "1.0.0")]
  69 pub use core::str::{RSplit, Split};
  70 #[stable(feature = "rust1", since = "1.0.0")]
  71 pub use core::str::{RSplitN, SplitN};
  72 #[stable(feature = "rust1", since = "1.0.0")]
  73 pub use core::str::{RSplitTerminator, SplitTerminator};
  74
  75 /// Note: `str` in `Concat<str>` is not meaningful here.
  76 /// This type parameter of the trait only exists to enable another impl.
  77 #[unstable(feature = "slice_concat_ext", issue = "27747")]
  78 impl<S: Borrow<str>> Concat<str> for [S] {
  79     type Output = String;
  80
  81     fn concat(slice: &Self) -> String {
  82         Join::join(slice, "")
  83     }
  84 }
  85
  86 #[unstable(feature = "slice_concat_ext", issue = "27747")]
  87 impl<S: Borrow<str>> Join<&str> for [S] {
  88     type Output = String;
  89
  90     fn join(slice: &Self, sep: &str) -> String {
  91         unsafe { String::from_utf8_unchecked(join_generic_copy(slice, sep.as_bytes())) }
  92     }
  93 }
  94
  95 macro_rules! spezialize_for_lengths {
  96     ($separator:expr, $target:expr, $iter:expr; $($num:expr),*) => {
  97         let mut target = $target;
  98         let iter = $iter;
  99         let sep_bytes = $separator;
 100         match $separator.len() {
 101             $(
 102                 // loops with hardcoded sizes run much faster
 103                 // specialize the cases with small separator lengths
 104                 $num => {
 105                     for s in iter {
 106                         copy_slice_and_advance!(target, sep_bytes);
 107                         copy_slice_and_advance!(target, s.borrow().as_ref());
 108                     }
 109                 },
 110             )*
 111             _ => {
 112                 // arbitrary non-zero size fallback
 113                 for s in iter {
 114                     copy_slice_and_advance!(target, sep_bytes);
 115                     copy_slice_and_advance!(target, s.borrow().as_ref());
 116                 }
 117             }
 118         }
 119     };
 120 }
 121
 122 macro_rules! copy_slice_and_advance {
 123     ($target:expr, $bytes:expr) => {
 124         let len = $bytes.len();
 125         let (head, tail) = { $target }.split_at_mut(len);
 126         head.copy_from_slice($bytes);
 127         $target = tail;
 128     };
 129 }
 130
 131 // Optimized join implementation that works for both Vec<T> (T: Copy) and String's inner vec
 132 // Currently (2018-05-13) there is a bug with type inference and specialization (see issue #36262)
 133 // For this reason SliceConcat<T> is not specialized for T: Copy and SliceConcat<str> is the
 134 // only user of this function. It is left in place for the time when that is fixed.
 135 //
 136 // the bounds for String-join are S: Borrow<str> and for Vec-join Borrow<[T]>
 137 // [T] and str both impl AsRef<[T]> for some T
 138 // => s.borrow().as_ref() and we always have slices
 139 fn join_generic_copy<B, T, S>(slice: &[S], sep: &[T]) -> Vec<T>
 140 where
 141     T: Copy,
 142     B: AsRef<[T]> + ?Sized,
 143     S: Borrow<B>,
 144 {
 145     let sep_len = sep.len();
 146     let mut iter = slice.iter();
 147
 148     // the first slice is the only one without a separator preceding it
 149     let first = match iter.next() {
 150         Some(first) => first,
 151         None => return vec![],
 152     };
 153
 154     // compute the exact total length of the joined Vec
 155     // if the `len` calculation overflows, we'll panic
 156     // we would have run out of memory anyway and the rest of the function requires
 157     // the entire Vec pre-allocated for safety
 158     let len = sep_len
 159         .checked_mul(iter.len())
 160         .and_then(|n| {
 161             slice.iter().map(|s| s.borrow().as_ref().len()).try_fold(n, usize::checked_add)
 162         })
 163         .expect("attempt to join into collection with len > usize::MAX");
 164
 165     // crucial for safety
 166     let mut result = Vec::with_capacity(len);
 167     assert!(result.capacity() >= len);
 168
 169     result.extend_from_slice(first.borrow().as_ref());
 170
 171     unsafe {
 172         {
 173             let pos = result.len();
 174             let target = result.get_unchecked_mut(pos..len);
 175
 176             // copy separator and slices over without bounds checks
 177             // generate loops with hardcoded offsets for small separators
 178             // massive improvements possible (~ x2)
 179             spezialize_for_lengths!(sep, target, iter; 0, 1, 2, 3, 4);
 180         }
 181         result.set_len(len);
 182     }
 183     result
 184 }
 185
 186 #[stable(feature = "rust1", since = "1.0.0")]
 187 impl Borrow<str> for String {
 188     #[inline]
 189     fn borrow(&self) -> &str {
 190         &self[..]
 191     }
 192 }
 193
 194 #[stable(feature = "string_borrow_mut", since = "1.36.0")]
 195 impl BorrowMut<str> for String {
 196     #[inline]
 197     fn borrow_mut(&mut self) -> &mut str {
 198         &mut self[..]
 199     }
 200 }
 201
 202 #[stable(feature = "rust1", since = "1.0.0")]
 203 impl ToOwned for str {
 204     type Owned = String;
 205     #[inline]
 206     fn to_owned(&self) -> String {
 207         unsafe { String::from_utf8_unchecked(self.as_bytes().to_owned()) }
 208     }
 209
 210     fn clone_into(&self, target: &mut String) {
 211         let mut b = mem::take(target).into_bytes();
 212         self.as_bytes().clone_into(&mut b);
 213         *target = unsafe { String::from_utf8_unchecked(b) }
 214     }
 215 }
 216
 217 /// Methods for string slices.
 218 #[lang = "str_alloc"]
 219 #[cfg(not(test))]
 220 impl str {
 221     /// Converts a `Box<str>` into a `Box<[u8]>` without copying or allocating.
 222     ///
 223     /// # Examples
 224     ///
 225     /// Basic usage:
 226     ///
 227     /// ```
 228     /// let s = "this is a string";
 229     /// let boxed_str = s.to_owned().into_boxed_str();
 230     /// let boxed_bytes = boxed_str.into_boxed_bytes();
 231     /// assert_eq!(*boxed_bytes, *s.as_bytes());
 232     /// ```
 233     #[stable(feature = "str_box_extras", since = "1.20.0")]
 234     #[inline]
 235     pub fn into_boxed_bytes(self: Box<str>) -> Box<[u8]> {
 236         self.into()
 237     }
 238
 239     /// Replaces all matches of a pattern with another string.
 240     ///
 241     /// `replace` creates a new [`String`], and copies the data from this string slice into it.
 242     /// While doing so, it attempts to find matches of a pattern. If it finds any, it
 243     /// replaces them with the replacement string slice.
 244     ///
 245     /// # Examples
 246     ///
 247     /// Basic usage:
 248     ///
 249     /// ```
 250     /// let s = "this is old";
 251     ///
 252     /// assert_eq!("this is new", s.replace("old", "new"));
 253     /// ```
 254     ///
 255     /// When the pattern doesn't match:
 256     ///
 257     /// ```
 258     /// let s = "this is old";
 259     /// assert_eq!(s, s.replace("cookie monster", "little lamb"));
 260     /// ```
 261     #[must_use = "this returns the replaced string as a new allocation, \
 262                   without modifying the original"]
 263     #[stable(feature = "rust1", since = "1.0.0")]
 264     #[inline]
 265     pub fn replace<'a, P: Pattern<'a>>(&'a self, from: P, to: &str) -> String {
 266         let mut result = String::new();
 267         let mut last_end = 0;
 268         for (start, part) in self.match_indices(from) {
 269             result.push_str(unsafe { self.get_unchecked(last_end..start) });
 270             result.push_str(to);
 271             last_end = start + part.len();
 272         }
 273         result.push_str(unsafe { self.get_unchecked(last_end..self.len()) });
 274         result
 275     }
 276
 277     /// Replaces first N matches of a pattern with another string.
 278     ///
 279     /// `replacen` creates a new [`String`], and copies the data from this string slice into it.
 280     /// While doing so, it attempts to find matches of a pattern. If it finds any, it
 281     /// replaces them with the replacement string slice at most `count` times.
 282     ///
 283     /// # Examples
 284     ///
 285     /// Basic usage:
 286     ///
 287     /// ```
 288     /// let s = "foo foo 123 foo";
 289     /// assert_eq!("new new 123 foo", s.replacen("foo", "new", 2));
 290     /// assert_eq!("faa fao 123 foo", s.replacen('o', "a", 3));
 291     /// assert_eq!("foo foo new23 foo", s.replacen(char::is_numeric, "new", 1));
 292     /// ```
 293     ///
 294     /// When the pattern doesn't match:
 295     ///
 296     /// ```
 297     /// let s = "this is old";
 298     /// assert_eq!(s, s.replacen("cookie monster", "little lamb", 10));
 299     /// ```
 300     #[must_use = "this returns the replaced string as a new allocation, \
 301                   without modifying the original"]
 302     #[stable(feature = "str_replacen", since = "1.16.0")]
 303     pub fn replacen<'a, P: Pattern<'a>>(&'a self, pat: P, to: &str, count: usize) -> String {
 304         // Hope to reduce the times of re-allocation
 305         let mut result = String::with_capacity(32);
 306         let mut last_end = 0;
 307         for (start, part) in self.match_indices(pat).take(count) {
 308             result.push_str(unsafe { self.get_unchecked(last_end..start) });
 309             result.push_str(to);
 310             last_end = start + part.len();
 311         }
 312         result.push_str(unsafe { self.get_unchecked(last_end..self.len()) });
 313         result
 314     }
 315
 316     /// Returns the lowercase equivalent of this string slice, as a new [`String`].
 317     ///
 318     /// 'Lowercase' is defined according to the terms of the Unicode Derived Core Property
 319     /// `Lowercase`.
 320     ///
 321     /// Since some characters can expand into multiple characters when changing
 322     /// the case, this function returns a [`String`] instead of modifying the
 323     /// parameter in-place.
 324     ///
 325     /// # Examples
 326     ///
 327     /// Basic usage:
 328     ///
 329     /// ```
 330     /// let s = "HELLO";
 331     ///
 332     /// assert_eq!("hello", s.to_lowercase());
 333     /// ```
 334     ///
 335     /// A tricky example, with sigma:
 336     ///
 337     /// ```
 338     /// let sigma = "Σ";
 339     ///
 340     /// assert_eq!("σ", sigma.to_lowercase());
 341     ///
 342     /// // but at the end of a word, it's ς, not σ:
 343     /// let odysseus = "ὈΔΥΣΣΕΎΣ";
 344     ///
 345     /// assert_eq!("ὀδυσσεύς", odysseus.to_lowercase());
 346     /// ```
 347     ///
 348     /// Languages without case are not changed:
 349     ///
 350     /// ```
 351     /// let new_year = "农历新年";
 352     ///
 353     /// assert_eq!(new_year, new_year.to_lowercase());
 354     /// ```
 355     #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
 356     pub fn to_lowercase(&self) -> String {
 357         let mut s = String::with_capacity(self.len());
 358         for (i, c) in self[..].char_indices() {
 359             if c == 'Σ' {
 360                 // Σ maps to σ, except at the end of a word where it maps to ς.
 361                 // This is the only conditional (contextual) but language-independent mapping
 362                 // in `SpecialCasing.txt`,
 363                 // so hard-code it rather than have a generic "condition" mechanism.
 364                 // See https://github.com/rust-lang/rust/issues/26035
 365                 map_uppercase_sigma(self, i, &mut s)
 366             } else {
 367                 match conversions::to_lower(c) {
 368                     [a, '\0', _] => s.push(a),
 369                     [a, b, '\0'] => {
 370                         s.push(a);
 371                         s.push(b);
 372                     }
 373                     [a, b, c] => {
 374                         s.push(a);
 375                         s.push(b);
 376                         s.push(c);
 377                     }
 378                 }
 379             }
 380         }
 381         return s;
 382
 383         fn map_uppercase_sigma(from: &str, i: usize, to: &mut String) {
 384             // See http://www.unicode.org/versions/Unicode7.0.0/ch03.pdf#G33992
 385             // for the definition of `Final_Sigma`.
 386             debug_assert!('Σ'.len_utf8() == 2);
 387             let is_word_final = case_ignoreable_then_cased(from[..i].chars().rev())
 388                 && !case_ignoreable_then_cased(from[i + 2..].chars());
 389             to.push_str(if is_word_final { "ς" } else { "σ" });
 390         }
 391
 392         fn case_ignoreable_then_cased<I: Iterator<Item = char>>(iter: I) -> bool {
 393             use core::unicode::{Case_Ignorable, Cased};
 394             match iter.skip_while(|&c| Case_Ignorable(c)).next() {
 395                 Some(c) => Cased(c),
 396                 None => false,
 397             }
 398         }
 399     }
 400
 401     /// Returns the uppercase equivalent of this string slice, as a new [`String`].
 402     ///
 403     /// 'Uppercase' is defined according to the terms of the Unicode Derived Core Property
 404     /// `Uppercase`.
 405     ///
 406     /// Since some characters can expand into multiple characters when changing
 407     /// the case, this function returns a [`String`] instead of modifying the
 408     /// parameter in-place.
 409     ///
 410     /// # Examples
 411     ///
 412     /// Basic usage:
 413     ///
 414     /// ```
 415     /// let s = "hello";
 416     ///
 417     /// assert_eq!("HELLO", s.to_uppercase());
 418     /// ```
 419     ///
 420     /// Scripts without case are not changed:
 421     ///
 422     /// ```
 423     /// let new_year = "农历新年";
 424     ///
 425     /// assert_eq!(new_year, new_year.to_uppercase());
 426     /// ```
 427     ///
 428     /// One character can become multiple:
 429     /// ```
 430     /// let s = "tschüß";
 431     ///
 432     /// assert_eq!("TSCHÜSS", s.to_uppercase());
 433     /// ```
 434     #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
 435     pub fn to_uppercase(&self) -> String {
 436         let mut s = String::with_capacity(self.len());
 437         for c in self[..].chars() {
 438             match conversions::to_upper(c) {
 439                 [a, '\0', _] => s.push(a),
 440                 [a, b, '\0'] => {
 441                     s.push(a);
 442                     s.push(b);
 443                 }
 444                 [a, b, c] => {
 445                     s.push(a);
 446                     s.push(b);
 447                     s.push(c);
 448                 }
 449             }
 450         }
 451         s
 452     }
 453
 454     /// Converts a [`Box<str>`] into a [`String`] without copying or allocating.
 455     ///
 456     /// # Examples
 457     ///
 458     /// Basic usage:
 459     ///
 460     /// ```
 461     /// let string = String::from("birthday gift");
 462     /// let boxed_str = string.clone().into_boxed_str();
 463     ///
 464     /// assert_eq!(boxed_str.into_string(), string);
 465     /// ```
 466     #[stable(feature = "box_str", since = "1.4.0")]
 467     #[inline]
 468     pub fn into_string(self: Box<str>) -> String {
 469         let slice = Box::<[u8]>::from(self);
 470         unsafe { String::from_utf8_unchecked(slice.into_vec()) }
 471     }
 472
 473     /// Creates a new [`String`] by repeating a string `n` times.
 474     ///
 475     /// # Panics
 476     ///
 477     /// This function will panic if the capacity would overflow.
 478     ///
 479     /// # Examples
 480     ///
 481     /// Basic usage:
 482     ///
 483     /// ```
 484     /// assert_eq!("abc".repeat(4), String::from("abcabcabcabc"));
 485     /// ```
 486     ///
 487     /// A panic upon overflow:
 488     ///
 489     /// ```should_panic
 490     /// // this will panic at runtime
 491     /// "0123456789abcdef".repeat(usize::MAX);
 492     /// ```
 493     #[stable(feature = "repeat_str", since = "1.16.0")]
 494     pub fn repeat(&self, n: usize) -> String {
 495         unsafe { String::from_utf8_unchecked(self.as_bytes().repeat(n)) }
 496     }
 497
 498     /// Returns a copy of this string where each character is mapped to its
 499     /// ASCII upper case equivalent.
 500     ///
 501     /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
 502     /// but non-ASCII letters are unchanged.
 503     ///
 504     /// To uppercase the value in-place, use [`make_ascii_uppercase`].
 505     ///
 506     /// To uppercase ASCII characters in addition to non-ASCII characters, use
 507     /// [`to_uppercase`].
 508     ///
 509     /// # Examples
 510     ///
 511     /// ```
 512     /// let s = "Grüße, Jürgen ❤";
 513     ///
 514     /// assert_eq!("GRüßE, JüRGEN ❤", s.to_ascii_uppercase());
 515     /// ```
 516     ///
 517     /// [`make_ascii_uppercase`]: str::make_ascii_uppercase
 518     /// [`to_uppercase`]: #method.to_uppercase
 519     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
 520     #[inline]
 521     pub fn to_ascii_uppercase(&self) -> String {
 522         let mut bytes = self.as_bytes().to_vec();
 523         bytes.make_ascii_uppercase();
 524         // make_ascii_uppercase() preserves the UTF-8 invariant.
 525         unsafe { String::from_utf8_unchecked(bytes) }
 526     }
 527
 528     /// Returns a copy of this string where each character is mapped to its
 529     /// ASCII lower case equivalent.
 530     ///
 531     /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
 532     /// but non-ASCII letters are unchanged.
 533     ///
 534     /// To lowercase the value in-place, use [`make_ascii_lowercase`].
 535     ///
 536     /// To lowercase ASCII characters in addition to non-ASCII characters, use
 537     /// [`to_lowercase`].
 538     ///
 539     /// # Examples
 540     ///
 541     /// ```
 542     /// let s = "Grüße, Jürgen ❤";
 543     ///
 544     /// assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());
 545     /// ```
 546     ///
 547     /// [`make_ascii_lowercase`]: str::make_ascii_lowercase
 548     /// [`to_lowercase`]: #method.to_lowercase
 549     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
 550     #[inline]
 551     pub fn to_ascii_lowercase(&self) -> String {
 552         let mut bytes = self.as_bytes().to_vec();
 553         bytes.make_ascii_lowercase();
 554         // make_ascii_lowercase() preserves the UTF-8 invariant.
 555         unsafe { String::from_utf8_unchecked(bytes) }
 556     }
 557 }
 558
 559 /// Converts a boxed slice of bytes to a boxed string slice without checking
 560 /// that the string contains valid UTF-8.
 561 ///
 562 /// # Examples
 563 ///
 564 /// Basic usage:
 565 ///
 566 /// ```
 567 /// let smile_utf8 = Box::new([226, 152, 186]);
 568 /// let smile = unsafe { std::str::from_boxed_utf8_unchecked(smile_utf8) };
 569 ///
 570 /// assert_eq!("☺", &*smile);
 571 /// ```
 572 #[stable(feature = "str_box_extras", since = "1.20.0")]
 573 #[inline]
 574 pub unsafe fn from_boxed_utf8_unchecked(v: Box<[u8]>) -> Box<str> {
 575     unsafe { Box::from_raw(Box::into_raw(v) as *mut str) }
 576 }