alloc/

str.rs

//! Utilities for the `str` primitive type.
//!
//! *[See also the `str` primitive type](str).*

#![stable(feature = "rust1", since = "1.0.0")]
// Many of the usings in this module are only used in the test configuration.
// It's cleaner to just turn off the unused_imports warning than to fix them.
#![allow(unused_imports)]

use core::borrow::{Borrow, BorrowMut};
use core::iter::FusedIterator;
use core::mem::MaybeUninit;
#[stable(feature = "encode_utf16", since = "1.8.0")]
pub use core::str::EncodeUtf16;
#[stable(feature = "split_ascii_whitespace", since = "1.34.0")]
pub use core::str::SplitAsciiWhitespace;
#[stable(feature = "split_inclusive", since = "1.51.0")]
pub use core::str::SplitInclusive;
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::SplitWhitespace;
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::pattern;
use core::str::pattern::{DoubleEndedSearcher, Pattern, ReverseSearcher, Searcher, Utf8Pattern};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{Bytes, CharIndices, Chars, from_utf8, from_utf8_mut};
#[stable(feature = "str_escape", since = "1.34.0")]
pub use core::str::{EscapeDebug, EscapeDefault, EscapeUnicode};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{FromStr, Utf8Error};
#[allow(deprecated)]
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{Lines, LinesAny};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{MatchIndices, RMatchIndices};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{Matches, RMatches};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{ParseBoolError, from_utf8_unchecked, from_utf8_unchecked_mut};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{RSplit, Split};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{RSplitN, SplitN};
#[stable(feature = "rust1", since = "1.0.0")]
pub use core::str::{RSplitTerminator, SplitTerminator};
#[stable(feature = "utf8_chunks", since = "1.79.0")]
pub use core::str::{Utf8Chunk, Utf8Chunks};
#[unstable(feature = "str_from_raw_parts", issue = "119206")]
pub use core::str::{from_raw_parts, from_raw_parts_mut};
use core::unicode::conversions;
use core::{mem, ptr};

use crate::borrow::ToOwned;
use crate::boxed::Box;
use crate::slice::{Concat, Join, SliceIndex};
use crate::string::String;
use crate::vec::Vec;

/// Note: `str` in `Concat<str>` is not meaningful here.
/// This type parameter of the trait only exists to enable another impl.
#[cfg(not(no_global_oom_handling))]
#[unstable(feature = "slice_concat_ext", issue = "27747")]
impl<S: Borrow<str>> Concat<str> for [S] {
    type Output = String;

    fn concat(slice: &Self) -> String {
        Join::join(slice, "")
    }
}

#[cfg(not(no_global_oom_handling))]
#[unstable(feature = "slice_concat_ext", issue = "27747")]
impl<S: Borrow<str>> Join<&str> for [S] {
    type Output = String;

    fn join(slice: &Self, sep: &str) -> String {
        // SAFETY: slice can be borrowed as `[&str]` and sep is `&str`, both are valid UTF-8,
        // so the returned `Vec<u8>` of `join_generic_copy` is also valid UTF-8.
        unsafe { String::from_utf8_unchecked(join_generic_copy(slice, sep.as_bytes())) }
    }
}

#[cfg(not(no_global_oom_handling))]
macro_rules! specialize_for_lengths {
    ($separator:expr, $target:expr, $iter:expr; $($num:expr),*) => {{
        let mut target = $target;
        let iter = $iter;
        let sep_bytes = $separator;
        match $separator.len() {
            $(
                // loops with hardcoded sizes run much faster
                // specialize the cases with small separator lengths
                $num => {
                    for s in iter {
                        copy_slice_and_advance!(target, sep_bytes);
                        let content_bytes = s.borrow().as_ref();
                        copy_slice_and_advance!(target, content_bytes);
                    }
                },
            )*
            _ => {
                // arbitrary non-zero size fallback
                for s in iter {
                    copy_slice_and_advance!(target, sep_bytes);
                    let content_bytes = s.borrow().as_ref();
                    copy_slice_and_advance!(target, content_bytes);
                }
            }
        }
        target
    }}
}

#[cfg(not(no_global_oom_handling))]
macro_rules! copy_slice_and_advance {
    ($target:expr, $bytes:expr) => {
        let len = $bytes.len();
        let (head, tail) = { $target }.split_at_mut(len);
        head.copy_from_slice($bytes);
        $target = tail;
    };
}

