ExemplarCharacters.d.ts (5678B)
1 // generated by diplomat-tool 2 import type { DataError } from "./DataError" 3 import type { DataProvider } from "./DataProvider" 4 import type { Locale } from "./Locale" 5 import type { pointer, codepoint } from "./diplomat-runtime.d.ts"; 6 7 8 /** 9 * A set of "exemplar characters" for a given locale. 10 * 11 * See the [Rust documentation for `locale`](https://docs.rs/icu/latest/icu/locale/index.html) for more information. 12 * 13 * See the [Rust documentation for `ExemplarCharacters`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html) for more information. 14 * 15 * See the [Rust documentation for `ExemplarCharactersBorrowed`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharactersBorrowed.html) for more information. 16 */ 17 18 19 export class ExemplarCharacters { 20 get ffiValue(): pointer; 21 22 23 /** 24 * Checks whether the string is in the set. 25 * 26 * See the [Rust documentation for `contains_str`](https://docs.rs/icu/latest/icu/collections/codepointinvliststringlist/struct.CodePointInversionListAndStringList.html#method.contains_str) for more information. 27 */ 28 containsStr(s: string): boolean; 29 30 /** 31 * Checks whether the code point is in the set. 32 * 33 * See the [Rust documentation for `contains`](https://docs.rs/icu/latest/icu/collections/codepointinvliststringlist/struct.CodePointInversionListAndStringList.html#method.contains) for more information. 34 */ 35 contains(cp: codepoint): boolean; 36 37 /** 38 * Create an [`ExemplarCharacters`] for the "main" set of exemplar characters for a given locale, using compiled data. 39 * 40 * See the [Rust documentation for `try_new_main`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_main) for more information. 41 */ 42 static createMain(locale: Locale): ExemplarCharacters; 43 44 /** 45 * Create an [`ExemplarCharacters`] for the "main" set of exemplar characters for a given locale, using a particular data source 46 * 47 * See the [Rust documentation for `try_new_main`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_main) for more information. 48 */ 49 static createMainWithProvider(provider: DataProvider, locale: Locale): ExemplarCharacters; 50 51 /** 52 * Create an [`ExemplarCharacters`] for the "auxiliary" set of exemplar characters for a given locale, using compiled data. 53 * 54 * See the [Rust documentation for `try_new_auxiliary`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_auxiliary) for more information. 55 */ 56 static createAuxiliary(locale: Locale): ExemplarCharacters; 57 58 /** 59 * Create an [`ExemplarCharacters`] for the "auxiliary" set of exemplar characters for a given locale, using compiled data. 60 * 61 * See the [Rust documentation for `try_new_auxiliary`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_auxiliary) for more information. 62 */ 63 static createAuxiliaryWithProvider(provider: DataProvider, locale: Locale): ExemplarCharacters; 64 65 /** 66 * Create an [`ExemplarCharacters`] for the "punctuation" set of exemplar characters for a given locale, using compiled data. 67 * 68 * See the [Rust documentation for `try_new_punctuation`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_punctuation) for more information. 69 */ 70 static createPunctuation(locale: Locale): ExemplarCharacters; 71 72 /** 73 * Create an [`ExemplarCharacters`] for the "punctuation" set of exemplar characters for a given locale, using compiled data. 74 * 75 * See the [Rust documentation for `try_new_punctuation`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_punctuation) for more information. 76 */ 77 static createPunctuationWithProvider(provider: DataProvider, locale: Locale): ExemplarCharacters; 78 79 /** 80 * Create an [`ExemplarCharacters`] for the "numbers" set of exemplar characters for a given locale, using compiled data. 81 * 82 * See the [Rust documentation for `try_new_numbers`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_numbers) for more information. 83 */ 84 static createNumbers(locale: Locale): ExemplarCharacters; 85 86 /** 87 * Create an [`ExemplarCharacters`] for the "numbers" set of exemplar characters for a given locale, using compiled data. 88 * 89 * See the [Rust documentation for `try_new_numbers`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_numbers) for more information. 90 */ 91 static createNumbersWithProvider(provider: DataProvider, locale: Locale): ExemplarCharacters; 92 93 /** 94 * Create an [`ExemplarCharacters`] for the "index" set of exemplar characters for a given locale, using compiled data. 95 * 96 * See the [Rust documentation for `try_new_index`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_index) for more information. 97 */ 98 static createIndex(locale: Locale): ExemplarCharacters; 99 100 /** 101 * Create an [`ExemplarCharacters`] for the "index" set of exemplar characters for a given locale, using compiled data. 102 * 103 * See the [Rust documentation for `try_new_index`](https://docs.rs/icu/latest/icu/locale/exemplar_chars/struct.ExemplarCharacters.html#method.try_new_index) for more information. 104 */ 105 static createIndexWithProvider(provider: DataProvider, locale: Locale): ExemplarCharacters; 106 }