CodePointMapData8.d.ts (11473B)
1 // generated by diplomat-tool 2 import type { CodePointRangeIterator } from "./CodePointRangeIterator" 3 import type { CodePointSetData } from "./CodePointSetData" 4 import type { DataError } from "./DataError" 5 import type { DataProvider } from "./DataProvider" 6 import type { GeneralCategoryGroup } from "./GeneralCategoryGroup" 7 import type { GeneralCategoryGroup_obj } from "./GeneralCategoryGroup" 8 import type { pointer, codepoint } from "./diplomat-runtime.d.ts"; 9 10 11 /** 12 * 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. 13 * 14 * For properties whose values fit into 8 bits. 15 * 16 * See the [Rust documentation for `properties`](https://docs.rs/icu/latest/icu/properties/index.html) for more information. 17 * 18 * See the [Rust documentation for `CodePointMapData`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapData.html) for more information. 19 * 20 * See the [Rust documentation for `CodePointMapDataBorrowed`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapDataBorrowed.html) for more information. 21 */ 22 23 24 export class CodePointMapData8 { 25 get ffiValue(): pointer; 26 27 28 /** 29 * Gets the value for a code point. 30 * 31 * See the [Rust documentation for `get`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapDataBorrowed.html#method.get) for more information. 32 */ 33 get(cp: codepoint): number; 34 35 /** 36 * Produces an iterator over ranges of code points that map to `value` 37 * 38 * See the [Rust documentation for `iter_ranges_for_value`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapDataBorrowed.html#method.iter_ranges_for_value) for more information. 39 */ 40 iterRangesForValue(value: number): CodePointRangeIterator; 41 42 /** 43 * Produces an iterator over ranges of code points that do not map to `value` 44 * 45 * See the [Rust documentation for `iter_ranges_for_value_complemented`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapDataBorrowed.html#method.iter_ranges_for_value_complemented) for more information. 46 */ 47 iterRangesForValueComplemented(value: number): CodePointRangeIterator; 48 49 /** 50 * Given a mask value (the nth bit marks property value = n), produce an iterator over ranges of code points 51 * whose property values are contained in the mask. 52 * 53 * The main mask property supported is that for General_Category, which can be obtained via `general_category_to_mask()` or 54 * by using `GeneralCategoryNameToMaskMapper` 55 * 56 * Should only be used on maps for properties with values less than 32 (like Generak_Category), 57 * other maps will have unpredictable results 58 * 59 * See the [Rust documentation for `iter_ranges_for_group`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapDataBorrowed.html#method.iter_ranges_for_group) for more information. 60 */ 61 iterRangesForGroup(group: GeneralCategoryGroup_obj): CodePointRangeIterator; 62 63 /** 64 * Gets a [`CodePointSetData`] representing all entries in this map that map to the given value 65 * 66 * See the [Rust documentation for `get_set_for_value`](https://docs.rs/icu/latest/icu/properties/struct.CodePointMapDataBorrowed.html#method.get_set_for_value) for more information. 67 */ 68 getSetForValue(value: number): CodePointSetData; 69 70 /** 71 * Create a map for the `General_Category` property, using compiled data. 72 * 73 * See the [Rust documentation for `GeneralCategory`](https://docs.rs/icu/latest/icu/properties/props/enum.GeneralCategory.html) for more information. 74 */ 75 static createGeneralCategory(): CodePointMapData8; 76 77 /** 78 * Create a map for the `General_Category` property, using a particular data source 79 * 80 * See the [Rust documentation for `GeneralCategory`](https://docs.rs/icu/latest/icu/properties/props/enum.GeneralCategory.html) for more information. 81 */ 82 static createGeneralCategoryWithProvider(provider: DataProvider): CodePointMapData8; 83 84 /** 85 * Create a map for the `Bidi_Class` property, using compiled data. 86 * 87 * See the [Rust documentation for `BidiClass`](https://docs.rs/icu/latest/icu/properties/props/struct.BidiClass.html) for more information. 88 */ 89 static createBidiClass(): CodePointMapData8; 90 91 /** 92 * Create a map for the `Bidi_Class` property, using a particular data source. 93 * 94 * See the [Rust documentation for `BidiClass`](https://docs.rs/icu/latest/icu/properties/props/struct.BidiClass.html) for more information. 95 */ 96 static createBidiClassWithProvider(provider: DataProvider): CodePointMapData8; 97 98 /** 99 * Create a map for the `East_Asian_Width` property, using compiled data. 100 * 101 * See the [Rust documentation for `EastAsianWidth`](https://docs.rs/icu/latest/icu/properties/props/struct.EastAsianWidth.html) for more information. 102 */ 103 static createEastAsianWidth(): CodePointMapData8; 104 105 /** 106 * Create a map for the `East_Asian_Width` property, using a particular data source. 107 * 108 * See the [Rust documentation for `EastAsianWidth`](https://docs.rs/icu/latest/icu/properties/props/struct.EastAsianWidth.html) for more information. 109 */ 110 static createEastAsianWidthWithProvider(provider: DataProvider): CodePointMapData8; 111 112 /** 113 * Create a map for the `Hangul_Syllable_Type` property, using compiled data. 114 * 115 * See the [Rust documentation for `HangulSyllableType`](https://docs.rs/icu/latest/icu/properties/props/struct.HangulSyllableType.html) for more information. 116 */ 117 static createHangulSyllableType(): CodePointMapData8; 118 119 /** 120 * Create a map for the `Hangul_Syllable_Type` property, using a particular data source. 121 * 122 * See the [Rust documentation for `HangulSyllableType`](https://docs.rs/icu/latest/icu/properties/props/struct.HangulSyllableType.html) for more information. 123 */ 124 static createHangulSyllableTypeWithProvider(provider: DataProvider): CodePointMapData8; 125 126 /** 127 * Create a map for the `Indic_Syllabic_Property` property, using compiled data. 128 * 129 * See the [Rust documentation for `IndicSyllabicCategory`](https://docs.rs/icu/latest/icu/properties/props/struct.IndicSyllabicCategory.html) for more information. 130 */ 131 static createIndicSyllabicCategory(): CodePointMapData8; 132 133 /** 134 * Create a map for the `Indic_Syllabic_Property` property, using a particular data source. 135 * 136 * See the [Rust documentation for `IndicSyllabicCategory`](https://docs.rs/icu/latest/icu/properties/props/struct.IndicSyllabicCategory.html) for more information. 137 */ 138 static createIndicSyllabicCategoryWithProvider(provider: DataProvider): CodePointMapData8; 139 140 /** 141 * Create a map for the `Line_Break` property, using compiled data. 142 * 143 * See the [Rust documentation for `LineBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.LineBreak.html) for more information. 144 */ 145 static createLineBreak(): CodePointMapData8; 146 147 /** 148 * Create a map for the `Line_Break` property, using a particular data source. 149 * 150 * See the [Rust documentation for `LineBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.LineBreak.html) for more information. 151 */ 152 static createLineBreakWithProvider(provider: DataProvider): CodePointMapData8; 153 154 /** 155 * Create a map for the `Grapheme_Cluster_Break` property, using compiled data. 156 * 157 * See the [Rust documentation for `GraphemeClusterBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.GraphemeClusterBreak.html) for more information. 158 */ 159 static createGraphemeClusterBreak(): CodePointMapData8; 160 161 /** 162 * Create a map for the `Grapheme_Cluster_Break` property, using a particular data source. 163 * 164 * See the [Rust documentation for `GraphemeClusterBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.GraphemeClusterBreak.html) for more information. 165 */ 166 static createGraphemeClusterBreakWithProvider(provider: DataProvider): CodePointMapData8; 167 168 /** 169 * Create a map for the `Word_Break` property, using compiled data. 170 * 171 * See the [Rust documentation for `WordBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.WordBreak.html) for more information. 172 */ 173 static createWordBreak(): CodePointMapData8; 174 175 /** 176 * Create a map for the `Word_Break` property, using a particular data source. 177 * 178 * See the [Rust documentation for `WordBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.WordBreak.html) for more information. 179 */ 180 static createWordBreakWithProvider(provider: DataProvider): CodePointMapData8; 181 182 /** 183 * Create a map for the `Sentence_Break` property, using compiled data. 184 * 185 * See the [Rust documentation for `SentenceBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.SentenceBreak.html) for more information. 186 */ 187 static createSentenceBreak(): CodePointMapData8; 188 189 /** 190 * Create a map for the `Sentence_Break` property, using a particular data source. 191 * 192 * See the [Rust documentation for `SentenceBreak`](https://docs.rs/icu/latest/icu/properties/props/struct.SentenceBreak.html) for more information. 193 */ 194 static createSentenceBreakWithProvider(provider: DataProvider): CodePointMapData8; 195 196 /** 197 * Create a map for the `Joining_Type` property, using compiled data. 198 * 199 * See the [Rust documentation for `JoiningType`](https://docs.rs/icu/latest/icu/properties/props/struct.JoiningType.html) for more information. 200 */ 201 static createJoiningType(): CodePointMapData8; 202 203 /** 204 * Create a map for the `Joining_Type` property, using a particular data source. 205 * 206 * See the [Rust documentation for `JoiningType`](https://docs.rs/icu/latest/icu/properties/props/struct.JoiningType.html) for more information. 207 */ 208 static createJoiningTypeWithProvider(provider: DataProvider): CodePointMapData8; 209 210 /** 211 * Create a map for the `Canonical_Combining_Class` property, using compiled data. 212 * 213 * See the [Rust documentation for `CanonicalCombiningClass`](https://docs.rs/icu/latest/icu/properties/props/struct.CanonicalCombiningClass.html) for more information. 214 */ 215 static createCanonicalCombiningClass(): CodePointMapData8; 216 217 /** 218 * Create a map for the `Canonical_Combining_Class` property, using a particular data source. 219 * 220 * See the [Rust documentation for `CanonicalCombiningClass`](https://docs.rs/icu/latest/icu/properties/props/struct.CanonicalCombiningClass.html) for more information. 221 */ 222 static createCanonicalCombiningClassWithProvider(provider: DataProvider): CodePointMapData8; 223 224 /** 225 * Create a map for the `Vertical_Orientation` property, using compiled data. 226 * 227 * See the [Rust documentation for `VerticalOrientation`](https://docs.rs/icu/latest/icu/properties/props/struct.VerticalOrientation.html) for more information. 228 */ 229 static createVerticalOrientation(): CodePointMapData8; 230 231 /** 232 * Create a map for the `Vertical_Orientation` property, using a particular data source. 233 * 234 * See the [Rust documentation for `VerticalOrientation`](https://docs.rs/icu/latest/icu/properties/props/struct.VerticalOrientation.html) for more information. 235 */ 236 static createVerticalOrientationWithProvider(provider: DataProvider): CodePointMapData8; 237 }