// Optimized join implementation that works for both Vec<T> (T: Copy) and String's inner vec
// Currently (2018-05-13) there is a bug with type inference and specialization (see issue #36262)
// For this reason SliceConcat<T> is not specialized for T: Copy and SliceConcat<str> is the
// only user of this function. It is left in place for the time when that is fixed.
//
// the bounds for String-join are S: Borrow<str> and for Vec-join Borrow<[T]>
// [T] and str both impl AsRef<[T]> for some T
// => s.borrow().as_ref() and we always have slices
//
// # Safety notes
//
// `Borrow` is a safe trait, and implementations are not required
// to be deterministic. An inconsistent `Borrow` implementation could return slices
// of different lengths on consecutive calls (e.g. by using interior mutability).
//
// This implementation calls `borrow()` multiple times:
// 1. To calculate `reserved_len`, all elements are borrowed once.
// 2. All elements, except the first, are borrowed a second time when building the mapped iterator.
//
// Risks and Mitigations:
// - If elements 2..N GROW on their second borrow, the target slice bounds set by `checked_sub`
//   means that `split_at_mut` inside `copy_slice_and_advance!` will correctly panic.
// - If elements SHRINK on their second borrow, the spare space is never written, and the final
//   length set via `set_len` masks trailing uninitialized bytes.
#[cfg(not(no_global_oom_handling))]
fn join_generic_copy<B, T, S>(slice: &[S], sep: &[T]) -> Vec<T>
where
    T: Copy,
    B: AsRef<[T]> + ?Sized,
    S: Borrow<B>,
{
    let sep_len = sep.len();
    let mut iter = slice.iter();

    // the first slice is the only one without a separator preceding it
    // we take care to only borrow this once during the length calculation
    // to avoid inconsistent Borrow implementations from breaking our assumptions
    let first = match iter.next() {
        Some(first) => first.borrow().as_ref(),
        None => return vec![],
    };

    // compute the exact total length of the joined Vec
    // if the `len` calculation overflows, we'll panic
    // we would have run out of memory anyway and the rest of the function requires
    // the entire Vec pre-allocated for safety
    let reserved_len = sep_len
        .checked_mul(iter.len())
        .and_then(|n| n.checked_add(first.len()))
        .and_then(|n| {
            // iter starts from the second element as we've already taken the first
            // it's cloned so we can reuse the same iterator below
            iter.clone().map(|s| s.borrow().as_ref().len()).try_fold(n, usize::checked_add)
        })
        .expect("attempt to join into collection with len > usize::MAX");

    // prepare an uninitialized buffer
    let mut result = Vec::with_capacity(reserved_len);
    debug_assert!(result.capacity() >= reserved_len);

    result.extend_from_slice(first);

    let pos = result.len();
    debug_assert!(reserved_len >= pos);

    // SAFETY: The size of remaining spare is at least `reserved_len - pos`.
    let target = unsafe { result.spare_capacity_mut().get_unchecked_mut(..reserved_len - pos) };

    // Convert the separator and slices to slices of MaybeUninit
    // to simplify implementation in specialize_for_lengths.
    // SAFETY: `sep` is a slice of `T`, so `sep.as_ptr().cast()` is a valid pointer,
    // and `sep.len()` is the number of elements in the slice, so `from_raw_parts` is safe.
    let sep_uninit = unsafe { core::slice::from_raw_parts(sep.as_ptr().cast(), sep.len()) };
    let iter_uninit = iter.map(|it| {
        let it = it.borrow().as_ref();
        // SAFETY: `it` is a slice of `T`, so `it.as_ptr().cast()` is a valid pointer,
        // and `it.len()` is the number of elements in the slice, so `from_raw_parts` is safe.
        unsafe { core::slice::from_raw_parts(it.as_ptr().cast(), it.len()) }
    });

    // copy separator and slices over without bounds checks.
    // `specialize_for_lengths!` internally calls `s.borrow()`, but because it uses
    // the bounds-checked `split_at_mut` any misbehaving implementation
    // will not write out of bounds.
    let remain = specialize_for_lengths!(sep_uninit, target, iter_uninit; 0, 1, 2, 3, 4);

    // A weird borrow implementation may return different
    // slices for the length calculation and the actual copy.
    // Make sure we don't expose uninitialized bytes to the caller.
    let result_len = reserved_len - remain.len();
    // SAFETY: `result_len` is less than `reserved_len`, and all elements in `0..result_len` are initialized.
    unsafe {
        result.set_len(result_len);
    }

    result
}

/// Helper for final sigma lowercase
#[cfg(not(no_global_oom_handling))]
fn map_uppercase_sigma(from: &str, i: usize) -> char {
    fn case_ignorable_then_cased<I: Iterator<Item = char>>(iter: I) -> bool {
        match iter.skip_while(|&c| c.is_case_ignorable()).next() {
            Some(c) => c.is_cased(),
            None => false,
        }
    }

    // See https://www.unicode.org/versions/latest/core-spec/chapter-3/#G54277
    // for the definition of `Final_Sigma`.
    let is_word_final = case_ignorable_then_cased(from[..i].chars().rev())
        && !case_ignorable_then_cased(from[i + const { 'Σ'.len_utf8() }..].chars());
    if is_word_final { 'ς' } else { 'σ' }
}

#[stable(feature = "rust1", since = "1.0.0")]
impl Borrow<str> for String {
    #[inline]
    fn borrow(&self) -> &str {
        &self[..]
    }
}

