Expand description
The functions in this module return a CodePointSetData containing
the set of characters with a particular Unicode property.
The descriptions of most properties are taken from TR44, the documentation for the
Unicode Character Database. Some properties are instead defined in TR18, the
documentation for Unicode regular expressions. In particular, Annex C of this document
defines properties for POSIX compatibility.
Structs§
- Code
Point SetData - A wrapper around code point set data. It is returned by APIs that return Unicode
property data in a set-like form, ex: a set of code points sharing the same
value for a Unicode property. Access its data via the borrowed version,
CodePointSetDataBorrowed. - Code
Point SetData Borrowed - A borrowed wrapper around code point set data, returned by
CodePointSetData::as_borrowed(). More efficient to query. - Unicode
SetData - A wrapper around
UnicodeSetdata (characters and strings) - Unicode
SetData Borrowed - A borrowed wrapper around code point set data, returned by
UnicodeSetData::as_borrowed(). More efficient to query.
Functions§
- alnum
- Characters with the Alphabetic or Decimal_Number property This is defined for POSIX compatibility.
- alphabetic
- Alphabetic characters
- ascii_
hex_ digit - ASCII characters commonly used for the representation of hexadecimal numbers
- basic_
emoji - Characters and character sequences intended for general-purpose, independent, direct input.
See
Unicode Technical Standard #51for more details. - bidi_
control - Format control characters which have specific functions in the Unicode Bidirectional Algorithm
- bidi_
mirrored - Characters that are mirrored in bidirectional text
- blank
- Horizontal whitespace characters
- case_
ignorable - Characters which are ignored for casing purposes
- case_
sensitive - Characters that are either the source of a case mapping or in the target of a case mapping
- cased
- Uppercase, lowercase, and titlecase characters
- changes_
when_ casefolded - Characters whose normalized forms are not stable under case folding
- changes_
when_ casemapped - Characters which may change when they undergo case mapping
- changes_
when_ lowercased - Characters whose normalized forms are not stable under a toLowercase mapping
- changes_
when_ nfkc_ casefolded - Characters which are not identical to their NFKC_Casefold mapping
- changes_
when_ titlecased - Characters whose normalized forms are not stable under a toTitlecase mapping
- changes_
when_ uppercased - Characters whose normalized forms are not stable under a toUppercase mapping
- dash
- Punctuation characters explicitly called out as dashes in the Unicode Standard, plus their compatibility equivalents
- default_
ignorable_ code_ point - For programmatic determination of default ignorable code points. New characters that should be ignored in rendering (unless explicitly supported) will be assigned in these ranges, permitting programs to correctly handle the default rendering of such characters when not otherwise supported.
- deprecated
- Deprecated characters. No characters will ever be removed from the standard, but the usage of deprecated characters is strongly discouraged.
- diacritic
- Characters that linguistically modify the meaning of another character to which they apply
- emoji
- Characters that are emoji
- emoji_
component - Characters used in emoji sequences that normally do not appear on emoji keyboards as separate choices, such as base characters for emoji keycaps
- emoji_
modifier - Characters that are emoji modifiers
- emoji_
modifier_ base - Characters that can serve as a base for emoji modifiers
- emoji_
presentation - Characters that have emoji presentation by default
- extended_
pictographic - Pictographic symbols, as well as reserved ranges in blocks largely associated with emoji characters
- extender
- Characters whose principal function is to extend the value of a preceding alphabetic character or to extend the shape of adjacent characters.
- for_
general_ category_ group - Return a
CodePointSetDatafor a value or a grouping of values of the General_Category property. SeeGeneralCategoryGroup. - full_
composition_ exclusion - Characters that are excluded from composition See https://unicode.org/Public/UNIDATA/CompositionExclusions.txt
- graph
- Visible characters. This is defined for POSIX compatibility.
- grapheme_
base - Property used together with the definition of Standard Korean Syllable Block to define “Grapheme base”. See D58 in Chapter 3, Conformance in the Unicode Standard.
- grapheme_
extend - Property used to define “Grapheme extender”. See D59 in Chapter 3, Conformance in the Unicode Standard.
- grapheme_
link - Deprecated property. Formerly proposed for programmatic determination of grapheme cluster boundaries.
- hex_
digit - Characters commonly used for the representation of hexadecimal numbers, plus their compatibility equivalents
- hyphen
- Deprecated property. Dashes which are used to mark connections between pieces of words, plus the Katakana middle dot.
- id_
continue - Characters that can come after the first character in an identifier. If using NFKC to
fold differences between characters, use
load_xid_continueinstead. SeeUnicode Standard Annex #31for more details. - id_
start - Characters that can begin an identifier. If using NFKC to fold differences between
characters, use
load_xid_startinstead. SeeUnicode Standard Annex #31for more details. - ideographic
- Characters considered to be CJKV (Chinese, Japanese, Korean, and Vietnamese) ideographs, or related siniform ideographs
- ids_
binary_ operator - Characters used in Ideographic Description Sequences
- ids_
trinary_ operator - Characters used in Ideographic Description Sequences
- join_
control - Format control characters which have specific functions for control of cursive joining and ligation
- load_
alnum - A version of
alnum()that uses custom data provided by aDataProvider. - load_
alphabetic - A version of
alphabetic()that uses custom data provided by aDataProvider. - load_
ascii_ hex_ digit - A version of
ascii_hex_digit()that uses custom data provided by aDataProvider. - load_
basic_ emoji - A version of
basic_emoji()that uses custom data provided by aDataProvider. - load_
bidi_ control - A version of
bidi_control()that uses custom data provided by aDataProvider. - load_
bidi_ mirrored - A version of
bidi_mirrored()that uses custom data provided by aDataProvider. - load_
blank - A version of
blank()that uses custom data provided by aDataProvider. - load_
case_ ignorable - A version of
case_ignorable()that uses custom data provided by aDataProvider. - load_
case_ sensitive - A version of
case_sensitive()that uses custom data provided by aDataProvider. - load_
cased - A version of
cased()that uses custom data provided by aDataProvider. - load_
changes_ when_ casefolded - A version of
changes_when_casefolded()that uses custom data provided by aDataProvider. - load_
changes_ when_ casemapped - A version of
changes_when_casemapped()that uses custom data provided by aDataProvider. - load_
changes_ when_ lowercased - A version of
changes_when_lowercased()that uses custom data provided by aDataProvider. - load_
changes_ when_ nfkc_ casefolded - A version of
changes_when_nfkc_casefolded()that uses custom data provided by aDataProvider. - load_
changes_ when_ titlecased - A version of
changes_when_titlecased()that uses custom data provided by aDataProvider. - load_
changes_ when_ uppercased - A version of
changes_when_uppercased()that uses custom data provided by aDataProvider. - load_
dash - A version of
dash()that uses custom data provided by aDataProvider. - load_
default_ ignorable_ code_ point - A version of
default_ignorable_code_point()that uses custom data provided by aDataProvider. - load_
deprecated - A version of
deprecated()that uses custom data provided by aDataProvider. - load_
diacritic - A version of
diacritic()that uses custom data provided by aDataProvider. - load_
emoji - A version of
emoji()that uses custom data provided by aDataProvider. - load_
emoji_ component - A version of
emoji_component()that uses custom data provided by aDataProvider. - load_
emoji_ modifier - A version of
emoji_modifier()that uses custom data provided by aDataProvider. - load_
emoji_ modifier_ base - A version of
emoji_modifier_base()that uses custom data provided by aDataProvider. - load_
emoji_ presentation - A version of
emoji_presentation()that uses custom data provided by aDataProvider. - load_
extended_ pictographic - A version of
extended_pictographic()that uses custom data provided by aDataProvider. - load_
extender - A version of
extender()that uses custom data provided by aDataProvider. - load_
for_ ecma262 - Returns a type capable of looking up values for a property specified as a string, as long as it is a binary property listed in ECMA-262, using strict matching on the names in the spec.
- load_
for_ ecma262_ unstable - A version of
load_for_ecma262that uses custom data provided by aDataProvider. - load_
for_ ecma262_ with_ any_ provider - A version of
load_for_ecma262that uses custom data provided by anAnyProvider. - load_
for_ general_ category_ group - A version of
for_general_category_group()that uses custom data provided by aDataProvider. - load_
full_ composition_ exclusion - A version of
full_composition_exclusion()that uses custom data provided by aDataProvider. - load_
graph - A version of
graph()that uses custom data provided by aDataProvider. - load_
grapheme_ base - A version of
grapheme_base()that uses custom data provided by aDataProvider. - load_
grapheme_ extend - A version of
grapheme_extend()that uses custom data provided by aDataProvider. - load_
grapheme_ link - A version of
grapheme_link()that uses custom data provided by aDataProvider. - load_
hex_ digit - A version of
hex_digit()that uses custom data provided by aDataProvider. - load_
hyphen - A version of
hyphen()that uses custom data provided by aDataProvider. - load_
id_ continue - A version of
id_continue()that uses custom data provided by aDataProvider. - load_
id_ start - A version of
id_start()that uses custom data provided by aDataProvider. - load_
ideographic - A version of
ideographic()that uses custom data provided by aDataProvider. - load_
ids_ binary_ operator - A version of
ids_binary_operator()that uses custom data provided by aDataProvider. - load_
ids_ trinary_ operator - A version of
ids_trinary_operator()that uses custom data provided by aDataProvider. - load_
join_ control - A version of
join_control()that uses custom data provided by aDataProvider. - load_
logical_ order_ exception - A version of
logical_order_exception()that uses custom data provided by aDataProvider. - load_
lowercase - A version of
lowercase()that uses custom data provided by aDataProvider. - load_
math - A version of
math()that uses custom data provided by aDataProvider. - load_
nfc_ inert - A version of
nfc_inert()that uses custom data provided by aDataProvider. - load_
nfd_ inert - A version of
nfd_inert()that uses custom data provided by aDataProvider. - load_
nfkc_ inert - A version of
nfkc_inert()that uses custom data provided by aDataProvider. - load_
nfkd_ inert - A version of
nfkd_inert()that uses custom data provided by aDataProvider. - load_
noncharacter_ code_ point - A version of
noncharacter_code_point()that uses custom data provided by aDataProvider. - load_
pattern_ syntax - A version of
pattern_syntax()that uses custom data provided by aDataProvider. - load_
pattern_ white_ space - A version of
pattern_white_space()that uses custom data provided by aDataProvider. - load_
prepended_ concatenation_ mark - A version of
prepended_concatenation_mark()that uses custom data provided by aDataProvider. - load_
print - A version of
print()that uses custom data provided by aDataProvider. - load_
quotation_ mark - A version of
quotation_mark()that uses custom data provided by aDataProvider. - load_
radical - A version of
radical()that uses custom data provided by aDataProvider. - load_
regional_ indicator - A version of
regional_indicator()that uses custom data provided by aDataProvider. - load_
segment_ starter - A version of
segment_starter()that uses custom data provided by aDataProvider. - load_
sentence_ terminal - A version of
sentence_terminal()that uses custom data provided by aDataProvider. - load_
soft_ dotted - A version of
soft_dotted()that uses custom data provided by aDataProvider. - load_
terminal_ punctuation - A version of
terminal_punctuation()that uses custom data provided by aDataProvider. - load_
unified_ ideograph - A version of
unified_ideograph()that uses custom data provided by aDataProvider. - load_
uppercase - A version of
uppercase()that uses custom data provided by aDataProvider. - load_
variation_ selector - A version of
variation_selector()that uses custom data provided by aDataProvider. - load_
white_ space - A version of
white_space()that uses custom data provided by aDataProvider. - load_
xdigit - A version of
xdigit()that uses custom data provided by aDataProvider. - load_
xid_ continue - A version of
xid_continue()that uses custom data provided by aDataProvider. - load_
xid_ start - A version of
xid_start()that uses custom data provided by aDataProvider. - logical_
order_ exception - A small number of spacing vowel letters occurring in certain Southeast Asian scripts such as Thai and Lao
- lowercase
- Lowercase characters
- math
- Characters used in mathematical notation
- nfc_
inert - Characters that are inert under NFC, i.e., they do not interact with adjacent characters
- nfd_
inert - Characters that are inert under NFD, i.e., they do not interact with adjacent characters
- nfkc_
inert - Characters that are inert under NFKC, i.e., they do not interact with adjacent characters
- nfkd_
inert - Characters that are inert under NFKD, i.e., they do not interact with adjacent characters
- noncharacter_
code_ point - Code points permanently reserved for internal use
- pattern_
syntax - Characters used as syntax in patterns (such as regular expressions). See
Unicode Standard Annex #31for more details. - pattern_
white_ space - Characters used as whitespace in patterns (such as regular expressions). See
Unicode Standard Annex #31for more details. - prepended_
concatenation_ mark - A small class of visible format controls, which precede and then span a sequence of other characters, usually digits.
- Printable characters (visible characters and whitespace). This is defined for POSIX compatibility.
- quotation_
mark - Punctuation characters that function as quotation marks.
- radical
- Characters used in the definition of Ideographic Description Sequences
- regional_
indicator - Regional indicator characters, U+1F1E6..U+1F1FF
- segment_
starter - Characters that are starters in terms of Unicode normalization and combining character sequences
- sentence_
terminal - Punctuation characters that generally mark the end of sentences
- soft_
dotted - Characters with a “soft dot”, like i or j. An accent placed on these characters causes the dot to disappear.
- terminal_
punctuation - Punctuation characters that generally mark the end of textual units
- unified_
ideograph - A property which specifies the exact set of Unified CJK Ideographs in the standard
- uppercase
- Uppercase characters
- variation_
selector - Characters that are Variation Selectors.
- white_
space - Spaces, separator characters and other control characters which should be treated by programming languages as “white space” for the purpose of parsing elements
- xdigit
- Hexadecimal digits This is defined for POSIX compatibility.
- xid_
continue - Characters that can come after the first character in an identifier. See
Unicode Standard Annex #31for more details. - xid_
start - Characters that can begin an identifier. See
Unicode Standard Annex #31for more details.