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