#[stable(feature = "string_borrow_mut", since = "1.36.0")]
impl BorrowMut<str> for String {
    #[inline]
    fn borrow_mut(&mut self) -> &mut str {
        &mut self[..]
    }
}

#[cfg(not(no_global_oom_handling))]
#[stable(feature = "rust1", since = "1.0.0")]
impl ToOwned for str {
    type Owned = String;

    #[inline]
    fn to_owned(&self) -> String {
        // SAFETY: `self` is a valid UTF-8 str.
        unsafe { String::from_utf8_unchecked(self.as_bytes().to_owned()) }
    }

    #[inline]
    fn clone_into(&self, target: &mut String) {
        target.clear();
        target.push_str(self);
    }
}

/// Methods for string slices.
impl str {
    /// Converts a `Box<str>` into a `Box<[u8]>` without copying or allocating.
    ///
    /// # Examples
    ///
    /// ```
    /// let s = "this is a string";
    /// let boxed_str = s.to_owned().into_boxed_str();
    /// let boxed_bytes = boxed_str.into_boxed_bytes();
    /// assert_eq!(*boxed_bytes, *s.as_bytes());
    /// ```
    #[rustc_allow_incoherent_impl]
    #[stable(feature = "str_box_extras", since = "1.20.0")]
    #[must_use = "`self` will be dropped if the result is not used"]
    #[inline]
    pub fn into_boxed_bytes(self: Box<Self>) -> Box<[u8]> {
        self.into()
    }

