4 use crate::str::from_utf8_unchecked_mut;
5 use crate::unicode::printable::is_printable;
6 use crate::unicode::tables::{conversions, derived_property, general_category, property};
12 /// Checks if a `char` is a digit in the given radix.
14 /// A 'radix' here is sometimes also called a 'base'. A radix of two
15 /// indicates a binary number, a radix of ten, decimal, and a radix of
16 /// sixteen, hexadecimal, to give some common values. Arbitrary
17 /// radices are supported.
19 /// Compared to `is_numeric()`, this function only recognizes the characters
20 /// `0-9`, `a-z` and `A-Z`.
22 /// 'Digit' is defined to be only the following characters:
28 /// For a more comprehensive understanding of 'digit', see [`is_numeric`][is_numeric].
30 /// [is_numeric]: #method.is_numeric
34 /// Panics if given a radix larger than 36.
41 /// assert!('1'.is_digit(10));
42 /// assert!('f'.is_digit(16));
43 /// assert!(!'f'.is_digit(10));
46 /// Passing a large radix, causing a panic:
51 /// let result = thread::spawn(|| {
56 /// assert!(result.is_err());
58 #[stable(feature = "rust1", since = "1.0.0")]
60 pub fn is_digit(self, radix: u32) -> bool {
61 self.to_digit(radix).is_some()
64 /// Converts a `char` to a digit in the given radix.
66 /// A 'radix' here is sometimes also called a 'base'. A radix of two
67 /// indicates a binary number, a radix of ten, decimal, and a radix of
68 /// sixteen, hexadecimal, to give some common values. Arbitrary
69 /// radices are supported.
71 /// 'Digit' is defined to be only the following characters:
79 /// Returns `None` if the `char` does not refer to a digit in the given radix.
83 /// Panics if given a radix larger than 36.
90 /// assert_eq!('1'.to_digit(10), Some(1));
91 /// assert_eq!('f'.to_digit(16), Some(15));
94 /// Passing a non-digit results in failure:
97 /// assert_eq!('f'.to_digit(10), None);
98 /// assert_eq!('z'.to_digit(16), None);
101 /// Passing a large radix, causing a panic:
106 /// let result = thread::spawn(|| {
107 /// '1'.to_digit(37);
110 /// assert!(result.is_err());
112 #[stable(feature = "rust1", since = "1.0.0")]
114 pub fn to_digit(self, radix: u32) -> Option<u32> {
115 assert!(radix <= 36, "to_digit: radix is too high (maximum 36)");
117 // the code is split up here to improve execution speed for cases where
118 // the `radix` is constant and 10 or smaller
119 let val = if radix <= 10 {
121 '0'..='9' => self as u32 - '0' as u32,
126 '0'..='9' => self as u32 - '0' as u32,
127 'a'..='z' => self as u32 - 'a' as u32 + 10,
128 'A'..='Z' => self as u32 - 'A' as u32 + 10,
133 if val < radix { Some(val) } else { None }
136 /// Returns an iterator that yields the hexadecimal Unicode escape of a
137 /// character as `char`s.
139 /// This will escape characters with the Rust syntax of the form
140 /// `\u{NNNNNN}` where `NNNNNN` is a hexadecimal representation.
147 /// for c in '❤'.escape_unicode() {
153 /// Using `println!` directly:
156 /// println!("{}", '❤'.escape_unicode());
159 /// Both are equivalent to:
162 /// println!("\\u{{2764}}");
165 /// Using `to_string`:
168 /// assert_eq!('❤'.escape_unicode().to_string(), "\\u{2764}");
170 #[stable(feature = "rust1", since = "1.0.0")]
172 pub fn escape_unicode(self) -> EscapeUnicode {
175 // or-ing 1 ensures that for c==0 the code computes that one
176 // digit should be printed and (which is the same) avoids the
177 // (31 - 32) underflow
178 let msb = 31 - (c | 1).leading_zeros();
180 // the index of the most significant hex digit
181 let ms_hex_digit = msb / 4;
184 state: EscapeUnicodeState::Backslash,
185 hex_digit_idx: ms_hex_digit as usize,
189 /// An extended version of `escape_debug` that optionally permits escaping
190 /// Extended Grapheme codepoints. This allows us to format characters like
191 /// nonspacing marks better when they're at the start of a string.
193 pub(crate) fn escape_debug_ext(self, escape_grapheme_extended: bool) -> EscapeDebug {
194 let init_state = match self {
195 '\t' => EscapeDefaultState::Backslash('t'),
196 '\r' => EscapeDefaultState::Backslash('r'),
197 '\n' => EscapeDefaultState::Backslash('n'),
198 '\\' | '\'' | '"' => EscapeDefaultState::Backslash(self),
199 _ if escape_grapheme_extended && self.is_grapheme_extended() => {
200 EscapeDefaultState::Unicode(self.escape_unicode())
202 _ if is_printable(self) => EscapeDefaultState::Char(self),
203 _ => EscapeDefaultState::Unicode(self.escape_unicode()),
205 EscapeDebug(EscapeDefault { state: init_state })
208 /// Returns an iterator that yields the literal escape code of a character
211 /// This will escape the characters similar to the `Debug` implementations
212 /// of `str` or `char`.
219 /// for c in '\n'.escape_debug() {
225 /// Using `println!` directly:
228 /// println!("{}", '\n'.escape_debug());
231 /// Both are equivalent to:
237 /// Using `to_string`:
240 /// assert_eq!('\n'.escape_debug().to_string(), "\\n");
242 #[stable(feature = "char_escape_debug", since = "1.20.0")]
244 pub fn escape_debug(self) -> EscapeDebug {
245 self.escape_debug_ext(true)
248 /// Returns an iterator that yields the literal escape code of a character
251 /// The default is chosen with a bias toward producing literals that are
252 /// legal in a variety of languages, including C++11 and similar C-family
253 /// languages. The exact rules are:
255 /// * Tab is escaped as `\t`.
256 /// * Carriage return is escaped as `\r`.
257 /// * Line feed is escaped as `\n`.
258 /// * Single quote is escaped as `\'`.
259 /// * Double quote is escaped as `\"`.
260 /// * Backslash is escaped as `\\`.
261 /// * Any character in the 'printable ASCII' range `0x20` .. `0x7e`
262 /// inclusive is not escaped.
263 /// * All other characters are given hexadecimal Unicode escapes; see
264 /// [`escape_unicode`][escape_unicode].
266 /// [escape_unicode]: #method.escape_unicode
273 /// for c in '"'.escape_default() {
279 /// Using `println!` directly:
282 /// println!("{}", '"'.escape_default());
286 /// Both are equivalent to:
289 /// println!("\\\"");
292 /// Using `to_string`:
295 /// assert_eq!('"'.escape_default().to_string(), "\\\"");
297 #[stable(feature = "rust1", since = "1.0.0")]
299 pub fn escape_default(self) -> EscapeDefault {
300 let init_state = match self {
301 '\t' => EscapeDefaultState::Backslash('t'),
302 '\r' => EscapeDefaultState::Backslash('r'),
303 '\n' => EscapeDefaultState::Backslash('n'),
304 '\\' | '\'' | '"' => EscapeDefaultState::Backslash(self),
305 '\x20'..='\x7e' => EscapeDefaultState::Char(self),
306 _ => EscapeDefaultState::Unicode(self.escape_unicode()),
308 EscapeDefault { state: init_state }
311 /// Returns the number of bytes this `char` would need if encoded in UTF-8.
313 /// That number of bytes is always between 1 and 4, inclusive.
320 /// let len = 'A'.len_utf8();
321 /// assert_eq!(len, 1);
323 /// let len = 'ß'.len_utf8();
324 /// assert_eq!(len, 2);
326 /// let len = 'ℝ'.len_utf8();
327 /// assert_eq!(len, 3);
329 /// let len = '💣'.len_utf8();
330 /// assert_eq!(len, 4);
333 /// The `&str` type guarantees that its contents are UTF-8, and so we can compare the length it
334 /// would take if each code point was represented as a `char` vs in the `&str` itself:
338 /// let eastern = '東';
339 /// let capital = '京';
341 /// // both can be represented as three bytes
342 /// assert_eq!(3, eastern.len_utf8());
343 /// assert_eq!(3, capital.len_utf8());
345 /// // as a &str, these two are encoded in UTF-8
346 /// let tokyo = "東京";
348 /// let len = eastern.len_utf8() + capital.len_utf8();
350 /// // we can see that they take six bytes total...
351 /// assert_eq!(6, tokyo.len());
353 /// // ... just like the &str
354 /// assert_eq!(len, tokyo.len());
356 #[stable(feature = "rust1", since = "1.0.0")]
358 pub fn len_utf8(self) -> usize {
359 let code = self as u32;
360 if code < MAX_ONE_B {
362 } else if code < MAX_TWO_B {
364 } else if code < MAX_THREE_B {
371 /// Returns the number of 16-bit code units this `char` would need if
372 /// encoded in UTF-16.
374 /// See the documentation for [`len_utf8`] for more explanation of this
375 /// concept. This function is a mirror, but for UTF-16 instead of UTF-8.
377 /// [`len_utf8`]: #method.len_utf8
384 /// let n = 'ß'.len_utf16();
385 /// assert_eq!(n, 1);
387 /// let len = '💣'.len_utf16();
388 /// assert_eq!(len, 2);
390 #[stable(feature = "rust1", since = "1.0.0")]
392 pub fn len_utf16(self) -> usize {
393 let ch = self as u32;
394 if (ch & 0xFFFF) == ch { 1 } else { 2 }
397 /// Encodes this character as UTF-8 into the provided byte buffer,
398 /// and then returns the subslice of the buffer that contains the encoded character.
402 /// Panics if the buffer is not large enough.
403 /// A buffer of length four is large enough to encode any `char`.
407 /// In both of these examples, 'ß' takes two bytes to encode.
410 /// let mut b = [0; 2];
412 /// let result = 'ß'.encode_utf8(&mut b);
414 /// assert_eq!(result, "ß");
416 /// assert_eq!(result.len(), 2);
419 /// A buffer that's too small:
424 /// let result = thread::spawn(|| {
425 /// let mut b = [0; 1];
428 /// 'ß'.encode_utf8(&mut b);
431 /// assert!(result.is_err());
433 #[stable(feature = "unicode_encode_char", since = "1.15.0")]
435 pub fn encode_utf8(self, dst: &mut [u8]) -> &mut str {
436 let code = self as u32;
437 let len = self.len_utf8();
438 match (len, &mut dst[..]) {
443 *a = (code >> 6 & 0x1F) as u8 | TAG_TWO_B;
444 *b = (code & 0x3F) as u8 | TAG_CONT;
446 (3, [a, b, c, ..]) => {
447 *a = (code >> 12 & 0x0F) as u8 | TAG_THREE_B;
448 *b = (code >> 6 & 0x3F) as u8 | TAG_CONT;
449 *c = (code & 0x3F) as u8 | TAG_CONT;
451 (4, [a, b, c, d, ..]) => {
452 *a = (code >> 18 & 0x07) as u8 | TAG_FOUR_B;
453 *b = (code >> 12 & 0x3F) as u8 | TAG_CONT;
454 *c = (code >> 6 & 0x3F) as u8 | TAG_CONT;
455 *d = (code & 0x3F) as u8 | TAG_CONT;
458 "encode_utf8: need {} bytes to encode U+{:X}, but the buffer has {}",
464 // SAFETY: We just wrote UTF-8 content in, so converting to str is fine.
465 unsafe { from_utf8_unchecked_mut(&mut dst[..len]) }
468 /// Encodes this character as UTF-16 into the provided `u16` buffer,
469 /// and then returns the subslice of the buffer that contains the encoded character.
473 /// Panics if the buffer is not large enough.
474 /// A buffer of length 2 is large enough to encode any `char`.
478 /// In both of these examples, '𝕊' takes two `u16`s to encode.
481 /// let mut b = [0; 2];
483 /// let result = '𝕊'.encode_utf16(&mut b);
485 /// assert_eq!(result.len(), 2);
488 /// A buffer that's too small:
493 /// let result = thread::spawn(|| {
494 /// let mut b = [0; 1];
497 /// '𝕊'.encode_utf16(&mut b);
500 /// assert!(result.is_err());
502 #[stable(feature = "unicode_encode_char", since = "1.15.0")]
504 pub fn encode_utf16(self, dst: &mut [u16]) -> &mut [u16] {
505 let mut code = self as u32;
506 // SAFETY: each arm checks whether there are enough bits to write into
508 if (code & 0xFFFF) == code && !dst.is_empty() {
509 // The BMP falls through (assuming non-surrogate, as it should)
510 *dst.get_unchecked_mut(0) = code as u16;
511 slice::from_raw_parts_mut(dst.as_mut_ptr(), 1)
512 } else if dst.len() >= 2 {
513 // Supplementary planes break into surrogates.
515 *dst.get_unchecked_mut(0) = 0xD800 | ((code >> 10) as u16);
516 *dst.get_unchecked_mut(1) = 0xDC00 | ((code as u16) & 0x3FF);
517 slice::from_raw_parts_mut(dst.as_mut_ptr(), 2)
520 "encode_utf16: need {} units to encode U+{:X}, but the buffer has {}",
521 from_u32_unchecked(code).len_utf16(),
529 /// Returns `true` if this `char` has the `Alphabetic` property.
531 /// `Alphabetic` is described in Chapter 4 (Character Properties) of the [Unicode Standard] and
532 /// specified in the [Unicode Character Database][ucd] [`DerivedCoreProperties.txt`].
534 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
535 /// [ucd]: https://www.unicode.org/reports/tr44/
536 /// [`DerivedCoreProperties.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/DerivedCoreProperties.txt
543 /// assert!('a'.is_alphabetic());
544 /// assert!('京'.is_alphabetic());
547 /// // love is many things, but it is not alphabetic
548 /// assert!(!c.is_alphabetic());
550 #[stable(feature = "rust1", since = "1.0.0")]
552 pub fn is_alphabetic(self) -> bool {
554 'a'..='z' | 'A'..='Z' => true,
555 c => c > '\x7f' && derived_property::Alphabetic(c),
559 /// Returns `true` if this `char` has the `Lowercase` property.
561 /// `Lowercase` is described in Chapter 4 (Character Properties) of the [Unicode Standard] and
562 /// specified in the [Unicode Character Database][ucd] [`DerivedCoreProperties.txt`].
564 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
565 /// [ucd]: https://www.unicode.org/reports/tr44/
566 /// [`DerivedCoreProperties.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/DerivedCoreProperties.txt
573 /// assert!('a'.is_lowercase());
574 /// assert!('δ'.is_lowercase());
575 /// assert!(!'A'.is_lowercase());
576 /// assert!(!'Δ'.is_lowercase());
578 /// // The various Chinese scripts do not have case, and so:
579 /// assert!(!'中'.is_lowercase());
581 #[stable(feature = "rust1", since = "1.0.0")]
583 pub fn is_lowercase(self) -> bool {
586 c => c > '\x7f' && derived_property::Lowercase(c),
590 /// Returns `true` if this `char` has the `Uppercase` property.
592 /// `Uppercase` is described in Chapter 4 (Character Properties) of the [Unicode Standard] and
593 /// specified in the [Unicode Character Database][ucd] [`DerivedCoreProperties.txt`].
595 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
596 /// [ucd]: https://www.unicode.org/reports/tr44/
597 /// [`DerivedCoreProperties.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/DerivedCoreProperties.txt
604 /// assert!(!'a'.is_uppercase());
605 /// assert!(!'δ'.is_uppercase());
606 /// assert!('A'.is_uppercase());
607 /// assert!('Δ'.is_uppercase());
609 /// // The various Chinese scripts do not have case, and so:
610 /// assert!(!'中'.is_uppercase());
612 #[stable(feature = "rust1", since = "1.0.0")]
614 pub fn is_uppercase(self) -> bool {
617 c => c > '\x7f' && derived_property::Uppercase(c),
621 /// Returns `true` if this `char` has the `White_Space` property.
623 /// `White_Space` is specified in the [Unicode Character Database][ucd] [`PropList.txt`].
625 /// [ucd]: https://www.unicode.org/reports/tr44/
626 /// [`PropList.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/PropList.txt
633 /// assert!(' '.is_whitespace());
635 /// // a non-breaking space
636 /// assert!('\u{A0}'.is_whitespace());
638 /// assert!(!'越'.is_whitespace());
640 #[stable(feature = "rust1", since = "1.0.0")]
642 pub fn is_whitespace(self) -> bool {
644 ' ' | '\x09'..='\x0d' => true,
645 c => c > '\x7f' && property::White_Space(c),
649 /// Returns `true` if this `char` satisfies either [`is_alphabetic()`] or [`is_numeric()`].
651 /// [`is_alphabetic()`]: #method.is_alphabetic
652 /// [`is_numeric()`]: #method.is_numeric
659 /// assert!('٣'.is_alphanumeric());
660 /// assert!('7'.is_alphanumeric());
661 /// assert!('৬'.is_alphanumeric());
662 /// assert!('¾'.is_alphanumeric());
663 /// assert!('①'.is_alphanumeric());
664 /// assert!('K'.is_alphanumeric());
665 /// assert!('و'.is_alphanumeric());
666 /// assert!('藏'.is_alphanumeric());
668 #[stable(feature = "rust1", since = "1.0.0")]
670 pub fn is_alphanumeric(self) -> bool {
671 self.is_alphabetic() || self.is_numeric()
674 /// Returns `true` if this `char` has the general category for control codes.
676 /// Control codes (code points with the general category of `Cc`) are described in Chapter 4
677 /// (Character Properties) of the [Unicode Standard] and specified in the [Unicode Character
678 /// Database][ucd] [`UnicodeData.txt`].
680 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
681 /// [ucd]: https://www.unicode.org/reports/tr44/
682 /// [`UnicodeData.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/UnicodeData.txt
689 /// // U+009C, STRING TERMINATOR
690 /// assert!('
\9c'.is_control());
691 /// assert!(!'q'.is_control());
693 #[stable(feature = "rust1", since = "1.0.0")]
695 pub fn is_control(self) -> bool {
696 general_category::Cc(self)
699 /// Returns `true` if this `char` has the `Grapheme_Extend` property.
701 /// `Grapheme_Extend` is described in [Unicode Standard Annex #29 (Unicode Text
702 /// Segmentation)][uax29] and specified in the [Unicode Character Database][ucd]
703 /// [`DerivedCoreProperties.txt`].
705 /// [uax29]: https://www.unicode.org/reports/tr29/
706 /// [ucd]: https://www.unicode.org/reports/tr44/
707 /// [`DerivedCoreProperties.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/DerivedCoreProperties.txt
709 pub(crate) fn is_grapheme_extended(self) -> bool {
710 derived_property::Grapheme_Extend(self)
713 /// Returns `true` if this `char` has one of the general categories for numbers.
715 /// The general categories for numbers (`Nd` for decimal digits, `Nl` for letter-like numeric
716 /// characters, and `No` for other numeric characters) are specified in the [Unicode Character
717 /// Database][ucd] [`UnicodeData.txt`].
719 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
720 /// [ucd]: https://www.unicode.org/reports/tr44/
721 /// [`UnicodeData.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/UnicodeData.txt
728 /// assert!('٣'.is_numeric());
729 /// assert!('7'.is_numeric());
730 /// assert!('৬'.is_numeric());
731 /// assert!('¾'.is_numeric());
732 /// assert!('①'.is_numeric());
733 /// assert!(!'K'.is_numeric());
734 /// assert!(!'و'.is_numeric());
735 /// assert!(!'藏'.is_numeric());
737 #[stable(feature = "rust1", since = "1.0.0")]
739 pub fn is_numeric(self) -> bool {
742 c => c > '\x7f' && general_category::N(c),
746 /// Returns an iterator that yields the lowercase mapping of this `char` as one or more
749 /// If this `char` does not have a lowercase mapping, the iterator yields the same `char`.
751 /// If this `char` has a one-to-one lowercase mapping given by the [Unicode Character
752 /// Database][ucd] [`UnicodeData.txt`], the iterator yields that `char`.
754 /// [ucd]: https://www.unicode.org/reports/tr44/
755 /// [`UnicodeData.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/UnicodeData.txt
757 /// If this `char` requires special considerations (e.g. multiple `char`s) the iterator yields
758 /// the `char`(s) given by [`SpecialCasing.txt`].
760 /// [`SpecialCasing.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/SpecialCasing.txt
762 /// This operation performs an unconditional mapping without tailoring. That is, the conversion
763 /// is independent of context and language.
765 /// In the [Unicode Standard], Chapter 4 (Character Properties) discusses case mapping in
766 /// general and Chapter 3 (Conformance) discusses the default algorithm for case conversion.
768 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
775 /// for c in 'İ'.to_lowercase() {
781 /// Using `println!` directly:
784 /// println!("{}", 'İ'.to_lowercase());
787 /// Both are equivalent to:
790 /// println!("i\u{307}");
793 /// Using `to_string`:
796 /// assert_eq!('C'.to_lowercase().to_string(), "c");
798 /// // Sometimes the result is more than one character:
799 /// assert_eq!('İ'.to_lowercase().to_string(), "i\u{307}");
801 /// // Characters that do not have both uppercase and lowercase
802 /// // convert into themselves.
803 /// assert_eq!('山'.to_lowercase().to_string(), "山");
805 #[stable(feature = "rust1", since = "1.0.0")]
807 pub fn to_lowercase(self) -> ToLowercase {
808 ToLowercase(CaseMappingIter::new(conversions::to_lower(self)))
811 /// Returns an iterator that yields the uppercase mapping of this `char` as one or more
814 /// If this `char` does not have a uppercase mapping, the iterator yields the same `char`.
816 /// If this `char` has a one-to-one uppercase mapping given by the [Unicode Character
817 /// Database][ucd] [`UnicodeData.txt`], the iterator yields that `char`.
819 /// [ucd]: https://www.unicode.org/reports/tr44/
820 /// [`UnicodeData.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/UnicodeData.txt
822 /// If this `char` requires special considerations (e.g. multiple `char`s) the iterator yields
823 /// the `char`(s) given by [`SpecialCasing.txt`].
825 /// [`SpecialCasing.txt`]: https://www.unicode.org/Public/UCD/latest/ucd/SpecialCasing.txt
827 /// This operation performs an unconditional mapping without tailoring. That is, the conversion
828 /// is independent of context and language.
830 /// In the [Unicode Standard], Chapter 4 (Character Properties) discusses case mapping in
831 /// general and Chapter 3 (Conformance) discusses the default algorithm for case conversion.
833 /// [Unicode Standard]: https://www.unicode.org/versions/latest/
840 /// for c in 'ß'.to_uppercase() {
846 /// Using `println!` directly:
849 /// println!("{}", 'ß'.to_uppercase());
852 /// Both are equivalent to:
858 /// Using `to_string`:
861 /// assert_eq!('c'.to_uppercase().to_string(), "C");
863 /// // Sometimes the result is more than one character:
864 /// assert_eq!('ß'.to_uppercase().to_string(), "SS");
866 /// // Characters that do not have both uppercase and lowercase
867 /// // convert into themselves.
868 /// assert_eq!('山'.to_uppercase().to_string(), "山");
873 /// In Turkish, the equivalent of 'i' in Latin has five forms instead of two:
875 /// * 'Dotless': I / ı, sometimes written ï
876 /// * 'Dotted': İ / i
878 /// Note that the lowercase dotted 'i' is the same as the Latin. Therefore:
881 /// let upper_i = 'i'.to_uppercase().to_string();
884 /// The value of `upper_i` here relies on the language of the text: if we're
885 /// in `en-US`, it should be `"I"`, but if we're in `tr_TR`, it should
886 /// be `"İ"`. `to_uppercase()` does not take this into account, and so:
889 /// let upper_i = 'i'.to_uppercase().to_string();
891 /// assert_eq!(upper_i, "I");
894 /// holds across languages.
895 #[stable(feature = "rust1", since = "1.0.0")]
897 pub fn to_uppercase(self) -> ToUppercase {
898 ToUppercase(CaseMappingIter::new(conversions::to_upper(self)))
901 /// Checks if the value is within the ASCII range.
907 /// let non_ascii = '❤';
909 /// assert!(ascii.is_ascii());
910 /// assert!(!non_ascii.is_ascii());
912 #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
913 #[rustc_const_stable(feature = "const_ascii_methods_on_intrinsics", since = "1.32.0")]
915 pub const fn is_ascii(&self) -> bool {
919 /// Makes a copy of the value in its ASCII upper case equivalent.
921 /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
922 /// but non-ASCII letters are unchanged.
924 /// To uppercase the value in-place, use [`make_ascii_uppercase`].
926 /// To uppercase ASCII characters in addition to non-ASCII characters, use
927 /// [`to_uppercase`].
933 /// let non_ascii = '❤';
935 /// assert_eq!('A', ascii.to_ascii_uppercase());
936 /// assert_eq!('❤', non_ascii.to_ascii_uppercase());
939 /// [`make_ascii_uppercase`]: #method.make_ascii_uppercase
940 /// [`to_uppercase`]: #method.to_uppercase
941 #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
943 pub fn to_ascii_uppercase(&self) -> char {
944 if self.is_ascii() { (*self as u8).to_ascii_uppercase() as char } else { *self }
947 /// Makes a copy of the value in its ASCII lower case equivalent.
949 /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
950 /// but non-ASCII letters are unchanged.
952 /// To lowercase the value in-place, use [`make_ascii_lowercase`].
954 /// To lowercase ASCII characters in addition to non-ASCII characters, use
955 /// [`to_lowercase`].
961 /// let non_ascii = '❤';
963 /// assert_eq!('a', ascii.to_ascii_lowercase());
964 /// assert_eq!('❤', non_ascii.to_ascii_lowercase());
967 /// [`make_ascii_lowercase`]: #method.make_ascii_lowercase
968 /// [`to_lowercase`]: #method.to_lowercase
969 #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
971 pub fn to_ascii_lowercase(&self) -> char {
972 if self.is_ascii() { (*self as u8).to_ascii_lowercase() as char } else { *self }
975 /// Checks that two values are an ASCII case-insensitive match.
977 /// Equivalent to `to_ascii_lowercase(a) == to_ascii_lowercase(b)`.
982 /// let upper_a = 'A';
983 /// let lower_a = 'a';
984 /// let lower_z = 'z';
986 /// assert!(upper_a.eq_ignore_ascii_case(&lower_a));
987 /// assert!(upper_a.eq_ignore_ascii_case(&upper_a));
988 /// assert!(!upper_a.eq_ignore_ascii_case(&lower_z));
990 #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
992 pub fn eq_ignore_ascii_case(&self, other: &char) -> bool {
993 self.to_ascii_lowercase() == other.to_ascii_lowercase()
996 /// Converts this type to its ASCII upper case equivalent in-place.
998 /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
999 /// but non-ASCII letters are unchanged.
1001 /// To return a new uppercased value without modifying the existing one, use
1002 /// [`to_ascii_uppercase`].
1007 /// let mut ascii = 'a';
1009 /// ascii.make_ascii_uppercase();
1011 /// assert_eq!('A', ascii);
1014 /// [`to_ascii_uppercase`]: #method.to_ascii_uppercase
1015 #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
1017 pub fn make_ascii_uppercase(&mut self) {
1018 *self = self.to_ascii_uppercase();
1021 /// Converts this type to its ASCII lower case equivalent in-place.
1023 /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
1024 /// but non-ASCII letters are unchanged.
1026 /// To return a new lowercased value without modifying the existing one, use
1027 /// [`to_ascii_lowercase`].
1032 /// let mut ascii = 'A';
1034 /// ascii.make_ascii_lowercase();
1036 /// assert_eq!('a', ascii);
1039 /// [`to_ascii_lowercase`]: #method.to_ascii_lowercase
1040 #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
1042 pub fn make_ascii_lowercase(&mut self) {
1043 *self = self.to_ascii_lowercase();
1046 /// Checks if the value is an ASCII alphabetic character:
1048 /// - U+0041 'A' ..= U+005A 'Z', or
1049 /// - U+0061 'a' ..= U+007A 'z'.
1054 /// let uppercase_a = 'A';
1055 /// let uppercase_g = 'G';
1059 /// let percent = '%';
1060 /// let space = ' ';
1062 /// let esc: char = 0x1b_u8.into();
1064 /// assert!(uppercase_a.is_ascii_alphabetic());
1065 /// assert!(uppercase_g.is_ascii_alphabetic());
1066 /// assert!(a.is_ascii_alphabetic());
1067 /// assert!(g.is_ascii_alphabetic());
1068 /// assert!(!zero.is_ascii_alphabetic());
1069 /// assert!(!percent.is_ascii_alphabetic());
1070 /// assert!(!space.is_ascii_alphabetic());
1071 /// assert!(!lf.is_ascii_alphabetic());
1072 /// assert!(!esc.is_ascii_alphabetic());
1074 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1076 pub fn is_ascii_alphabetic(&self) -> bool {
1077 self.is_ascii() && (*self as u8).is_ascii_alphabetic()
1080 /// Checks if the value is an ASCII uppercase character:
1081 /// U+0041 'A' ..= U+005A 'Z'.
1086 /// let uppercase_a = 'A';
1087 /// let uppercase_g = 'G';
1091 /// let percent = '%';
1092 /// let space = ' ';
1094 /// let esc: char = 0x1b_u8.into();
1096 /// assert!(uppercase_a.is_ascii_uppercase());
1097 /// assert!(uppercase_g.is_ascii_uppercase());
1098 /// assert!(!a.is_ascii_uppercase());
1099 /// assert!(!g.is_ascii_uppercase());
1100 /// assert!(!zero.is_ascii_uppercase());
1101 /// assert!(!percent.is_ascii_uppercase());
1102 /// assert!(!space.is_ascii_uppercase());
1103 /// assert!(!lf.is_ascii_uppercase());
1104 /// assert!(!esc.is_ascii_uppercase());
1106 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1108 pub fn is_ascii_uppercase(&self) -> bool {
1109 self.is_ascii() && (*self as u8).is_ascii_uppercase()
1112 /// Checks if the value is an ASCII lowercase character:
1113 /// U+0061 'a' ..= U+007A 'z'.
1118 /// let uppercase_a = 'A';
1119 /// let uppercase_g = 'G';
1123 /// let percent = '%';
1124 /// let space = ' ';
1126 /// let esc: char = 0x1b_u8.into();
1128 /// assert!(!uppercase_a.is_ascii_lowercase());
1129 /// assert!(!uppercase_g.is_ascii_lowercase());
1130 /// assert!(a.is_ascii_lowercase());
1131 /// assert!(g.is_ascii_lowercase());
1132 /// assert!(!zero.is_ascii_lowercase());
1133 /// assert!(!percent.is_ascii_lowercase());
1134 /// assert!(!space.is_ascii_lowercase());
1135 /// assert!(!lf.is_ascii_lowercase());
1136 /// assert!(!esc.is_ascii_lowercase());
1138 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1140 pub fn is_ascii_lowercase(&self) -> bool {
1141 self.is_ascii() && (*self as u8).is_ascii_lowercase()
1144 /// Checks if the value is an ASCII alphanumeric character:
1146 /// - U+0041 'A' ..= U+005A 'Z', or
1147 /// - U+0061 'a' ..= U+007A 'z', or
1148 /// - U+0030 '0' ..= U+0039 '9'.
1153 /// let uppercase_a = 'A';
1154 /// let uppercase_g = 'G';
1158 /// let percent = '%';
1159 /// let space = ' ';
1161 /// let esc: char = 0x1b_u8.into();
1163 /// assert!(uppercase_a.is_ascii_alphanumeric());
1164 /// assert!(uppercase_g.is_ascii_alphanumeric());
1165 /// assert!(a.is_ascii_alphanumeric());
1166 /// assert!(g.is_ascii_alphanumeric());
1167 /// assert!(zero.is_ascii_alphanumeric());
1168 /// assert!(!percent.is_ascii_alphanumeric());
1169 /// assert!(!space.is_ascii_alphanumeric());
1170 /// assert!(!lf.is_ascii_alphanumeric());
1171 /// assert!(!esc.is_ascii_alphanumeric());
1173 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1175 pub fn is_ascii_alphanumeric(&self) -> bool {
1176 self.is_ascii() && (*self as u8).is_ascii_alphanumeric()
1179 /// Checks if the value is an ASCII decimal digit:
1180 /// U+0030 '0' ..= U+0039 '9'.
1185 /// let uppercase_a = 'A';
1186 /// let uppercase_g = 'G';
1190 /// let percent = '%';
1191 /// let space = ' ';
1193 /// let esc: char = 0x1b_u8.into();
1195 /// assert!(!uppercase_a.is_ascii_digit());
1196 /// assert!(!uppercase_g.is_ascii_digit());
1197 /// assert!(!a.is_ascii_digit());
1198 /// assert!(!g.is_ascii_digit());
1199 /// assert!(zero.is_ascii_digit());
1200 /// assert!(!percent.is_ascii_digit());
1201 /// assert!(!space.is_ascii_digit());
1202 /// assert!(!lf.is_ascii_digit());
1203 /// assert!(!esc.is_ascii_digit());
1205 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1207 pub fn is_ascii_digit(&self) -> bool {
1208 self.is_ascii() && (*self as u8).is_ascii_digit()
1211 /// Checks if the value is an ASCII hexadecimal digit:
1213 /// - U+0030 '0' ..= U+0039 '9', or
1214 /// - U+0041 'A' ..= U+0046 'F', or
1215 /// - U+0061 'a' ..= U+0066 'f'.
1220 /// let uppercase_a = 'A';
1221 /// let uppercase_g = 'G';
1225 /// let percent = '%';
1226 /// let space = ' ';
1228 /// let esc: char = 0x1b_u8.into();
1230 /// assert!(uppercase_a.is_ascii_hexdigit());
1231 /// assert!(!uppercase_g.is_ascii_hexdigit());
1232 /// assert!(a.is_ascii_hexdigit());
1233 /// assert!(!g.is_ascii_hexdigit());
1234 /// assert!(zero.is_ascii_hexdigit());
1235 /// assert!(!percent.is_ascii_hexdigit());
1236 /// assert!(!space.is_ascii_hexdigit());
1237 /// assert!(!lf.is_ascii_hexdigit());
1238 /// assert!(!esc.is_ascii_hexdigit());
1240 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1242 pub fn is_ascii_hexdigit(&self) -> bool {
1243 self.is_ascii() && (*self as u8).is_ascii_hexdigit()
1246 /// Checks if the value is an ASCII punctuation character:
1248 /// - U+0021 ..= U+002F `! " # $ % & ' ( ) * + , - . /`, or
1249 /// - U+003A ..= U+0040 `: ; < = > ? @`, or
1250 /// - U+005B ..= U+0060 ``[ \ ] ^ _ ` ``, or
1251 /// - U+007B ..= U+007E `{ | } ~`
1256 /// let uppercase_a = 'A';
1257 /// let uppercase_g = 'G';
1261 /// let percent = '%';
1262 /// let space = ' ';
1264 /// let esc: char = 0x1b_u8.into();
1266 /// assert!(!uppercase_a.is_ascii_punctuation());
1267 /// assert!(!uppercase_g.is_ascii_punctuation());
1268 /// assert!(!a.is_ascii_punctuation());
1269 /// assert!(!g.is_ascii_punctuation());
1270 /// assert!(!zero.is_ascii_punctuation());
1271 /// assert!(percent.is_ascii_punctuation());
1272 /// assert!(!space.is_ascii_punctuation());
1273 /// assert!(!lf.is_ascii_punctuation());
1274 /// assert!(!esc.is_ascii_punctuation());
1276 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1278 pub fn is_ascii_punctuation(&self) -> bool {
1279 self.is_ascii() && (*self as u8).is_ascii_punctuation()
1282 /// Checks if the value is an ASCII graphic character:
1283 /// U+0021 '!' ..= U+007E '~'.
1288 /// let uppercase_a = 'A';
1289 /// let uppercase_g = 'G';
1293 /// let percent = '%';
1294 /// let space = ' ';
1296 /// let esc: char = 0x1b_u8.into();
1298 /// assert!(uppercase_a.is_ascii_graphic());
1299 /// assert!(uppercase_g.is_ascii_graphic());
1300 /// assert!(a.is_ascii_graphic());
1301 /// assert!(g.is_ascii_graphic());
1302 /// assert!(zero.is_ascii_graphic());
1303 /// assert!(percent.is_ascii_graphic());
1304 /// assert!(!space.is_ascii_graphic());
1305 /// assert!(!lf.is_ascii_graphic());
1306 /// assert!(!esc.is_ascii_graphic());
1308 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1310 pub fn is_ascii_graphic(&self) -> bool {
1311 self.is_ascii() && (*self as u8).is_ascii_graphic()
1314 /// Checks if the value is an ASCII whitespace character:
1315 /// U+0020 SPACE, U+0009 HORIZONTAL TAB, U+000A LINE FEED,
1316 /// U+000C FORM FEED, or U+000D CARRIAGE RETURN.
1318 /// Rust uses the WhatWG Infra Standard's [definition of ASCII
1319 /// whitespace][infra-aw]. There are several other definitions in
1320 /// wide use. For instance, [the POSIX locale][pct] includes
1321 /// U+000B VERTICAL TAB as well as all the above characters,
1322 /// but—from the very same specification—[the default rule for
1323 /// "field splitting" in the Bourne shell][bfs] considers *only*
1324 /// SPACE, HORIZONTAL TAB, and LINE FEED as whitespace.
1326 /// If you are writing a program that will process an existing
1327 /// file format, check what that format's definition of whitespace is
1328 /// before using this function.
1330 /// [infra-aw]: https://infra.spec.whatwg.org/#ascii-whitespace
1331 /// [pct]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap07.html#tag_07_03_01
1332 /// [bfs]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_05
1337 /// let uppercase_a = 'A';
1338 /// let uppercase_g = 'G';
1342 /// let percent = '%';
1343 /// let space = ' ';
1345 /// let esc: char = 0x1b_u8.into();
1347 /// assert!(!uppercase_a.is_ascii_whitespace());
1348 /// assert!(!uppercase_g.is_ascii_whitespace());
1349 /// assert!(!a.is_ascii_whitespace());
1350 /// assert!(!g.is_ascii_whitespace());
1351 /// assert!(!zero.is_ascii_whitespace());
1352 /// assert!(!percent.is_ascii_whitespace());
1353 /// assert!(space.is_ascii_whitespace());
1354 /// assert!(lf.is_ascii_whitespace());
1355 /// assert!(!esc.is_ascii_whitespace());
1357 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1359 pub fn is_ascii_whitespace(&self) -> bool {
1360 self.is_ascii() && (*self as u8).is_ascii_whitespace()
1363 /// Checks if the value is an ASCII control character:
1364 /// U+0000 NUL ..= U+001F UNIT SEPARATOR, or U+007F DELETE.
1365 /// Note that most ASCII whitespace characters are control
1366 /// characters, but SPACE is not.
1371 /// let uppercase_a = 'A';
1372 /// let uppercase_g = 'G';
1376 /// let percent = '%';
1377 /// let space = ' ';
1379 /// let esc: char = 0x1b_u8.into();
1381 /// assert!(!uppercase_a.is_ascii_control());
1382 /// assert!(!uppercase_g.is_ascii_control());
1383 /// assert!(!a.is_ascii_control());
1384 /// assert!(!g.is_ascii_control());
1385 /// assert!(!zero.is_ascii_control());
1386 /// assert!(!percent.is_ascii_control());
1387 /// assert!(!space.is_ascii_control());
1388 /// assert!(lf.is_ascii_control());
1389 /// assert!(esc.is_ascii_control());
1391 #[stable(feature = "ascii_ctype_on_intrinsics", since = "1.24.0")]
1393 pub fn is_ascii_control(&self) -> bool {
1394 self.is_ascii() && (*self as u8).is_ascii_control()