library/core/src/char/mod.rs

   1 //! A character type.
   2 //!
   3 //! The `char` type represents a single character. More specifically, since
   4 //! 'character' isn't a well-defined concept in Unicode, `char` is a '[Unicode
   5 //! scalar value]', which is similar to, but not the same as, a '[Unicode code
   6 //! point]'.
   7 //!
   8 //! [Unicode scalar value]: http://www.unicode.org/glossary/#unicode_scalar_value
   9 //! [Unicode code point]: http://www.unicode.org/glossary/#code_point
  10 //!
  11 //! This module exists for technical reasons, the primary documentation for
  12 //! `char` is directly on [the `char` primitive type](../../std/primitive.char.html)
  13 //! itself.
  14 //!
  15 //! This module is the home of the iterator implementations for the iterators
  16 //! implemented on `char`, as well as some useful constants and conversion
  17 //! functions that convert various types to `char`.
  18
  19 #![allow(non_snake_case)]
  20 #![stable(feature = "core_char", since = "1.2.0")]
  21
  22 mod convert;
  23 mod decode;
  24 mod methods;
  25
  26 // stable re-exports
  27 #[stable(feature = "char_from_unchecked", since = "1.5.0")]
  28 pub use self::convert::from_u32_unchecked;
  29 #[stable(feature = "try_from", since = "1.34.0")]
  30 pub use self::convert::CharTryFromError;
  31 #[stable(feature = "char_from_str", since = "1.20.0")]
  32 pub use self::convert::ParseCharError;
  33 #[stable(feature = "rust1", since = "1.0.0")]
  34 pub use self::convert::{from_digit, from_u32};
  35 #[stable(feature = "decode_utf16", since = "1.9.0")]
  36 pub use self::decode::{decode_utf16, DecodeUtf16, DecodeUtf16Error};
  37 #[stable(feature = "unicode_version", since = "1.45.0")]
  38 pub use crate::unicode::UNICODE_VERSION;
  39
  40 // perma-unstable re-exports
  41 #[unstable(feature = "char_internals", reason = "exposed only for libstd", issue = "none")]
  42 pub use self::methods::encode_utf16_raw;
  43 #[unstable(feature = "char_internals", reason = "exposed only for libstd", issue = "none")]
  44 pub use self::methods::encode_utf8_raw;
  45
  46 use crate::fmt::{self, Write};
  47 use crate::iter::FusedIterator;
  48
  49 // UTF-8 ranges and tags for encoding characters
  50 const TAG_CONT: u8 = 0b1000_0000;
  51 const TAG_TWO_B: u8 = 0b1100_0000;
  52 const TAG_THREE_B: u8 = 0b1110_0000;
  53 const TAG_FOUR_B: u8 = 0b1111_0000;
  54 const MAX_ONE_B: u32 = 0x80;
  55 const MAX_TWO_B: u32 = 0x800;
  56 const MAX_THREE_B: u32 = 0x10000;
  57
  58 /*
  59     Lu  Uppercase_Letter        an uppercase letter
  60     Ll  Lowercase_Letter        a lowercase letter
  61     Lt  Titlecase_Letter        a digraphic character, with first part uppercase
  62     Lm  Modifier_Letter         a modifier letter
  63     Lo  Other_Letter            other letters, including syllables and ideographs
  64     Mn  Nonspacing_Mark         a nonspacing combining mark (zero advance width)
  65     Mc  Spacing_Mark            a spacing combining mark (positive advance width)
  66     Me  Enclosing_Mark          an enclosing combining mark
  67     Nd  Decimal_Number          a decimal digit
  68     Nl  Letter_Number           a letterlike numeric character
  69     No  Other_Number            a numeric character of other type
  70     Pc  Connector_Punctuation   a connecting punctuation mark, like a tie
  71     Pd  Dash_Punctuation        a dash or hyphen punctuation mark
  72     Ps  Open_Punctuation        an opening punctuation mark (of a pair)
  73     Pe  Close_Punctuation       a closing punctuation mark (of a pair)
  74     Pi  Initial_Punctuation     an initial quotation mark
  75     Pf  Final_Punctuation       a final quotation mark
  76     Po  Other_Punctuation       a punctuation mark of other type
  77     Sm  Math_Symbol             a symbol of primarily mathematical use
  78     Sc  Currency_Symbol         a currency sign
  79     Sk  Modifier_Symbol         a non-letterlike modifier symbol
  80     So  Other_Symbol            a symbol of other type
  81     Zs  Space_Separator         a space character (of various non-zero widths)
  82     Zl  Line_Separator          U+2028 LINE SEPARATOR only
  83     Zp  Paragraph_Separator     U+2029 PARAGRAPH SEPARATOR only
  84     Cc  Control                 a C0 or C1 control code
  85     Cf  Format                  a format control character
  86     Cs  Surrogate               a surrogate code point
  87     Co  Private_Use             a private-use character
  88     Cn  Unassigned              a reserved unassigned code point or a noncharacter
  89 */
  90
  91 /// The highest valid code point a `char` can have.
  92 ///
  93 /// A [`char`] is a [Unicode Scalar Value], which means that it is a [Code
  94 /// Point], but only ones within a certain range. `MAX` is the highest valid
  95 /// code point that's a valid [Unicode Scalar Value].
  96 ///
  97 /// [Unicode Scalar Value]: http://www.unicode.org/glossary/#unicode_scalar_value
  98 /// [Code Point]: http://www.unicode.org/glossary/#code_point
  99 #[stable(feature = "rust1", since = "1.0.0")]
 100 pub const MAX: char = char::MAX;
 101
 102 /// `U+FFFD REPLACEMENT CHARACTER` (�) is used in Unicode to represent a
 103 /// decoding error.
 104 ///
 105 /// It can occur, for example, when giving ill-formed UTF-8 bytes to
 106 /// [`String::from_utf8_lossy`](../../std/string/struct.String.html#method.from_utf8_lossy).
 107 #[stable(feature = "decode_utf16", since = "1.9.0")]
 108 pub const REPLACEMENT_CHARACTER: char = char::REPLACEMENT_CHARACTER;
 109
 110 /// Returns an iterator that yields the hexadecimal Unicode escape of a
 111 /// character, as `char`s.
 112 ///
 113 /// This `struct` is created by the [`escape_unicode`] method on [`char`]. See
 114 /// its documentation for more.
 115 ///
 116 /// [`escape_unicode`]: char::escape_unicode
 117 #[derive(Clone, Debug)]
 118 #[stable(feature = "rust1", since = "1.0.0")]
 119 pub struct EscapeUnicode {
 120     c: char,
 121     state: EscapeUnicodeState,
 122
 123     // The index of the next hex digit to be printed (0 if none),
 124     // i.e., the number of remaining hex digits to be printed;
 125     // increasing from the least significant digit: 0x543210
 126     hex_digit_idx: usize,
 127 }
 128
 129 // The enum values are ordered so that their representation is the
 130 // same as the remaining length (besides the hexadecimal digits). This
 131 // likely makes `len()` a single load from memory) and inline-worth.
 132 #[derive(Clone, Debug)]
 133 enum EscapeUnicodeState {
 134     Done,
 135     RightBrace,
 136     Value,
 137     LeftBrace,
 138     Type,
 139     Backslash,
 140 }
 141
 142 #[stable(feature = "rust1", since = "1.0.0")]
 143 impl Iterator for EscapeUnicode {
 144     type Item = char;
 145
 146     fn next(&mut self) -> Option<char> {
 147         match self.state {
 148             EscapeUnicodeState::Backslash => {
 149                 self.state = EscapeUnicodeState::Type;
 150                 Some('\\')
 151             }
 152             EscapeUnicodeState::Type => {
 153                 self.state = EscapeUnicodeState::LeftBrace;
 154                 Some('u')
 155             }
 156             EscapeUnicodeState::LeftBrace => {
 157                 self.state = EscapeUnicodeState::Value;
 158                 Some('{')
 159             }
 160             EscapeUnicodeState::Value => {
 161                 let hex_digit = ((self.c as u32) >> (self.hex_digit_idx * 4)) & 0xf;
 162                 let c = from_digit(hex_digit, 16).unwrap();
 163                 if self.hex_digit_idx == 0 {
 164                     self.state = EscapeUnicodeState::RightBrace;
 165                 } else {
 166                     self.hex_digit_idx -= 1;
 167                 }
 168                 Some(c)
 169             }
 170             EscapeUnicodeState::RightBrace => {
 171                 self.state = EscapeUnicodeState::Done;
 172                 Some('}')
 173             }
 174             EscapeUnicodeState::Done => None,
 175         }
 176     }
 177
 178     #[inline]
 179     fn size_hint(&self) -> (usize, Option<usize>) {
 180         let n = self.len();
 181         (n, Some(n))
 182     }
 183
 184     #[inline]
 185     fn count(self) -> usize {
 186         self.len()
 187     }
 188
 189     fn last(self) -> Option<char> {
 190         match self.state {
 191             EscapeUnicodeState::Done => None,
 192
 193             EscapeUnicodeState::RightBrace
 194             | EscapeUnicodeState::Value
 195             | EscapeUnicodeState::LeftBrace
 196             | EscapeUnicodeState::Type
 197             | EscapeUnicodeState::Backslash => Some('}'),
 198         }
 199     }
 200 }
 201
 202 #[stable(feature = "exact_size_escape", since = "1.11.0")]
 203 impl ExactSizeIterator for EscapeUnicode {
 204     #[inline]
 205     fn len(&self) -> usize {
 206         // The match is a single memory access with no branching
 207         self.hex_digit_idx
 208             + match self.state {
 209                 EscapeUnicodeState::Done => 0,
 210                 EscapeUnicodeState::RightBrace => 1,
 211                 EscapeUnicodeState::Value => 2,
 212                 EscapeUnicodeState::LeftBrace => 3,
 213                 EscapeUnicodeState::Type => 4,
 214                 EscapeUnicodeState::Backslash => 5,
 215             }
 216     }
 217 }
 218
 219 #[stable(feature = "fused", since = "1.26.0")]
 220 impl FusedIterator for EscapeUnicode {}
 221
 222 #[stable(feature = "char_struct_display", since = "1.16.0")]
 223 impl fmt::Display for EscapeUnicode {
 224     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 225         for c in self.clone() {
 226             f.write_char(c)?;
 227         }
 228         Ok(())
 229     }
 230 }
 231
 232 /// An iterator that yields the literal escape code of a `char`.
 233 ///
 234 /// This `struct` is created by the [`escape_default`] method on [`char`]. See
 235 /// its documentation for more.
 236 ///
 237 /// [`escape_default`]: char::escape_default
 238 #[derive(Clone, Debug)]
 239 #[stable(feature = "rust1", since = "1.0.0")]
 240 pub struct EscapeDefault {
 241     state: EscapeDefaultState,
 242 }
 243
 244 #[derive(Clone, Debug)]
 245 enum EscapeDefaultState {
 246     Done,
 247     Char(char),
 248     Backslash(char),
 249     Unicode(EscapeUnicode),
 250 }
 251
 252 #[stable(feature = "rust1", since = "1.0.0")]
 253 impl Iterator for EscapeDefault {
 254     type Item = char;
 255
 256     fn next(&mut self) -> Option<char> {
 257         match self.state {
 258             EscapeDefaultState::Backslash(c) => {
 259                 self.state = EscapeDefaultState::Char(c);
 260                 Some('\\')
 261             }
 262             EscapeDefaultState::Char(c) => {
 263                 self.state = EscapeDefaultState::Done;
 264                 Some(c)
 265             }
 266             EscapeDefaultState::Done => None,
 267             EscapeDefaultState::Unicode(ref mut iter) => iter.next(),
 268         }
 269     }
 270
 271     #[inline]
 272     fn size_hint(&self) -> (usize, Option<usize>) {
 273         let n = self.len();
 274         (n, Some(n))
 275     }
 276
 277     #[inline]
 278     fn count(self) -> usize {
 279         self.len()
 280     }
 281
 282     fn nth(&mut self, n: usize) -> Option<char> {
 283         match self.state {
 284             EscapeDefaultState::Backslash(c) if n == 0 => {
 285                 self.state = EscapeDefaultState::Char(c);
 286                 Some('\\')
 287             }
 288             EscapeDefaultState::Backslash(c) if n == 1 => {
 289                 self.state = EscapeDefaultState::Done;
 290                 Some(c)
 291             }
 292             EscapeDefaultState::Backslash(_) => {
 293                 self.state = EscapeDefaultState::Done;
 294                 None
 295             }
 296             EscapeDefaultState::Char(c) => {
 297                 self.state = EscapeDefaultState::Done;
 298
 299                 if n == 0 { Some(c) } else { None }
 300             }
 301             EscapeDefaultState::Done => None,
 302             EscapeDefaultState::Unicode(ref mut i) => i.nth(n),
 303         }
 304     }
 305
 306     fn last(self) -> Option<char> {
 307         match self.state {
 308             EscapeDefaultState::Unicode(iter) => iter.last(),
 309             EscapeDefaultState::Done => None,
 310             EscapeDefaultState::Backslash(c) | EscapeDefaultState::Char(c) => Some(c),
 311         }
 312     }
 313 }
 314
 315 #[stable(feature = "exact_size_escape", since = "1.11.0")]
 316 impl ExactSizeIterator for EscapeDefault {
 317     fn len(&self) -> usize {
 318         match self.state {
 319             EscapeDefaultState::Done => 0,
 320             EscapeDefaultState::Char(_) => 1,
 321             EscapeDefaultState::Backslash(_) => 2,
 322             EscapeDefaultState::Unicode(ref iter) => iter.len(),
 323         }
 324     }
 325 }
 326
 327 #[stable(feature = "fused", since = "1.26.0")]
 328 impl FusedIterator for EscapeDefault {}
 329
 330 #[stable(feature = "char_struct_display", since = "1.16.0")]
 331 impl fmt::Display for EscapeDefault {
 332     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 333         for c in self.clone() {
 334             f.write_char(c)?;
 335         }
 336         Ok(())
 337     }
 338 }
 339
 340 /// An iterator that yields the literal escape code of a `char`.
 341 ///
 342 /// This `struct` is created by the [`escape_debug`] method on [`char`]. See its
 343 /// documentation for more.
 344 ///
 345 /// [`escape_debug`]: char::escape_debug
 346 #[stable(feature = "char_escape_debug", since = "1.20.0")]
 347 #[derive(Clone, Debug)]
 348 pub struct EscapeDebug(EscapeDefault);
 349
 350 #[stable(feature = "char_escape_debug", since = "1.20.0")]
 351 impl Iterator for EscapeDebug {
 352     type Item = char;
 353     fn next(&mut self) -> Option<char> {
 354         self.0.next()
 355     }
 356     fn size_hint(&self) -> (usize, Option<usize>) {
 357         self.0.size_hint()
 358     }
 359 }
 360
 361 #[stable(feature = "char_escape_debug", since = "1.20.0")]
 362 impl ExactSizeIterator for EscapeDebug {}
 363
 364 #[stable(feature = "fused", since = "1.26.0")]
 365 impl FusedIterator for EscapeDebug {}
 366
 367 #[stable(feature = "char_escape_debug", since = "1.20.0")]
 368 impl fmt::Display for EscapeDebug {
 369     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 370         fmt::Display::fmt(&self.0, f)
 371     }
 372 }
 373
 374 /// Returns an iterator that yields the lowercase equivalent of a `char`.
 375 ///
 376 /// This `struct` is created by the [`to_lowercase`] method on [`char`]. See
 377 /// its documentation for more.
 378 ///
 379 /// [`to_lowercase`]: char::to_lowercase
 380 #[stable(feature = "rust1", since = "1.0.0")]
 381 #[derive(Debug, Clone)]
 382 pub struct ToLowercase(CaseMappingIter);
 383
 384 #[stable(feature = "rust1", since = "1.0.0")]
 385 impl Iterator for ToLowercase {
 386     type Item = char;
 387     fn next(&mut self) -> Option<char> {
 388         self.0.next()
 389     }
 390     fn size_hint(&self) -> (usize, Option<usize>) {
 391         self.0.size_hint()
 392     }
 393 }
 394
 395 #[stable(feature = "fused", since = "1.26.0")]
 396 impl FusedIterator for ToLowercase {}
 397
 398 #[stable(feature = "exact_size_case_mapping_iter", since = "1.35.0")]
 399 impl ExactSizeIterator for ToLowercase {}
 400
 401 /// Returns an iterator that yields the uppercase equivalent of a `char`.
 402 ///
 403 /// This `struct` is created by the [`to_uppercase`] method on [`char`]. See
 404 /// its documentation for more.
 405 ///
 406 /// [`to_uppercase`]: char::to_uppercase
 407 #[stable(feature = "rust1", since = "1.0.0")]
 408 #[derive(Debug, Clone)]
 409 pub struct ToUppercase(CaseMappingIter);
 410
 411 #[stable(feature = "rust1", since = "1.0.0")]
 412 impl Iterator for ToUppercase {
 413     type Item = char;
 414     fn next(&mut self) -> Option<char> {
 415         self.0.next()
 416     }
 417     fn size_hint(&self) -> (usize, Option<usize>) {
 418         self.0.size_hint()
 419     }
 420 }
 421
 422 #[stable(feature = "fused", since = "1.26.0")]
 423 impl FusedIterator for ToUppercase {}
 424
 425 #[stable(feature = "exact_size_case_mapping_iter", since = "1.35.0")]
 426 impl ExactSizeIterator for ToUppercase {}
 427
 428 #[derive(Debug, Clone)]
 429 enum CaseMappingIter {
 430     Three(char, char, char),
 431     Two(char, char),
 432     One(char),
 433     Zero,
 434 }
 435
 436 impl CaseMappingIter {
 437     fn new(chars: [char; 3]) -> CaseMappingIter {
 438         if chars[2] == '\0' {
 439             if chars[1] == '\0' {
 440                 CaseMappingIter::One(chars[0]) // Including if chars[0] == '\0'
 441             } else {
 442                 CaseMappingIter::Two(chars[0], chars[1])
 443             }
 444         } else {
 445             CaseMappingIter::Three(chars[0], chars[1], chars[2])
 446         }
 447     }
 448 }
 449
 450 impl Iterator for CaseMappingIter {
 451     type Item = char;
 452     fn next(&mut self) -> Option<char> {
 453         match *self {
 454             CaseMappingIter::Three(a, b, c) => {
 455                 *self = CaseMappingIter::Two(b, c);
 456                 Some(a)
 457             }
 458             CaseMappingIter::Two(b, c) => {
 459                 *self = CaseMappingIter::One(c);
 460                 Some(b)
 461             }
 462             CaseMappingIter::One(c) => {
 463                 *self = CaseMappingIter::Zero;
 464                 Some(c)
 465             }
 466             CaseMappingIter::Zero => None,
 467         }
 468     }
 469
 470     fn size_hint(&self) -> (usize, Option<usize>) {
 471         let size = match self {
 472             CaseMappingIter::Three(..) => 3,
 473             CaseMappingIter::Two(..) => 2,
 474             CaseMappingIter::One(_) => 1,
 475             CaseMappingIter::Zero => 0,
 476         };
 477         (size, Some(size))
 478     }
 479 }
 480
 481 impl fmt::Display for CaseMappingIter {
 482     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 483         match *self {
 484             CaseMappingIter::Three(a, b, c) => {
 485                 f.write_char(a)?;
 486                 f.write_char(b)?;
 487                 f.write_char(c)
 488             }
 489             CaseMappingIter::Two(b, c) => {
 490                 f.write_char(b)?;
 491                 f.write_char(c)
 492             }
 493             CaseMappingIter::One(c) => f.write_char(c),
 494             CaseMappingIter::Zero => Ok(()),
 495         }
 496     }
 497 }
 498
 499 #[stable(feature = "char_struct_display", since = "1.16.0")]
 500 impl fmt::Display for ToLowercase {
 501     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 502         fmt::Display::fmt(&self.0, f)
 503     }
 504 }
 505
 506 #[stable(feature = "char_struct_display", since = "1.16.0")]
 507 impl fmt::Display for ToUppercase {
 508     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 509         fmt::Display::fmt(&self.0, f)
 510     }
 511 }