    /// Replaces all matches of a pattern with another string.
    ///
    /// `replace` creates a new [`String`], and copies the data from this string slice into it.
    /// While doing so, it attempts to find matches of a pattern. If it finds any, it
    /// replaces them with the replacement string slice.
    ///
    /// # Examples
    ///
    /// ```
    /// let s = "this is old";
    ///
    /// assert_eq!("this is new", s.replace("old", "new"));
    /// assert_eq!("than an old", s.replace("is", "an"));
    /// ```
    ///
    /// When the pattern doesn't match, it returns this string slice as [`String`]:
    ///
    /// ```
    /// let s = "this is old";
    /// assert_eq!(s, s.replace("cookie monster", "little lamb"));
    /// ```
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "this returns the replaced string as a new allocation, \
                  without modifying the original"]
    #[stable(feature = "rust1", since = "1.0.0")]
    #[inline]
    pub fn replace<P: Pattern>(&self, from: P, to: &str) -> String {
        // Fast path for replacing a single ASCII character with another.
        if let Some(from_byte) = match from.as_utf8_pattern() {
            Some(Utf8Pattern::StringPattern(s)) => match s.as_bytes() {
                [from_byte] => Some(*from_byte),
                _ => None,
            },
            Some(Utf8Pattern::CharPattern(c)) => c.as_ascii().map(|ascii_char| ascii_char.to_u8()),
            _ => None,
        } {
            if let [to_byte] = to.as_bytes() {
                // SAFETY: `self` is a valid UTF-8 str, `from_byte` and `to_byte` are ASCII bytes.
                return unsafe { replace_ascii(self.as_bytes(), from_byte, *to_byte) };
            }
        }
        // Set result capacity to self.len() when from.len() <= to.len()
        let default_capacity = match from.as_utf8_pattern() {
            Some(Utf8Pattern::StringPattern(s)) if s.len() <= to.len() => self.len(),
            Some(Utf8Pattern::CharPattern(c)) if c.len_utf8() <= to.len() => self.len(),
            _ => 0,
        };
        let mut result = String::with_capacity(default_capacity);
        let mut last_end = 0;
        for (start, part) in self.match_indices(from) {
            // SAFETY: `last_end` does not exceed `start`, and `start` does not exceed `self.len()`.
            // Therefore, `last_end..start` is within bounds of `self`.
            // For each iteration, `last_end` and `start` lie on UTF-8 sequence boundaries.
            result.push_str(unsafe { self.get_unchecked(last_end..start) });
            result.push_str(to);
            last_end = start + part.len();
        }
        // SAFETY: `last_end` is the start of the remaining unmatched suffix of `self`.
        // It is 0 or the end of a match returned by `match_indices`, so it is
        // a UTF-8 boundary within `self`. `self.len()` is also a UTF-8 boundary.
        result.push_str(unsafe { self.get_unchecked(last_end..self.len()) });
        result
    }

    /// Replaces first N matches of a pattern with another string.
    ///
    /// `replacen` creates a new [`String`], and copies the data from this string slice into it.
    /// While doing so, it attempts to find matches of a pattern. If it finds any, it
    /// replaces them with the replacement string slice at most `count` times.
    ///
    /// # Examples
    ///
    /// ```
    /// let s = "foo foo 123 foo";
    /// assert_eq!("new new 123 foo", s.replacen("foo", "new", 2));
    /// assert_eq!("faa fao 123 foo", s.replacen('o', "a", 3));
    /// assert_eq!("foo foo new23 foo", s.replacen(char::is_numeric, "new", 1));
    /// ```
    ///
    /// When the pattern doesn't match, it returns this string slice as [`String`]:
    ///
    /// ```
    /// let s = "this is old";
    /// assert_eq!(s, s.replacen("cookie monster", "little lamb", 10));
    /// ```
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[doc(alias = "replace_first")]
    #[must_use = "this returns the replaced string as a new allocation, \
                  without modifying the original"]
    #[stable(feature = "str_replacen", since = "1.16.0")]
    pub fn replacen<P: Pattern>(&self, pat: P, to: &str, count: usize) -> String {
        // Hope to reduce the times of re-allocation
        let mut result = String::with_capacity(32);
        let mut last_end = 0;
        for (start, part) in self.match_indices(pat).take(count) {
            // SAFETY: `last_end` does not exceed `start`, and `start` does not exceed `self.len()`.
            // Therefore, `last_end..start` is within bounds of `self`.
            // For each iteration, `last_end` and `start` lie on UTF-8 sequence boundaries.
            result.push_str(unsafe { self.get_unchecked(last_end..start) });
            result.push_str(to);
            last_end = start + part.len();
        }
        // SAFETY: `last_end` is the start of the remaining suffix of `self`.
        // It is 0 or the end of a match returned by `match_indices`, so it is
        // a UTF-8 boundary within `self`. `self.len()` is also a UTF-8 boundary.
        result.push_str(unsafe { self.get_unchecked(last_end..self.len()) });
        result
    }

    /// Returns the lowercase equivalent of this string slice, as a new [`String`].
    ///
    /// 'Lowercase' is defined according to the terms of
    /// [Chapter 3 (Conformance)](https://www.unicode.org/versions/latest/core-spec/chapter-3/#G34432)
    /// of the Unicode standard.
    ///
    /// Since some characters can expand into multiple characters when changing
    /// the case, this function returns a [`String`] instead of modifying the
    /// parameter in-place.
    ///
    /// Unlike [`char::to_lowercase()`], this method fully handles the context-dependent
    /// casing of Greek sigma. However, like that method, it does not handle locale-specific
    /// casing, like Turkish and Azeri I/ı/İ/i. See its documentation
    /// for more information.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let s = "HELLO WORLD";
    ///
    /// assert_eq!("hello world", s.to_lowercase());
    /// ```
    ///
    /// Tricky examples, with sigma:
    ///
    /// ```
    /// let sigma = "Σ";
    ///
    /// assert_eq!("σ", sigma.to_lowercase());
    ///
    /// // but at the end of a word, it's ς, not σ:
    /// let odysseus = "ὈΔΥΣΣΕΎΣ";
    ///
    /// assert_eq!("ὀδυσσεύς", odysseus.to_lowercase());
    ///
    /// let odysseus_king_of_ithaca = "Ο ΟΔΥΣΣΈΑΣ ΒΑΣΙΛΙΆΣ ΤΗΣ ΙΘΆΚΗΣ";
    ///
    /// assert_eq!("ο οδυσσέας βασιλιάς της ιθάκης", odysseus_king_of_ithaca.to_lowercase());
    /// ```
    ///
    /// Languages without case are not changed:
    ///
    /// ```
    /// let new_year = "农历新年";
    ///
    /// assert_eq!(new_year, new_year.to_lowercase());
    /// ```
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "this returns the lowercase string as a new String, \
                  without modifying the original"]
    #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
    pub fn to_lowercase(&self) -> String {
        // SAFETY: `to_ascii_lowercase` preserves ASCII bytes, so the converted
        // prefix remains valid UTF-8.
        let (mut s, rest) = unsafe { convert_while_ascii(self, u8::to_ascii_lowercase) };

        let prefix_len = s.len();

        for (i, c) in rest.char_indices() {
            if c == 'Σ' {
                // Σ maps to σ, except at the end of a word where it maps to ς.
                // This is the only conditional (contextual) but language-independent mapping
                // in `SpecialCasing.txt`,
                // so hard-code it rather than have a generic "condition" mechanism.
                // See https://github.com/rust-lang/rust/issues/26035
                let sigma_lowercase = map_uppercase_sigma(self, prefix_len + i);
                s.push(sigma_lowercase);
            } else {
                match conversions::to_lower(c) {
                    [a, '\0', _] => s.push(a),
                    [a, b, '\0'] => {
                        s.push(a);
                        s.push(b);
                    }
                    [a, b, c] => {
                        s.push(a);
                        s.push(b);
                        s.push(c);
                    }
                }
            }
        }
        s
    }

    /// Returns the titlecase equivalent of this string slice,
    /// which is assumed to represent a single word,
    /// as a new [`String`].
    ///
    /// Essentially, this consists of uppercasing the first cased letter
    /// (with [`char::to_titlecase()`]), and lowercasing everything that follows.
    ///
    /// 'Titlecase' is defined according to the terms of
    /// [Chapter 3 (Conformance)](https://www.unicode.org/versions/latest/core-spec/chapter-3/#G34082)
    /// of the Unicode standard.
    ///
    /// Since some characters can expand into multiple characters when changing
    /// the case, this function returns a [`String`] instead of modifying the
    /// parameter in-place.
    ///
    /// Unlike [`char::to_lowercase()`], this method fully handles the context-dependent
    /// casing of Greek sigma. However, like that method, it does not handle locale-specific
    /// casing, like Turkish and Azeri I/ı/İ/i. See its documentation
    /// for more information.
    ///
    /// This method does not perform any kind of word segmentation.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// #![feature(titlecase)]
    /// let s = "HELLO WORLD";
    ///
    /// assert_eq!("Hello world", s.word_to_titlecase());
    /// ```
    ///
    /// The first *cased* letter is uppercased:
    ///
    /// ```
    /// #![feature(titlecase)]
    /// let the_night_before_christmas = "'twas";
    ///
    /// assert_eq!("'Twas", the_night_before_christmas.word_to_titlecase());
    /// ```
    ///
    /// Languages without case are not changed:
    ///
    /// ```
    /// #![feature(titlecase)]
    /// let new_year = "农历新年";
    ///
    /// assert_eq!(new_year, new_year.word_to_titlecase());
    /// ```
    ///
    /// Georgian uppercase ("Mtavruli") letters are not used in titlecase:
    ///
    /// ```
    /// #![feature(titlecase)]
    /// let georgian = "ერთობაშია";
    ///
    /// assert_eq!(georgian, georgian.word_to_titlecase());
    /// ```
    ///
    /// No word segmentation is performed,
    /// so only the first cased letter in the whole string gets uppercased:
    ///
    /// ```
    /// #![feature(titlecase)]
    /// let blazingly_fast = "ferris and I";
    ///
    /// assert_eq!("Ferris and i", blazingly_fast.word_to_titlecase());
    /// ```
    ///
    /// Tricky examples, with sigma:
    ///
    /// ```
    /// #![feature(titlecase)]
    /// let odysseus = "ὈΔΥΣΣΕΎΣ";
    ///
    /// assert_eq!("Ὀδυσσεύς", odysseus.word_to_titlecase());
    ///
    /// let odysseus_king_of_ithaca = "Ο ΟΔΥΣΣΈΑΣ ΒΑΣΙΛΙΆΣ ΤΗΣ ΙΘΆΚΗΣ";
    ///
    /// assert_eq!("Ο οδυσσέας βασιλιάς της ιθάκης", odysseus_king_of_ithaca.word_to_titlecase());
    /// ```
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "this returns the titlecase word as a new String, \
                  without modifying the original"]
    #[unstable(feature = "titlecase", issue = "153892")]
    pub fn word_to_titlecase(&self) -> String {
        let mut s = String::with_capacity(self.len());
        let mut chars = self.char_indices();

        // The first cased character is title-cased; leading uncased characters pass through.
        'until_first_cased_char: for (_, c) in chars.by_ref() {
            if c.is_cased() {
                s.extend(c.to_titlecase());
                break 'until_first_cased_char;
            } else {
                s.push(c);
            }
        }

        // Everything after the first cased character is lower-cased. Use the ASCII fast
        // path (auto-vectorized) for its ASCII prefix, mirroring `to_lowercase`.
        let remainder = chars.as_str();
        let rest_start = self.len() - remainder.len();
        // SAFETY: `to_ascii_lowercase` preserves ASCII bytes, so the prefix stays valid UTF-8.
        let (ascii, rest) = unsafe { convert_while_ascii(remainder, u8::to_ascii_lowercase) };
        s.push_str(&ascii);
        let prefix_len = rest_start + ascii.len();

        for (i, c) in rest.char_indices() {
            if c == 'Σ' {
                // Σ maps to σ, except at the end of a word where it maps to ς.
                // This is the only conditional (contextual) but language-independent mapping
                // in `SpecialCasing.txt`,
                // so hard-code it rather than have a generic "condition" mechanism.
                // See https://github.com/rust-lang/rust/issues/26035
                let sigma_lowercase = map_uppercase_sigma(self, prefix_len + i);
                s.push(sigma_lowercase);
            } else {
                match conversions::to_lower(c) {
                    [a, '\0', _] => s.push(a),
                    [a, b, '\0'] => {
                        s.push(a);
                        s.push(b);
                    }
                    [a, b, c] => {
                        s.push(a);
                        s.push(b);
                        s.push(c);
                    }
                }
            }
        }

        s
    }

    /// Returns the uppercase equivalent of this string slice, as a new [`String`].
    ///
    /// 'Uppercase' is defined according to the terms of
    /// [Chapter 3 (Conformance)](https://www.unicode.org/versions/latest/core-spec/chapter-3/#G34431)
    /// of the Unicode standard.
    ///
    /// Since some characters can expand into multiple characters when changing
    /// the case, this function returns a [`String`] instead of modifying the
    /// parameter in-place.
    ///
    /// Like [`char::to_uppercase()`] this method does not handle language-specific
    /// casing, like Turkish and Azeri I/ı/İ/i. See that method's documentation
    /// for more information.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// let s = "hello world";
    ///
    /// assert_eq!("HELLO WORLD", s.to_uppercase());
    /// ```
    ///
    /// Scripts without case are not changed:
    ///
    /// ```
    /// let new_year = "农历新年";
    ///
    /// assert_eq!(new_year, new_year.to_uppercase());
    /// ```
    ///
    /// One character can become multiple:
    /// ```
    /// let s = "tschüß";
    ///
    /// assert_eq!("TSCHÜSS", s.to_uppercase());
    /// ```
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "this returns the uppercase string as a new String, \
                  without modifying the original"]
    #[stable(feature = "unicode_case_mapping", since = "1.2.0")]
    pub fn to_uppercase(&self) -> String {
        // SAFETY: `to_ascii_uppercase` preserves ASCII bytes, so the converted
        // prefix remains valid UTF-8.
        let (mut s, rest) = unsafe { convert_while_ascii(self, u8::to_ascii_uppercase) };

        for c in rest.chars() {
            match conversions::to_upper(c) {
                [a, '\0', _] => s.push(a),
                [a, b, '\0'] => {
                    s.push(a);
                    s.push(b);
                }
                [a, b, c] => {
                    s.push(a);
                    s.push(b);
                    s.push(c);
                }
            }
        }
        s
    }

    /// Returns the case-folded equivalent of this string slice, as a new [`String`].
    ///
    /// Case folding is a transformation, mostly matching lowercase, that is meant to be used
    /// for case-insensitive string comparisons. Case-folded strings should not usually
    /// be exposed directly to users.
    ///
    /// For the precise specification of case folding, see
    /// [Chapter 3 (Conformance)](https://www.unicode.org/versions/latest/core-spec/chapter-3/#G63737)
    /// of the Unicode standard.
    ///
    /// Since some characters can expand into multiple characters when case folding,
    /// this function returns a [`String`] instead of modifying the parameter in-place.
    ///
    /// No [normalization] (e.g. NFC) is performed, so visually and semantically identical strings
    /// might still casefold differently. For example, `"Å"` (U+00C5 LATIN CAPITAL LETTER A WITH RING ABOVE)
    /// is considered distinct from `"Å"` (A followed by U+030A COMBINING RING ABOVE),
    /// even though Unicode considers them canonically equivalent.
    ///
    /// Like [`char::to_casefold_unnormalized()`] this method does not handle language-specific
    /// casing, like Turkish and Azeri I/ı/İ/i. See that method's documentation
    /// for more information.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// #![feature(casefold)]
    /// let s0 = "HELLO";
    /// let s1 = "Hello";
    ///
    /// assert_eq!(s0.to_casefold_unnormalized(), s1.to_casefold_unnormalized());
    /// assert_eq!(s0.to_casefold_unnormalized(), "hello")
    /// ```
    ///
    /// Scripts without case are not changed:
    ///
    /// ```
    /// #![feature(casefold)]
    /// let new_year = "农历新年";
    ///
    /// assert_eq!(new_year, new_year.to_casefold_unnormalized());
    /// ```
    ///
    /// One character can become multiple:
    ///
    /// ```
    /// #![feature(casefold)]
    /// let s0 = "TSCHÜẞ";
    /// let s1 = "TSCHÜSS";
    /// let s2 = "tschüß";
    ///
    /// assert_eq!(s0.to_casefold_unnormalized(), s1.to_casefold_unnormalized());
    /// assert_eq!(s0.to_casefold_unnormalized(), s2.to_casefold_unnormalized());
    /// assert_eq!(s0.to_casefold_unnormalized(), "tschüss");
    /// ```
    ///
    /// No NFC [normalization] is performed:
    ///
    /// ```rust
    /// #![feature(casefold)]
    /// // These two strings are visually and semantically identical...
    /// let comp = "Å";
    /// let decomp = "Å";
    ///
    /// // ... but not codepoint-for-codepoint equal.
    /// assert_eq!(comp, "\u{C5}");
    /// assert_eq!(decomp, "A\u{030A}");
    ///
    /// // Their case-foldings are likewise unequal:
    /// assert_eq!(comp.to_casefold_unnormalized(), "\u{E5}");
    /// assert_eq!(decomp.to_casefold_unnormalized(), "a\u{030A}");
    /// ```
    ///
    /// [normalization]: https://www.unicode.org/faq/normalization.html
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "this returns the case-folded string as a new String, \
                  without modifying the original"]
    #[unstable(feature = "casefold", issue = "157000")]
    pub fn to_casefold_unnormalized(&self) -> String {
        // SAFETY: `to_ascii_lowercase` preserves ASCII bytes, so the converted
        // prefix remains valid UTF-8.
        let (mut s, rest) = unsafe { convert_while_ascii(self, u8::to_ascii_lowercase) };

        for c in rest.chars() {
            match conversions::to_casefold(c) {
                [a, '\0', _] => s.push(a),
                [a, b, '\0'] => {
                    s.push(a);
                    s.push(b);
                }
                [a, b, c] => {
                    s.push(a);
                    s.push(b);
                    s.push(c);
                }
            }
        }
        s
    }

    /// Converts a [`Box<str>`] into a [`String`] without copying or allocating.
    ///
    /// # Examples
    ///
    /// ```
    /// let string = String::from("birthday gift");
    /// let boxed_str = string.clone().into_boxed_str();
    ///
    /// assert_eq!(boxed_str.into_string(), string);
    /// ```
    #[stable(feature = "box_str", since = "1.4.0")]
    #[rustc_allow_incoherent_impl]
    #[must_use = "`self` will be dropped if the result is not used"]
    #[inline]
    pub fn into_string(self: Box<Self>) -> String {
        let slice = Box::<[u8]>::from(self);
        // SAFETY: `slice` is a valid UTF-8 sequence because it is created from a `Box<str>`.
        unsafe { String::from_utf8_unchecked(slice.into_vec()) }
    }

    /// Creates a new [`String`] by repeating a string `n` times.
    ///
    /// # Panics
    ///
    /// This function will panic if the capacity would overflow.
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// assert_eq!("abc".repeat(4), String::from("abcabcabcabc"));
    /// ```
    ///
    /// A panic upon overflow:
    ///
    /// ```should_panic
    /// // this will panic at runtime
    /// let huge = "0123456789abcdef".repeat(usize::MAX);
    /// ```
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use]
    #[stable(feature = "repeat_str", since = "1.16.0")]
    #[inline]
    pub fn repeat(&self, n: usize) -> String {
        // SAFETY: The created Vec<u8> is valid UTF-8 because `self` is str.
        unsafe { String::from_utf8_unchecked(self.as_bytes().repeat(n)) }
    }

    /// Returns a copy of this string where each character is mapped to its
    /// ASCII upper case equivalent.
    ///
    /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
    /// but non-ASCII letters are unchanged.
    ///
    /// To uppercase the value in-place, use [`make_ascii_uppercase`].
    ///
    /// To uppercase ASCII characters in addition to non-ASCII characters, use
    /// [`to_uppercase`].
    ///
    /// # Examples
    ///
    /// ```
    /// let s = "Grüße, Jürgen ❤";
    ///
    /// assert_eq!("GRüßE, JüRGEN ❤", s.to_ascii_uppercase());
    /// ```
    ///
    /// [`make_ascii_uppercase`]: str::make_ascii_uppercase
    /// [`to_uppercase`]: #method.to_uppercase
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "to uppercase the value in-place, use `make_ascii_uppercase()`"]
    #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
    #[inline]
    pub fn to_ascii_uppercase(&self) -> String {
        let bytes = self.as_bytes().to_ascii_uppercase();
        // SAFETY: ASCII case conversion only maps a-z to A-Z and leaves
        // all other bytes unchanged as valid UTF-8
        unsafe { String::from_utf8_unchecked(bytes) }
    }

    /// Returns a copy of this string where each character is mapped to its
    /// ASCII lower case equivalent.
    ///
    /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
    /// but non-ASCII letters are unchanged.
    ///
    /// To lowercase the value in-place, use [`make_ascii_lowercase`].
    ///
    /// To lowercase ASCII characters in addition to non-ASCII characters, use
    /// [`to_lowercase`].
    ///
    /// # Examples
    ///
    /// ```
    /// let s = "Grüße, Jürgen ❤";
    ///
    /// assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());
    /// ```
    ///
    /// [`make_ascii_lowercase`]: str::make_ascii_lowercase
    /// [`to_lowercase`]: #method.to_lowercase
    #[cfg(not(no_global_oom_handling))]
    #[rustc_allow_incoherent_impl]
    #[must_use = "to lowercase the value in-place, use `make_ascii_lowercase()`"]
    #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
    #[inline]
    pub fn to_ascii_lowercase(&self) -> String {
        let bytes = self.as_bytes().to_ascii_lowercase();
        // SAFETY: ASCII case conversion only maps A-Z to a-z and leaves
        // all other bytes unchanged as valid UTF-8
        unsafe { String::from_utf8_unchecked(bytes) }
    }
}

