ICU4X
International Components for Unicode
Loading...
Searching...
No Matches
ICU4XCodePointMapData8 Class Reference

#include <ICU4XCodePointMapData8.hpp>

Public Member Functions

uint8_t get (char32_t cp) const
 
uint8_t get32 (uint32_t cp) const
 
CodePointRangeIterator iter_ranges_for_value (uint8_t value) const
 
CodePointRangeIterator iter_ranges_for_value_complemented (uint8_t value) const
 
CodePointRangeIterator iter_ranges_for_mask (uint32_t mask) const
 
ICU4XCodePointSetData get_set_for_value (uint8_t value) const
 
 ICU4XCodePointMapData8 (capi::ICU4XCodePointMapData8 *i)
 
 ICU4XCodePointMapData8 ()=default
 
 ICU4XCodePointMapData8 (ICU4XCodePointMapData8 &&) noexcept=default
 
ICU4XCodePointMapData8operator= (ICU4XCodePointMapData8 &&other) noexcept=default
 

Static Public Member Functions

static uint32_t general_category_to_mask (uint8_t gc)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_general_category (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_bidi_class (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_east_asian_width (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_hangul_syllable_type (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_indic_syllabic_category (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_line_break (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrortry_grapheme_cluster_break (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_word_break (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_sentence_break (const ICU4XDataProvider &provider)
 
static diplomat::result< ICU4XCodePointMapData8, ICU4XErrorload_joining_type (const ICU4XDataProvider &provider)
 

Detailed Description

An ICU4X Unicode Map Property object, capable of querying whether a code point (key) to obtain the Unicode property value, for a specific Unicode property.

For properties whose values fit into 8 bits.

See the Rust documentation for properties for more information.

See the Rust documentation for CodePointMapData for more information.

See the Rust documentation for CodePointMapDataBorrowed for more information.

Constructor & Destructor Documentation

◆ ICU4XCodePointMapData8() [1/3]

ICU4XCodePointMapData8::ICU4XCodePointMapData8 ( capi::ICU4XCodePointMapData8 * i)
inlineexplicit

◆ ICU4XCodePointMapData8() [2/3]

ICU4XCodePointMapData8::ICU4XCodePointMapData8 ( )
default

◆ ICU4XCodePointMapData8() [3/3]

ICU4XCodePointMapData8::ICU4XCodePointMapData8 ( ICU4XCodePointMapData8 && )
defaultnoexcept

Member Function Documentation

◆ general_category_to_mask()

uint32_t ICU4XCodePointMapData8::general_category_to_mask ( uint8_t gc)
inlinestatic

Converts a general category to its corresponding mask value

Nonexistent general categories will map to the empty mask

See the Rust documentation for GeneralCategoryGroup for more information.

◆ get()

uint8_t ICU4XCodePointMapData8::get ( char32_t cp) const
inline

Gets the value for a code point.

See the Rust documentation for get for more information.

◆ get32()

uint8_t ICU4XCodePointMapData8::get32 ( uint32_t cp) const
inline

Gets the value for a code point (specified as a 32 bit integer, in UTF-32)

◆ get_set_for_value()

ICU4XCodePointSetData ICU4XCodePointMapData8::get_set_for_value ( uint8_t value) const
inline

Gets a [ICU4XCodePointSetData] representing all entries in this map that map to the given value

See the Rust documentation for get_set_for_value for more information.

◆ iter_ranges_for_mask()

CodePointRangeIterator ICU4XCodePointMapData8::iter_ranges_for_mask ( uint32_t mask) const
inline

Given a mask value (the nth bit marks property value = n), produce an iterator over ranges of code points whose property values are contained in the mask.

The main mask property supported is that for General_Category, which can be obtained via general_category_to_mask() or by using ICU4XGeneralCategoryNameToMaskMapper

Should only be used on maps for properties with values less than 32 (like Generak_Category), other maps will have unpredictable results

See the Rust documentation for iter_ranges_for_group for more information.

Lifetimes: this must live at least as long as the output.

◆ iter_ranges_for_value()

CodePointRangeIterator ICU4XCodePointMapData8::iter_ranges_for_value ( uint8_t value) const
inline

Produces an iterator over ranges of code points that map to value

See the Rust documentation for iter_ranges_for_value for more information.

Lifetimes: this must live at least as long as the output.

◆ iter_ranges_for_value_complemented()

CodePointRangeIterator ICU4XCodePointMapData8::iter_ranges_for_value_complemented ( uint8_t value) const
inline

Produces an iterator over ranges of code points that do not map to value

See the Rust documentation for iter_ranges_for_value_complemented for more information.

Lifetimes: this must live at least as long as the output.

◆ load_bidi_class()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_bidi_class ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for bidi_class for more information.

◆ load_east_asian_width()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_east_asian_width ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for east_asian_width for more information.

◆ load_general_category()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_general_category ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for general_category for more information.

◆ load_hangul_syllable_type()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_hangul_syllable_type ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for hangul_syllable_type for more information.

◆ load_indic_syllabic_category()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_indic_syllabic_category ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for indic_syllabic_category for more information.

◆ load_joining_type()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_joining_type ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for joining_type for more information.

◆ load_line_break()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_line_break ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for line_break for more information.

◆ load_sentence_break()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_sentence_break ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for sentence_break for more information.

◆ load_word_break()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::load_word_break ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for word_break for more information.

◆ operator=()

ICU4XCodePointMapData8 & ICU4XCodePointMapData8::operator= ( ICU4XCodePointMapData8 && other)
defaultnoexcept

◆ try_grapheme_cluster_break()

diplomat::result< ICU4XCodePointMapData8, ICU4XError > ICU4XCodePointMapData8::try_grapheme_cluster_break ( const ICU4XDataProvider & provider)
inlinestatic

See the Rust documentation for grapheme_cluster_break for more information.


The documentation for this class was generated from the following file: