src/libstd/sys_common/wtf8.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Implementation of [the WTF-8 encoding](https://simonsapin.github.io/wtf-8/).
  12 //!
  13 //! This library uses Rust’s type system to maintain
  14 //! [well-formedness](https://simonsapin.github.io/wtf-8/#well-formed),
  15 //! like the `String` and `&str` types do for UTF-8.
  16 //!
  17 //! Since [WTF-8 must not be used
  18 //! for interchange](https://simonsapin.github.io/wtf-8/#intended-audience),
  19 //! this library deliberately does not provide access to the underlying bytes
  20 //! of WTF-8 strings,
  21 //! nor can it decode WTF-8 from arbitrary bytes.
  22 //! WTF-8 strings can be obtained from UTF-8, UTF-16, or code points.
  23
  24 // this module is imported from @SimonSapin's repo and has tons of dead code on
  25 // unix (it's mostly used on windows), so don't worry about dead code here.
  26 #![allow(dead_code)]
  27
  28 use core::str::next_code_point;
  29
  30 use ascii::*;
  31 use borrow::Cow;
  32 use char;
  33 use fmt;
  34 use hash::{Hash, Hasher};
  35 use iter::FromIterator;
  36 use mem;
  37 use ops;
  38 use slice;
  39 use str;
  40 use sys_common::AsInner;
  41
  42 const UTF8_REPLACEMENT_CHARACTER: &'static [u8] = b"\xEF\xBF\xBD";
  43
  44 /// A Unicode code point: from U+0000 to U+10FFFF.
  45 ///
  46 /// Compare with the `char` type,
  47 /// which represents a Unicode scalar value:
  48 /// a code point that is not a surrogate (U+D800 to U+DFFF).
  49 #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy)]
  50 pub struct CodePoint {
  51     value: u32
  52 }
  53
  54 /// Format the code point as `U+` followed by four to six hexadecimal digits.
  55 /// Example: `U+1F4A9`
  56 impl fmt::Debug for CodePoint {
  57     #[inline]
  58     fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
  59         write!(formatter, "U+{:04X}", self.value)
  60     }
  61 }
  62
  63 impl CodePoint {
  64     /// Unsafely creates a new `CodePoint` without checking the value.
  65     ///
  66     /// Only use when `value` is known to be less than or equal to 0x10FFFF.
  67     #[inline]
  68     pub unsafe fn from_u32_unchecked(value: u32) -> CodePoint {
  69         CodePoint { value: value }
  70     }
  71
  72     /// Creates a new `CodePoint` if the value is a valid code point.
  73     ///
  74     /// Returns `None` if `value` is above 0x10FFFF.
  75     #[inline]
  76     pub fn from_u32(value: u32) -> Option<CodePoint> {
  77         match value {
  78             0 ... 0x10FFFF => Some(CodePoint { value: value }),
  79             _ => None
  80         }
  81     }
  82
  83     /// Creates a new `CodePoint` from a `char`.
  84     ///
  85     /// Since all Unicode scalar values are code points, this always succeeds.
  86     #[inline]
  87     pub fn from_char(value: char) -> CodePoint {
  88         CodePoint { value: value as u32 }
  89     }
  90
  91     /// Returns the numeric value of the code point.
  92     #[inline]
  93     pub fn to_u32(&self) -> u32 {
  94         self.value
  95     }
  96
  97     /// Optionally returns a Unicode scalar value for the code point.
  98     ///
  99     /// Returns `None` if the code point is a surrogate (from U+D800 to U+DFFF).
 100     #[inline]
 101     pub fn to_char(&self) -> Option<char> {
 102         match self.value {
 103             0xD800 ... 0xDFFF => None,
 104             _ => Some(unsafe { char::from_u32_unchecked(self.value) })
 105         }
 106     }
 107
 108     /// Returns a Unicode scalar value for the code point.
 109     ///
 110     /// Returns `'\u{FFFD}'` (the replacement character “�”)
 111     /// if the code point is a surrogate (from U+D800 to U+DFFF).
 112     #[inline]
 113     pub fn to_char_lossy(&self) -> char {
 114         self.to_char().unwrap_or('\u{FFFD}')
 115     }
 116 }
 117
 118 /// An owned, growable string of well-formed WTF-8 data.
 119 ///
 120 /// Similar to `String`, but can additionally contain surrogate code points
 121 /// if they’re not in a surrogate pair.
 122 #[derive(Eq, PartialEq, Ord, PartialOrd, Clone)]
 123 pub struct Wtf8Buf {
 124     bytes: Vec<u8>
 125 }
 126
 127 impl ops::Deref for Wtf8Buf {
 128     type Target = Wtf8;
 129
 130     fn deref(&self) -> &Wtf8 {
 131         self.as_slice()
 132     }
 133 }
 134
 135 /// Format the string with double quotes,
 136 /// and surrogates as `\u` followed by four hexadecimal digits.
 137 /// Example: `"a\u{D800}"` for a string with code points [U+0061, U+D800]
 138 impl fmt::Debug for Wtf8Buf {
 139     #[inline]
 140     fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 141         fmt::Debug::fmt(&**self, formatter)
 142     }
 143 }
 144
 145 impl Wtf8Buf {
 146     /// Creates a new, empty WTF-8 string.
 147     #[inline]
 148     pub fn new() -> Wtf8Buf {
 149         Wtf8Buf { bytes: Vec::new() }
 150     }
 151
 152     /// Creates a new, empty WTF-8 string with pre-allocated capacity for `n` bytes.
 153     #[inline]
 154     pub fn with_capacity(n: usize) -> Wtf8Buf {
 155         Wtf8Buf { bytes: Vec::with_capacity(n) }
 156     }
 157
 158     /// Creates a WTF-8 string from a UTF-8 `String`.
 159     ///
 160     /// This takes ownership of the `String` and does not copy.
 161     ///
 162     /// Since WTF-8 is a superset of UTF-8, this always succeeds.
 163     #[inline]
 164     pub fn from_string(string: String) -> Wtf8Buf {
 165         Wtf8Buf { bytes: string.into_bytes() }
 166     }
 167
 168     /// Creates a WTF-8 string from a UTF-8 `&str` slice.
 169     ///
 170     /// This copies the content of the slice.
 171     ///
 172     /// Since WTF-8 is a superset of UTF-8, this always succeeds.
 173     #[inline]
 174     pub fn from_str(str: &str) -> Wtf8Buf {
 175         Wtf8Buf { bytes: <[_]>::to_vec(str.as_bytes()) }
 176     }
 177
 178     pub fn clear(&mut self) {
 179         self.bytes.clear()
 180     }
 181
 182     /// Creates a WTF-8 string from a potentially ill-formed UTF-16 slice of 16-bit code units.
 183     ///
 184     /// This is lossless: calling `.encode_wide()` on the resulting string
 185     /// will always return the original code units.
 186     pub fn from_wide(v: &[u16]) -> Wtf8Buf {
 187         let mut string = Wtf8Buf::with_capacity(v.len());
 188         for item in char::decode_utf16(v.iter().cloned()) {
 189             match item {
 190                 Ok(ch) => string.push_char(ch),
 191                 Err(surrogate) => {
 192                     let surrogate = surrogate.unpaired_surrogate();
 193                     // Surrogates are known to be in the code point range.
 194                     let code_point = unsafe {
 195                         CodePoint::from_u32_unchecked(surrogate as u32)
 196                     };
 197                     // Skip the WTF-8 concatenation check,
 198                     // surrogate pairs are already decoded by decode_utf16
 199                     string.push_code_point_unchecked(code_point)
 200                 }
 201             }
 202         }
 203         string
 204     }
 205
 206     /// Copied from String::push
 207     /// This does **not** include the WTF-8 concatenation check.
 208     fn push_code_point_unchecked(&mut self, code_point: CodePoint) {
 209         let c = unsafe {
 210             char::from_u32_unchecked(code_point.value)
 211         };
 212         let mut bytes = [0; 4];
 213         let bytes = c.encode_utf8(&mut bytes).as_bytes();
 214         self.bytes.extend_from_slice(bytes)
 215     }
 216
 217     #[inline]
 218     pub fn as_slice(&self) -> &Wtf8 {
 219         unsafe { Wtf8::from_bytes_unchecked(&self.bytes) }
 220     }
 221
 222     /// Reserves capacity for at least `additional` more bytes to be inserted
 223     /// in the given `Wtf8Buf`.
 224     /// The collection may reserve more space to avoid frequent reallocations.
 225     ///
 226     /// # Panics
 227     ///
 228     /// Panics if the new capacity overflows `usize`.
 229     #[inline]
 230     pub fn reserve(&mut self, additional: usize) {
 231         self.bytes.reserve(additional)
 232     }
 233
 234     #[inline]
 235     pub fn reserve_exact(&mut self, additional: usize) {
 236         self.bytes.reserve_exact(additional)
 237     }
 238
 239     #[inline]
 240     pub fn shrink_to_fit(&mut self) {
 241         self.bytes.shrink_to_fit()
 242     }
 243
 244     /// Returns the number of bytes that this string buffer can hold without reallocating.
 245     #[inline]
 246     pub fn capacity(&self) -> usize {
 247         self.bytes.capacity()
 248     }
 249
 250     /// Append a UTF-8 slice at the end of the string.
 251     #[inline]
 252     pub fn push_str(&mut self, other: &str) {
 253         self.bytes.extend_from_slice(other.as_bytes())
 254     }
 255
 256     /// Append a WTF-8 slice at the end of the string.
 257     ///
 258     /// This replaces newly paired surrogates at the boundary
 259     /// with a supplementary code point,
 260     /// like concatenating ill-formed UTF-16 strings effectively would.
 261     #[inline]
 262     pub fn push_wtf8(&mut self, other: &Wtf8) {
 263         match ((&*self).final_lead_surrogate(), other.initial_trail_surrogate()) {
 264             // Replace newly paired surrogates by a supplementary code point.
 265             (Some(lead), Some(trail)) => {
 266                 let len_without_lead_surrogate = self.len() - 3;
 267                 self.bytes.truncate(len_without_lead_surrogate);
 268                 let other_without_trail_surrogate = &other.bytes[3..];
 269                 // 4 bytes for the supplementary code point
 270                 self.bytes.reserve(4 + other_without_trail_surrogate.len());
 271                 self.push_char(decode_surrogate_pair(lead, trail));
 272                 self.bytes.extend_from_slice(other_without_trail_surrogate);
 273             }
 274             _ => self.bytes.extend_from_slice(&other.bytes)
 275         }
 276     }
 277
 278     /// Append a Unicode scalar value at the end of the string.
 279     #[inline]
 280     pub fn push_char(&mut self, c: char) {
 281         self.push_code_point_unchecked(CodePoint::from_char(c))
 282     }
 283
 284     /// Append a code point at the end of the string.
 285     ///
 286     /// This replaces newly paired surrogates at the boundary
 287     /// with a supplementary code point,
 288     /// like concatenating ill-formed UTF-16 strings effectively would.
 289     #[inline]
 290     pub fn push(&mut self, code_point: CodePoint) {
 291         if let trail @ 0xDC00...0xDFFF = code_point.to_u32() {
 292             if let Some(lead) = (&*self).final_lead_surrogate() {
 293                 let len_without_lead_surrogate = self.len() - 3;
 294                 self.bytes.truncate(len_without_lead_surrogate);
 295                 self.push_char(decode_surrogate_pair(lead, trail as u16));
 296                 return
 297             }
 298         }
 299
 300         // No newly paired surrogates at the boundary.
 301         self.push_code_point_unchecked(code_point)
 302     }
 303
 304     /// Shortens a string to the specified length.
 305     ///
 306     /// # Panics
 307     ///
 308     /// Panics if `new_len` > current length,
 309     /// or if `new_len` is not a code point boundary.
 310     #[inline]
 311     pub fn truncate(&mut self, new_len: usize) {
 312         assert!(is_code_point_boundary(self, new_len));
 313         self.bytes.truncate(new_len)
 314     }
 315
 316     /// Consumes the WTF-8 string and tries to convert it to UTF-8.
 317     ///
 318     /// This does not copy the data.
 319     ///
 320     /// If the contents are not well-formed UTF-8
 321     /// (that is, if the string contains surrogates),
 322     /// the original WTF-8 string is returned instead.
 323     pub fn into_string(self) -> Result<String, Wtf8Buf> {
 324         match self.next_surrogate(0) {
 325             None => Ok(unsafe { String::from_utf8_unchecked(self.bytes) }),
 326             Some(_) => Err(self),
 327         }
 328     }
 329
 330     /// Consumes the WTF-8 string and converts it lossily to UTF-8.
 331     ///
 332     /// This does not copy the data (but may overwrite parts of it in place).
 333     ///
 334     /// Surrogates are replaced with `"\u{FFFD}"` (the replacement character “�”)
 335     pub fn into_string_lossy(mut self) -> String {
 336         let mut pos = 0;
 337         loop {
 338             match self.next_surrogate(pos) {
 339                 Some((surrogate_pos, _)) => {
 340                     pos = surrogate_pos + 3;
 341                     self.bytes[surrogate_pos..pos]
 342                         .copy_from_slice(UTF8_REPLACEMENT_CHARACTER);
 343                 },
 344                 None => return unsafe { String::from_utf8_unchecked(self.bytes) }
 345             }
 346         }
 347     }
 348
 349     /// Converts this `Wtf8Buf` into a boxed `Wtf8`.
 350     #[inline]
 351     pub fn into_box(self) -> Box<Wtf8> {
 352         unsafe { mem::transmute(self.bytes.into_boxed_slice()) }
 353     }
 354
 355     /// Converts a `Box<Wtf8>` into a `Wtf8Buf`.
 356     pub fn from_box(boxed: Box<Wtf8>) -> Wtf8Buf {
 357         let bytes: Box<[u8]> = unsafe { mem::transmute(boxed) };
 358         Wtf8Buf { bytes: bytes.into_vec() }
 359     }
 360 }
 361
 362 /// Create a new WTF-8 string from an iterator of code points.
 363 ///
 364 /// This replaces surrogate code point pairs with supplementary code points,
 365 /// like concatenating ill-formed UTF-16 strings effectively would.
 366 impl FromIterator<CodePoint> for Wtf8Buf {
 367     fn from_iter<T: IntoIterator<Item=CodePoint>>(iter: T) -> Wtf8Buf {
 368         let mut string = Wtf8Buf::new();
 369         string.extend(iter);
 370         string
 371     }
 372 }
 373
 374 /// Append code points from an iterator to the string.
 375 ///
 376 /// This replaces surrogate code point pairs with supplementary code points,
 377 /// like concatenating ill-formed UTF-16 strings effectively would.
 378 impl Extend<CodePoint> for Wtf8Buf {
 379     fn extend<T: IntoIterator<Item=CodePoint>>(&mut self, iter: T) {
 380         let iterator = iter.into_iter();
 381         let (low, _high) = iterator.size_hint();
 382         // Lower bound of one byte per code point (ASCII only)
 383         self.bytes.reserve(low);
 384         for code_point in iterator {
 385             self.push(code_point);
 386         }
 387     }
 388 }
 389
 390 /// A borrowed slice of well-formed WTF-8 data.
 391 ///
 392 /// Similar to `&str`, but can additionally contain surrogate code points
 393 /// if they’re not in a surrogate pair.
 394 #[derive(Eq, Ord, PartialEq, PartialOrd)]
 395 pub struct Wtf8 {
 396     bytes: [u8]
 397 }
 398
 399 impl AsInner<[u8]> for Wtf8 {
 400     fn as_inner(&self) -> &[u8] { &self.bytes }
 401 }
 402
 403 /// Format the slice with double quotes,
 404 /// and surrogates as `\u` followed by four hexadecimal digits.
 405 /// Example: `"a\u{D800}"` for a slice with code points [U+0061, U+D800]
 406 impl fmt::Debug for Wtf8 {
 407     fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
 408         fn write_str_escaped(f: &mut fmt::Formatter, s: &str) -> fmt::Result {
 409             use fmt::Write;
 410             for c in s.chars().flat_map(|c| c.escape_debug()) {
 411                 f.write_char(c)?
 412             }
 413             Ok(())
 414         }
 415
 416         formatter.write_str("\"")?;
 417         let mut pos = 0;
 418         loop {
 419             match self.next_surrogate(pos) {
 420                 None => break,
 421                 Some((surrogate_pos, surrogate)) => {
 422                     write_str_escaped(
 423                         formatter,
 424                         unsafe { str::from_utf8_unchecked(
 425                             &self.bytes[pos .. surrogate_pos]
 426                         )},
 427                     )?;
 428                     write!(formatter, "\\u{{{:x}}}", surrogate)?;
 429                     pos = surrogate_pos + 3;
 430                 }
 431             }
 432         }
 433         write_str_escaped(
 434             formatter,
 435             unsafe { str::from_utf8_unchecked(&self.bytes[pos..]) },
 436         )?;
 437         formatter.write_str("\"")
 438     }
 439 }
 440
 441 impl Wtf8 {
 442     /// Creates a WTF-8 slice from a UTF-8 `&str` slice.
 443     ///
 444     /// Since WTF-8 is a superset of UTF-8, this always succeeds.
 445     #[inline]
 446     pub fn from_str(value: &str) -> &Wtf8 {
 447         unsafe { Wtf8::from_bytes_unchecked(value.as_bytes()) }
 448     }
 449
 450     /// Creates a WTF-8 slice from a WTF-8 byte slice.
 451     ///
 452     /// Since the byte slice is not checked for valid WTF-8, this functions is
 453     /// marked unsafe.
 454     #[inline]
 455     unsafe fn from_bytes_unchecked(value: &[u8]) -> &Wtf8 {
 456         mem::transmute(value)
 457     }
 458
 459     /// Returns the length, in WTF-8 bytes.
 460     #[inline]
 461     pub fn len(&self) -> usize {
 462         self.bytes.len()
 463     }
 464
 465     #[inline]
 466     pub fn is_empty(&self) -> bool {
 467         self.bytes.is_empty()
 468     }
 469
 470     /// Returns the code point at `position` if it is in the ASCII range,
 471     /// or `b'\xFF' otherwise.
 472     ///
 473     /// # Panics
 474     ///
 475     /// Panics if `position` is beyond the end of the string.
 476     #[inline]
 477     pub fn ascii_byte_at(&self, position: usize) -> u8 {
 478         match self.bytes[position] {
 479             ascii_byte @ 0x00 ... 0x7F => ascii_byte,
 480             _ => 0xFF
 481         }
 482     }
 483
 484     /// Returns an iterator for the string’s code points.
 485     #[inline]
 486     pub fn code_points(&self) -> Wtf8CodePoints {
 487         Wtf8CodePoints { bytes: self.bytes.iter() }
 488     }
 489
 490     /// Tries to convert the string to UTF-8 and return a `&str` slice.
 491     ///
 492     /// Returns `None` if the string contains surrogates.
 493     ///
 494     /// This does not copy the data.
 495     #[inline]
 496     pub fn as_str(&self) -> Option<&str> {
 497         // Well-formed WTF-8 is also well-formed UTF-8
 498         // if and only if it contains no surrogate.
 499         match self.next_surrogate(0) {
 500             None => Some(unsafe { str::from_utf8_unchecked(&self.bytes) }),
 501             Some(_) => None,
 502         }
 503     }
 504
 505     /// Lossily converts the string to UTF-8.
 506     /// Returns a UTF-8 `&str` slice if the contents are well-formed in UTF-8.
 507     ///
 508     /// Surrogates are replaced with `"\u{FFFD}"` (the replacement character “�”).
 509     ///
 510     /// This only copies the data if necessary (if it contains any surrogate).
 511     pub fn to_string_lossy(&self) -> Cow<str> {
 512         let surrogate_pos = match self.next_surrogate(0) {
 513             None => return Cow::Borrowed(unsafe { str::from_utf8_unchecked(&self.bytes) }),
 514             Some((pos, _)) => pos,
 515         };
 516         let wtf8_bytes = &self.bytes;
 517         let mut utf8_bytes = Vec::with_capacity(self.len());
 518         utf8_bytes.extend_from_slice(&wtf8_bytes[..surrogate_pos]);
 519         utf8_bytes.extend_from_slice(UTF8_REPLACEMENT_CHARACTER);
 520         let mut pos = surrogate_pos + 3;
 521         loop {
 522             match self.next_surrogate(pos) {
 523                 Some((surrogate_pos, _)) => {
 524                     utf8_bytes.extend_from_slice(&wtf8_bytes[pos .. surrogate_pos]);
 525                     utf8_bytes.extend_from_slice(UTF8_REPLACEMENT_CHARACTER);
 526                     pos = surrogate_pos + 3;
 527                 },
 528                 None => {
 529                     utf8_bytes.extend_from_slice(&wtf8_bytes[pos..]);
 530                     return Cow::Owned(unsafe { String::from_utf8_unchecked(utf8_bytes) })
 531                 }
 532             }
 533         }
 534     }
 535
 536     /// Converts the WTF-8 string to potentially ill-formed UTF-16
 537     /// and return an iterator of 16-bit code units.
 538     ///
 539     /// This is lossless:
 540     /// calling `Wtf8Buf::from_ill_formed_utf16` on the resulting code units
 541     /// would always return the original WTF-8 string.
 542     #[inline]
 543     pub fn encode_wide(&self) -> EncodeWide {
 544         EncodeWide { code_points: self.code_points(), extra: 0 }
 545     }
 546
 547     #[inline]
 548     fn next_surrogate(&self, mut pos: usize) -> Option<(usize, u16)> {
 549         let mut iter = self.bytes[pos..].iter();
 550         loop {
 551             let b = match iter.next() {
 552                 None => return None,
 553                 Some(&b) => b,
 554             };
 555             if b < 0x80 {
 556                 pos += 1;
 557             } else if b < 0xE0 {
 558                 iter.next();
 559                 pos += 2;
 560             } else if b == 0xED {
 561                 match (iter.next(), iter.next()) {
 562                     (Some(&b2), Some(&b3)) if b2 >= 0xA0 => {
 563                         return Some((pos, decode_surrogate(b2, b3)))
 564                     }
 565                     _ => pos += 3
 566                 }
 567             } else if b < 0xF0 {
 568                 iter.next();
 569                 iter.next();
 570                 pos += 3;
 571             } else {
 572                 iter.next();
 573                 iter.next();
 574                 iter.next();
 575                 pos += 4;
 576             }
 577         }
 578     }
 579
 580     #[inline]
 581     fn final_lead_surrogate(&self) -> Option<u16> {
 582         let len = self.len();
 583         if len < 3 {
 584             return None
 585         }
 586         match &self.bytes[(len - 3)..] {
 587             &[0xED, b2 @ 0xA0...0xAF, b3] => Some(decode_surrogate(b2, b3)),
 588             _ => None
 589         }
 590     }
 591
 592     #[inline]
 593     fn initial_trail_surrogate(&self) -> Option<u16> {
 594         let len = self.len();
 595         if len < 3 {
 596             return None
 597         }
 598         match &self.bytes[..3] {
 599             &[0xED, b2 @ 0xB0...0xBF, b3] => Some(decode_surrogate(b2, b3)),
 600             _ => None
 601         }
 602     }
 603
 604     /// Boxes this `Wtf8`.
 605     #[inline]
 606     pub fn into_box(&self) -> Box<Wtf8> {
 607         let boxed: Box<[u8]> = self.bytes.into();
 608         unsafe { mem::transmute(boxed) }
 609     }
 610
 611     /// Creates a boxed, empty `Wtf8`.
 612     pub fn empty_box() -> Box<Wtf8> {
 613         let boxed: Box<[u8]> = Default::default();
 614         unsafe { mem::transmute(boxed) }
 615     }
 616 }
 617
 618
 619 /// Return a slice of the given string for the byte range [`begin`..`end`).
 620 ///
 621 /// # Panics
 622 ///
 623 /// Panics when `begin` and `end` do not point to code point boundaries,
 624 /// or point beyond the end of the string.
 625 impl ops::Index<ops::Range<usize>> for Wtf8 {
 626     type Output = Wtf8;
 627
 628     #[inline]
 629     fn index(&self, range: ops::Range<usize>) -> &Wtf8 {
 630         // is_code_point_boundary checks that the index is in [0, .len()]
 631         if range.start <= range.end &&
 632            is_code_point_boundary(self, range.start) &&
 633            is_code_point_boundary(self, range.end) {
 634             unsafe { slice_unchecked(self, range.start, range.end) }
 635         } else {
 636             slice_error_fail(self, range.start, range.end)
 637         }
 638     }
 639 }
 640
 641 /// Return a slice of the given string from byte `begin` to its end.
 642 ///
 643 /// # Panics
 644 ///
 645 /// Panics when `begin` is not at a code point boundary,
 646 /// or is beyond the end of the string.
 647 impl ops::Index<ops::RangeFrom<usize>> for Wtf8 {
 648     type Output = Wtf8;
 649
 650     #[inline]
 651     fn index(&self, range: ops::RangeFrom<usize>) -> &Wtf8 {
 652         // is_code_point_boundary checks that the index is in [0, .len()]
 653         if is_code_point_boundary(self, range.start) {
 654             unsafe { slice_unchecked(self, range.start, self.len()) }
 655         } else {
 656             slice_error_fail(self, range.start, self.len())
 657         }
 658     }
 659 }
 660
 661 /// Return a slice of the given string from its beginning to byte `end`.
 662 ///
 663 /// # Panics
 664 ///
 665 /// Panics when `end` is not at a code point boundary,
 666 /// or is beyond the end of the string.
 667 impl ops::Index<ops::RangeTo<usize>> for Wtf8 {
 668     type Output = Wtf8;
 669
 670     #[inline]
 671     fn index(&self, range: ops::RangeTo<usize>) -> &Wtf8 {
 672         // is_code_point_boundary checks that the index is in [0, .len()]
 673         if is_code_point_boundary(self, range.end) {
 674             unsafe { slice_unchecked(self, 0, range.end) }
 675         } else {
 676             slice_error_fail(self, 0, range.end)
 677         }
 678     }
 679 }
 680
 681 impl ops::Index<ops::RangeFull> for Wtf8 {
 682     type Output = Wtf8;
 683
 684     #[inline]
 685     fn index(&self, _range: ops::RangeFull) -> &Wtf8 {
 686         self
 687     }
 688 }
 689
 690 #[inline]
 691 fn decode_surrogate(second_byte: u8, third_byte: u8) -> u16 {
 692     // The first byte is assumed to be 0xED
 693     0xD800 | (second_byte as u16 & 0x3F) << 6 | third_byte as u16 & 0x3F
 694 }
 695
 696 #[inline]
 697 fn decode_surrogate_pair(lead: u16, trail: u16) -> char {
 698     let code_point = 0x10000 + ((((lead - 0xD800) as u32) << 10) | (trail - 0xDC00) as u32);
 699     unsafe { char::from_u32_unchecked(code_point) }
 700 }
 701
 702 /// Copied from core::str::StrPrelude::is_char_boundary
 703 #[inline]
 704 pub fn is_code_point_boundary(slice: &Wtf8, index: usize) -> bool {
 705     if index == slice.len() { return true; }
 706     match slice.bytes.get(index) {
 707         None => false,
 708         Some(&b) => b < 128 || b >= 192,
 709     }
 710 }
 711
 712 /// Copied from core::str::raw::slice_unchecked
 713 #[inline]
 714 pub unsafe fn slice_unchecked(s: &Wtf8, begin: usize, end: usize) -> &Wtf8 {
 715     // memory layout of an &[u8] and &Wtf8 are the same
 716     Wtf8::from_bytes_unchecked(slice::from_raw_parts(
 717         s.bytes.as_ptr().offset(begin as isize),
 718         end - begin
 719     ))
 720 }
 721
 722 /// Copied from core::str::raw::slice_error_fail
 723 #[inline(never)]
 724 pub fn slice_error_fail(s: &Wtf8, begin: usize, end: usize) -> ! {
 725     assert!(begin <= end);
 726     panic!("index {} and/or {} in `{:?}` do not lie on character boundary",
 727           begin, end, s);
 728 }
 729
 730 /// Iterator for the code points of a WTF-8 string.
 731 ///
 732 /// Created with the method `.code_points()`.
 733 #[derive(Clone)]
 734 pub struct Wtf8CodePoints<'a> {
 735     bytes: slice::Iter<'a, u8>
 736 }
 737
 738 impl<'a> Iterator for Wtf8CodePoints<'a> {
 739     type Item = CodePoint;
 740
 741     #[inline]
 742     fn next(&mut self) -> Option<CodePoint> {
 743         next_code_point(&mut self.bytes).map(|c| CodePoint { value: c })
 744     }
 745
 746     #[inline]
 747     fn size_hint(&self) -> (usize, Option<usize>) {
 748         let len = self.bytes.len();
 749         (len.saturating_add(3) / 4, Some(len))
 750     }
 751 }
 752
 753 #[stable(feature = "rust1", since = "1.0.0")]
 754 #[derive(Clone)]
 755 pub struct EncodeWide<'a> {
 756     code_points: Wtf8CodePoints<'a>,
 757     extra: u16
 758 }
 759
 760 // Copied from libunicode/u_str.rs
 761 #[stable(feature = "rust1", since = "1.0.0")]
 762 impl<'a> Iterator for EncodeWide<'a> {
 763     type Item = u16;
 764
 765     #[inline]
 766     fn next(&mut self) -> Option<u16> {
 767         if self.extra != 0 {
 768             let tmp = self.extra;
 769             self.extra = 0;
 770             return Some(tmp);
 771         }
 772
 773         let mut buf = [0; 2];
 774         self.code_points.next().map(|code_point| {
 775             let c = unsafe {
 776                 char::from_u32_unchecked(code_point.value)
 777             };
 778             let n = c.encode_utf16(&mut buf).len();
 779             if n == 2 {
 780                 self.extra = buf[1];
 781             }
 782             buf[0]
 783         })
 784     }
 785
 786     #[inline]
 787     fn size_hint(&self) -> (usize, Option<usize>) {
 788         let (low, high) = self.code_points.size_hint();
 789         // every code point gets either one u16 or two u16,
 790         // so this iterator is between 1 or 2 times as
 791         // long as the underlying iterator.
 792         (low, high.and_then(|n| n.checked_mul(2)))
 793     }
 794 }
 795
 796 impl Hash for CodePoint {
 797     #[inline]
 798     fn hash<H: Hasher>(&self, state: &mut H) {
 799         self.value.hash(state)
 800     }
 801 }
 802
 803 impl Hash for Wtf8Buf {
 804     #[inline]
 805     fn hash<H: Hasher>(&self, state: &mut H) {
 806         state.write(&self.bytes);
 807         0xfeu8.hash(state)
 808     }
 809 }
 810
 811 impl Hash for Wtf8 {
 812     #[inline]
 813     fn hash<H: Hasher>(&self, state: &mut H) {
 814         state.write(&self.bytes);
 815         0xfeu8.hash(state)
 816     }
 817 }
 818
 819 impl AsciiExt for Wtf8 {
 820     type Owned = Wtf8Buf;
 821
 822     fn is_ascii(&self) -> bool {
 823         self.bytes.is_ascii()
 824     }
 825     fn to_ascii_uppercase(&self) -> Wtf8Buf {
 826         Wtf8Buf { bytes: self.bytes.to_ascii_uppercase() }
 827     }
 828     fn to_ascii_lowercase(&self) -> Wtf8Buf {
 829         Wtf8Buf { bytes: self.bytes.to_ascii_lowercase() }
 830     }
 831     fn eq_ignore_ascii_case(&self, other: &Wtf8) -> bool {
 832         self.bytes.eq_ignore_ascii_case(&other.bytes)
 833     }
 834
 835     fn make_ascii_uppercase(&mut self) { self.bytes.make_ascii_uppercase() }
 836     fn make_ascii_lowercase(&mut self) { self.bytes.make_ascii_lowercase() }
 837 }
 838
 839 #[cfg(test)]
 840 mod tests {
 841     use borrow::Cow;
 842     use super::*;
 843
 844     #[test]
 845     fn code_point_from_u32() {
 846         assert!(CodePoint::from_u32(0).is_some());
 847         assert!(CodePoint::from_u32(0xD800).is_some());
 848         assert!(CodePoint::from_u32(0x10FFFF).is_some());
 849         assert!(CodePoint::from_u32(0x110000).is_none());
 850     }
 851
 852     #[test]
 853     fn code_point_to_u32() {
 854         fn c(value: u32) -> CodePoint { CodePoint::from_u32(value).unwrap() }
 855         assert_eq!(c(0).to_u32(), 0);
 856         assert_eq!(c(0xD800).to_u32(), 0xD800);
 857         assert_eq!(c(0x10FFFF).to_u32(), 0x10FFFF);
 858     }
 859
 860     #[test]
 861     fn code_point_from_char() {
 862         assert_eq!(CodePoint::from_char('a').to_u32(), 0x61);
 863         assert_eq!(CodePoint::from_char('💩').to_u32(), 0x1F4A9);
 864     }
 865
 866     #[test]
 867     fn code_point_to_string() {
 868         assert_eq!(format!("{:?}", CodePoint::from_char('a')), "U+0061");
 869         assert_eq!(format!("{:?}", CodePoint::from_char('💩')), "U+1F4A9");
 870     }
 871
 872     #[test]
 873     fn code_point_to_char() {
 874         fn c(value: u32) -> CodePoint { CodePoint::from_u32(value).unwrap() }
 875         assert_eq!(c(0x61).to_char(), Some('a'));
 876         assert_eq!(c(0x1F4A9).to_char(), Some('💩'));
 877         assert_eq!(c(0xD800).to_char(), None);
 878     }
 879
 880     #[test]
 881     fn code_point_to_char_lossy() {
 882         fn c(value: u32) -> CodePoint { CodePoint::from_u32(value).unwrap() }
 883         assert_eq!(c(0x61).to_char_lossy(), 'a');
 884         assert_eq!(c(0x1F4A9).to_char_lossy(), '💩');
 885         assert_eq!(c(0xD800).to_char_lossy(), '\u{FFFD}');
 886     }
 887
 888     #[test]
 889     fn wtf8buf_new() {
 890         assert_eq!(Wtf8Buf::new().bytes, b"");
 891     }
 892
 893     #[test]
 894     fn wtf8buf_from_str() {
 895         assert_eq!(Wtf8Buf::from_str("").bytes, b"");
 896         assert_eq!(Wtf8Buf::from_str("aé 💩").bytes,
 897                    b"a\xC3\xA9 \xF0\x9F\x92\xA9");
 898     }
 899
 900     #[test]
 901     fn wtf8buf_from_string() {
 902         assert_eq!(Wtf8Buf::from_string(String::from("")).bytes, b"");
 903         assert_eq!(Wtf8Buf::from_string(String::from("aé 💩")).bytes,
 904                    b"a\xC3\xA9 \xF0\x9F\x92\xA9");
 905     }
 906
 907     #[test]
 908     fn wtf8buf_from_wide() {
 909         assert_eq!(Wtf8Buf::from_wide(&[]).bytes, b"");
 910         assert_eq!(Wtf8Buf::from_wide(
 911                       &[0x61, 0xE9, 0x20, 0xD83D, 0xD83D, 0xDCA9]).bytes,
 912                    b"a\xC3\xA9 \xED\xA0\xBD\xF0\x9F\x92\xA9");
 913     }
 914
 915     #[test]
 916     fn wtf8buf_push_str() {
 917         let mut string = Wtf8Buf::new();
 918         assert_eq!(string.bytes, b"");
 919         string.push_str("aé 💩");
 920         assert_eq!(string.bytes, b"a\xC3\xA9 \xF0\x9F\x92\xA9");
 921     }
 922
 923     #[test]
 924     fn wtf8buf_push_char() {
 925         let mut string = Wtf8Buf::from_str("aé ");
 926         assert_eq!(string.bytes, b"a\xC3\xA9 ");
 927         string.push_char('💩');
 928         assert_eq!(string.bytes, b"a\xC3\xA9 \xF0\x9F\x92\xA9");
 929     }
 930
 931     #[test]
 932     fn wtf8buf_push() {
 933         let mut string = Wtf8Buf::from_str("aé ");
 934         assert_eq!(string.bytes, b"a\xC3\xA9 ");
 935         string.push(CodePoint::from_char('💩'));
 936         assert_eq!(string.bytes, b"a\xC3\xA9 \xF0\x9F\x92\xA9");
 937
 938         fn c(value: u32) -> CodePoint { CodePoint::from_u32(value).unwrap() }
 939
 940         let mut string = Wtf8Buf::new();
 941         string.push(c(0xD83D));  // lead
 942         string.push(c(0xDCA9));  // trail
 943         assert_eq!(string.bytes, b"\xF0\x9F\x92\xA9");  // Magic!
 944
 945         let mut string = Wtf8Buf::new();
 946         string.push(c(0xD83D));  // lead
 947         string.push(c(0x20));  // not surrogate
 948         string.push(c(0xDCA9));  // trail
 949         assert_eq!(string.bytes, b"\xED\xA0\xBD \xED\xB2\xA9");
 950
 951         let mut string = Wtf8Buf::new();
 952         string.push(c(0xD800));  // lead
 953         string.push(c(0xDBFF));  // lead
 954         assert_eq!(string.bytes, b"\xED\xA0\x80\xED\xAF\xBF");
 955
 956         let mut string = Wtf8Buf::new();
 957         string.push(c(0xD800));  // lead
 958         string.push(c(0xE000));  // not surrogate
 959         assert_eq!(string.bytes, b"\xED\xA0\x80\xEE\x80\x80");
 960
 961         let mut string = Wtf8Buf::new();
 962         string.push(c(0xD7FF));  // not surrogate
 963         string.push(c(0xDC00));  // trail
 964         assert_eq!(string.bytes, b"\xED\x9F\xBF\xED\xB0\x80");
 965
 966         let mut string = Wtf8Buf::new();
 967         string.push(c(0x61));  // not surrogate, < 3 bytes
 968         string.push(c(0xDC00));  // trail
 969         assert_eq!(string.bytes, b"\x61\xED\xB0\x80");
 970
 971         let mut string = Wtf8Buf::new();
 972         string.push(c(0xDC00));  // trail
 973         assert_eq!(string.bytes, b"\xED\xB0\x80");
 974     }
 975
 976     #[test]
 977     fn wtf8buf_push_wtf8() {
 978         let mut string = Wtf8Buf::from_str("aé");
 979         assert_eq!(string.bytes, b"a\xC3\xA9");
 980         string.push_wtf8(Wtf8::from_str(" 💩"));
 981         assert_eq!(string.bytes, b"a\xC3\xA9 \xF0\x9F\x92\xA9");
 982
 983         fn w(v: &[u8]) -> &Wtf8 { unsafe { Wtf8::from_bytes_unchecked(v) } }
 984
 985         let mut string = Wtf8Buf::new();
 986         string.push_wtf8(w(b"\xED\xA0\xBD"));  // lead
 987         string.push_wtf8(w(b"\xED\xB2\xA9"));  // trail
 988         assert_eq!(string.bytes, b"\xF0\x9F\x92\xA9");  // Magic!
 989
 990         let mut string = Wtf8Buf::new();
 991         string.push_wtf8(w(b"\xED\xA0\xBD"));  // lead
 992         string.push_wtf8(w(b" "));  // not surrogate
 993         string.push_wtf8(w(b"\xED\xB2\xA9"));  // trail
 994         assert_eq!(string.bytes, b"\xED\xA0\xBD \xED\xB2\xA9");
 995
 996         let mut string = Wtf8Buf::new();
 997         string.push_wtf8(w(b"\xED\xA0\x80"));  // lead
 998         string.push_wtf8(w(b"\xED\xAF\xBF"));  // lead
 999         assert_eq!(string.bytes, b"\xED\xA0\x80\xED\xAF\xBF");
1000
1001         let mut string = Wtf8Buf::new();
1002         string.push_wtf8(w(b"\xED\xA0\x80"));  // lead
1003         string.push_wtf8(w(b"\xEE\x80\x80"));  // not surrogate
1004         assert_eq!(string.bytes, b"\xED\xA0\x80\xEE\x80\x80");
1005
1006         let mut string = Wtf8Buf::new();
1007         string.push_wtf8(w(b"\xED\x9F\xBF"));  // not surrogate
1008         string.push_wtf8(w(b"\xED\xB0\x80"));  // trail
1009         assert_eq!(string.bytes, b"\xED\x9F\xBF\xED\xB0\x80");
1010
1011         let mut string = Wtf8Buf::new();
1012         string.push_wtf8(w(b"a"));  // not surrogate, < 3 bytes
1013         string.push_wtf8(w(b"\xED\xB0\x80"));  // trail
1014         assert_eq!(string.bytes, b"\x61\xED\xB0\x80");
1015
1016         let mut string = Wtf8Buf::new();
1017         string.push_wtf8(w(b"\xED\xB0\x80"));  // trail
1018         assert_eq!(string.bytes, b"\xED\xB0\x80");
1019     }
1020
1021     #[test]
1022     fn wtf8buf_truncate() {
1023         let mut string = Wtf8Buf::from_str("aé");
1024         string.truncate(1);
1025         assert_eq!(string.bytes, b"a");
1026     }
1027
1028     #[test]
1029     #[should_panic]
1030     fn wtf8buf_truncate_fail_code_point_boundary() {
1031         let mut string = Wtf8Buf::from_str("aé");
1032         string.truncate(2);
1033     }
1034
1035     #[test]
1036     #[should_panic]
1037     fn wtf8buf_truncate_fail_longer() {
1038         let mut string = Wtf8Buf::from_str("aé");
1039         string.truncate(4);
1040     }
1041
1042     #[test]
1043     fn wtf8buf_into_string() {
1044         let mut string = Wtf8Buf::from_str("aé 💩");
1045         assert_eq!(string.clone().into_string(), Ok(String::from("aé 💩")));
1046         string.push(CodePoint::from_u32(0xD800).unwrap());
1047         assert_eq!(string.clone().into_string(), Err(string));
1048     }
1049
1050     #[test]
1051     fn wtf8buf_into_string_lossy() {
1052         let mut string = Wtf8Buf::from_str("aé 💩");
1053         assert_eq!(string.clone().into_string_lossy(), String::from("aé 💩"));
1054         string.push(CodePoint::from_u32(0xD800).unwrap());
1055         assert_eq!(string.clone().into_string_lossy(), String::from("aé 💩�"));
1056     }
1057
1058     #[test]
1059     fn wtf8buf_from_iterator() {
1060         fn f(values: &[u32]) -> Wtf8Buf {
1061             values.iter().map(|&c| CodePoint::from_u32(c).unwrap()).collect::<Wtf8Buf>()
1062         }
1063         assert_eq!(f(&[0x61, 0xE9, 0x20, 0x1F4A9]).bytes, b"a\xC3\xA9 \xF0\x9F\x92\xA9");
1064
1065         assert_eq!(f(&[0xD83D, 0xDCA9]).bytes, b"\xF0\x9F\x92\xA9");  // Magic!
1066         assert_eq!(f(&[0xD83D, 0x20, 0xDCA9]).bytes, b"\xED\xA0\xBD \xED\xB2\xA9");
1067         assert_eq!(f(&[0xD800, 0xDBFF]).bytes, b"\xED\xA0\x80\xED\xAF\xBF");
1068         assert_eq!(f(&[0xD800, 0xE000]).bytes, b"\xED\xA0\x80\xEE\x80\x80");
1069         assert_eq!(f(&[0xD7FF, 0xDC00]).bytes, b"\xED\x9F\xBF\xED\xB0\x80");
1070         assert_eq!(f(&[0x61, 0xDC00]).bytes, b"\x61\xED\xB0\x80");
1071         assert_eq!(f(&[0xDC00]).bytes, b"\xED\xB0\x80");
1072     }
1073
1074     #[test]
1075     fn wtf8buf_extend() {
1076         fn e(initial: &[u32], extended: &[u32]) -> Wtf8Buf {
1077             fn c(value: &u32) -> CodePoint { CodePoint::from_u32(*value).unwrap() }
1078             let mut string = initial.iter().map(c).collect::<Wtf8Buf>();
1079             string.extend(extended.iter().map(c));
1080             string
1081         }
1082
1083         assert_eq!(e(&[0x61, 0xE9], &[0x20, 0x1F4A9]).bytes,
1084                    b"a\xC3\xA9 \xF0\x9F\x92\xA9");
1085
1086         assert_eq!(e(&[0xD83D], &[0xDCA9]).bytes, b"\xF0\x9F\x92\xA9");  // Magic!
1087         assert_eq!(e(&[0xD83D, 0x20], &[0xDCA9]).bytes, b"\xED\xA0\xBD \xED\xB2\xA9");
1088         assert_eq!(e(&[0xD800], &[0xDBFF]).bytes, b"\xED\xA0\x80\xED\xAF\xBF");
1089         assert_eq!(e(&[0xD800], &[0xE000]).bytes, b"\xED\xA0\x80\xEE\x80\x80");
1090         assert_eq!(e(&[0xD7FF], &[0xDC00]).bytes, b"\xED\x9F\xBF\xED\xB0\x80");
1091         assert_eq!(e(&[0x61], &[0xDC00]).bytes, b"\x61\xED\xB0\x80");
1092         assert_eq!(e(&[], &[0xDC00]).bytes, b"\xED\xB0\x80");
1093     }
1094
1095     #[test]
1096     fn wtf8buf_show() {
1097         let mut string = Wtf8Buf::from_str("a\té \u{7f}💩\r");
1098         string.push(CodePoint::from_u32(0xD800).unwrap());
1099         assert_eq!(format!("{:?}", string), "\"a\\té \\u{7f}\u{1f4a9}\\r\\u{d800}\"");
1100     }
1101
1102     #[test]
1103     fn wtf8buf_as_slice() {
1104         assert_eq!(Wtf8Buf::from_str("aé").as_slice(), Wtf8::from_str("aé"));
1105     }
1106
1107     #[test]
1108     fn wtf8buf_show_str() {
1109         let text = "a\té 💩\r";
1110         let string = Wtf8Buf::from_str(text);
1111         assert_eq!(format!("{:?}", text), format!("{:?}", string));
1112     }
1113
1114     #[test]
1115     fn wtf8_from_str() {
1116         assert_eq!(&Wtf8::from_str("").bytes, b"");
1117         assert_eq!(&Wtf8::from_str("aé 💩").bytes, b"a\xC3\xA9 \xF0\x9F\x92\xA9");
1118     }
1119
1120     #[test]
1121     fn wtf8_len() {
1122         assert_eq!(Wtf8::from_str("").len(), 0);
1123         assert_eq!(Wtf8::from_str("aé 💩").len(), 8);
1124     }
1125
1126     #[test]
1127     fn wtf8_slice() {
1128         assert_eq!(&Wtf8::from_str("aé 💩")[1.. 4].bytes, b"\xC3\xA9 ");
1129     }
1130
1131     #[test]
1132     #[should_panic]
1133     fn wtf8_slice_not_code_point_boundary() {
1134         &Wtf8::from_str("aé 💩")[2.. 4];
1135     }
1136
1137     #[test]
1138     fn wtf8_slice_from() {
1139         assert_eq!(&Wtf8::from_str("aé 💩")[1..].bytes, b"\xC3\xA9 \xF0\x9F\x92\xA9");
1140     }
1141
1142     #[test]
1143     #[should_panic]
1144     fn wtf8_slice_from_not_code_point_boundary() {
1145         &Wtf8::from_str("aé 💩")[2..];
1146     }
1147
1148     #[test]
1149     fn wtf8_slice_to() {
1150         assert_eq!(&Wtf8::from_str("aé 💩")[..4].bytes, b"a\xC3\xA9 ");
1151     }
1152
1153     #[test]
1154     #[should_panic]
1155     fn wtf8_slice_to_not_code_point_boundary() {
1156         &Wtf8::from_str("aé 💩")[5..];
1157     }
1158
1159     #[test]
1160     fn wtf8_ascii_byte_at() {
1161         let slice = Wtf8::from_str("aé 💩");
1162         assert_eq!(slice.ascii_byte_at(0), b'a');
1163         assert_eq!(slice.ascii_byte_at(1), b'\xFF');
1164         assert_eq!(slice.ascii_byte_at(2), b'\xFF');
1165         assert_eq!(slice.ascii_byte_at(3), b' ');
1166         assert_eq!(slice.ascii_byte_at(4), b'\xFF');
1167     }
1168
1169     #[test]
1170     fn wtf8_code_points() {
1171         fn c(value: u32) -> CodePoint { CodePoint::from_u32(value).unwrap() }
1172         fn cp(string: &Wtf8Buf) -> Vec<Option<char>> {
1173             string.code_points().map(|c| c.to_char()).collect::<Vec<_>>()
1174         }
1175         let mut string = Wtf8Buf::from_str("é ");
1176         assert_eq!(cp(&string), [Some('é'), Some(' ')]);
1177         string.push(c(0xD83D));
1178         assert_eq!(cp(&string), [Some('é'), Some(' '), None]);
1179         string.push(c(0xDCA9));
1180         assert_eq!(cp(&string), [Some('é'), Some(' '), Some('💩')]);
1181     }
1182
1183     #[test]
1184     fn wtf8_as_str() {
1185         assert_eq!(Wtf8::from_str("").as_str(), Some(""));
1186         assert_eq!(Wtf8::from_str("aé 💩").as_str(), Some("aé 💩"));
1187         let mut string = Wtf8Buf::new();
1188         string.push(CodePoint::from_u32(0xD800).unwrap());
1189         assert_eq!(string.as_str(), None);
1190     }
1191
1192     #[test]
1193     fn wtf8_to_string_lossy() {
1194         assert_eq!(Wtf8::from_str("").to_string_lossy(), Cow::Borrowed(""));
1195         assert_eq!(Wtf8::from_str("aé 💩").to_string_lossy(), Cow::Borrowed("aé 💩"));
1196         let mut string = Wtf8Buf::from_str("aé 💩");
1197         string.push(CodePoint::from_u32(0xD800).unwrap());
1198         let expected: Cow<str> = Cow::Owned(String::from("aé 💩�"));
1199         assert_eq!(string.to_string_lossy(), expected);
1200     }
1201
1202     #[test]
1203     fn wtf8_encode_wide() {
1204         let mut string = Wtf8Buf::from_str("aé ");
1205         string.push(CodePoint::from_u32(0xD83D).unwrap());
1206         string.push_char('💩');
1207         assert_eq!(string.encode_wide().collect::<Vec<_>>(),
1208                    vec![0x61, 0xE9, 0x20, 0xD83D, 0xD83D, 0xDCA9]);
1209     }
1210 }