/// Converts a boxed slice of bytes to a boxed string slice without checking
/// that the string contains valid UTF-8.
///
/// # Safety
///
/// * The provided bytes must contain a valid UTF-8 sequence.
///
/// # Examples
///
/// ```
/// let smile_utf8 = Box::new([226, 152, 186]);
/// let smile = unsafe { std::str::from_boxed_utf8_unchecked(smile_utf8) };
///
/// assert_eq!("☺", &*smile);
/// ```
#[stable(feature = "str_box_extras", since = "1.20.0")]
#[must_use]
#[inline]
pub unsafe fn from_boxed_utf8_unchecked(v: Box<[u8]>) -> Box<str> {
    // SAFETY: Upheld by caller.
    unsafe { Box::from_raw(Box::into_raw(v) as *mut str) }
}

/// Internal; same as `from_boxed_utf8_unchecked` but allocator-generic. Name
/// probably not suitable for being made `pub` as-is.
#[must_use]
#[inline]
#[cfg(not(no_global_oom_handling))]
pub(crate) unsafe fn from_boxed_utf8_unchecked_in<A: crate::alloc::Allocator>(
    v: Box<[u8], A>,
) -> Box<str, A> {
    let (ptr, alloc) = Box::into_raw_with_allocator(v);
    // SAFETY: Upheld by caller.
    unsafe { Box::from_raw_in(ptr as *mut str, alloc) }
}

/// Converts leading ascii bytes in `s` by calling the `convert` function.
///
/// For better average performance, this happens in chunks of `2*size_of::<usize>()`.
///
/// Returns a tuple of the converted prefix and the remainder starting from
/// the first non-ascii character.
///
/// This function is only public so that it can be verified in a codegen test,
/// see `issue-123712-str-to-lower-autovectorization.rs`.
///
/// # Safety
///
/// `convert` must return an ASCII byte for every ASCII input byte.
#[unstable(feature = "str_internals", issue = "none")]
#[doc(hidden)]
#[inline]
#[cfg(not(no_global_oom_handling))]
pub unsafe fn convert_while_ascii(s: &str, convert: fn(&u8) -> u8) -> (String, &str) {
    // Process the input in chunks of 16 bytes to enable auto-vectorization.
    // Previously the chunk size depended on the size of `usize`,
    // but on 32-bit platforms with sse or neon is also the better choice.
    // The only downside on other platforms would be a bit more loop-unrolling.
    const N: usize = 16;

    let mut slice = s.as_bytes();
    let mut out = Vec::with_capacity(slice.len());
    let mut out_slice = out.spare_capacity_mut();

    let mut ascii_prefix_len = 0_usize;
    let mut is_ascii = [false; N];

    while slice.len() >= N {
        // SAFETY: checked in loop condition
        let chunk = unsafe { slice.get_unchecked(..N) };
        // SAFETY: out_slice has at least same length as input slice and gets sliced with the same offsets
        let out_chunk = unsafe { out_slice.get_unchecked_mut(..N) };

        for j in 0..N {
            is_ascii[j] = chunk[j] <= 127;
        }

        // Auto-vectorization for this check is a bit fragile, sum and comparing against the chunk
        // size gives the best result, specifically a pmovmsk instruction on x86.
        // See https://github.com/llvm/llvm-project/issues/96395 for why llvm currently does not
        // currently recognize other similar idioms.
        if is_ascii.iter().map(|x| *x as u8).sum::<u8>() as usize != N {
            break;
        }

        for j in 0..N {
            out_chunk[j] = MaybeUninit::new(convert(&chunk[j]));
        }

        ascii_prefix_len += N;
        // SAFETY: checked in loop condition.
        slice = unsafe { slice.get_unchecked(N..) };
        // SAFETY: out_slice has at least same length as input slice.
        out_slice = unsafe { out_slice.get_unchecked_mut(N..) };
    }

    // handle the remainder as individual bytes
    while !slice.is_empty() {
        let byte = slice[0];
        if byte > 127 {
            break;
        }
        // SAFETY: out_slice has at least same length as input slice
        unsafe {
            *out_slice.get_unchecked_mut(0) = MaybeUninit::new(convert(&byte));
        }
        ascii_prefix_len += 1;
        // SAFETY: slice has at least one byte, so slicing from 1.. is safe
        slice = unsafe { slice.get_unchecked(1..) };
        // SAFETY: out_slice has at least same length as input slice
        out_slice = unsafe { out_slice.get_unchecked_mut(1..) };
    }

    // SAFETY: ascii_prefix_len bytes have been initialized above
    unsafe { out.set_len(ascii_prefix_len) };

    // SAFETY: We have written only valid ascii to the output vec
    let ascii_string = unsafe { String::from_utf8_unchecked(out) };

    // SAFETY: we know this is a valid char boundary
    // since we only skipped over leading ascii bytes
    let rest = unsafe { core::str::from_utf8_unchecked(slice) };

    (ascii_string, rest)
}
#[inline]
#[cfg(not(no_global_oom_handling))]
#[allow(dead_code)]
/// Faster implementation of string replacement for ASCII to ASCII cases.
/// Should produce fast vectorized code.
///
/// # Safety
///
/// * `utf8_bytes` must contain valid UTF-8.
/// * Both `from` and `to` must be ASCII bytes (at most `0x7F`).
unsafe fn replace_ascii(utf8_bytes: &[u8], from: u8, to: u8) -> String {
    let result: Vec<u8> = utf8_bytes.iter().map(|b| if *b == from { to } else { *b }).collect();
    // SAFETY: We replaced ascii with ascii on valid utf8 strings.
    unsafe { String::from_utf8_unchecked(result) }
}