diff options
Diffstat (limited to 'intl/icu_capi/js/package/docs/source/properties_names_ffi.rst')
-rw-r--r-- | intl/icu_capi/js/package/docs/source/properties_names_ffi.rst | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/intl/icu_capi/js/package/docs/source/properties_names_ffi.rst b/intl/icu_capi/js/package/docs/source/properties_names_ffi.rst new file mode 100644 index 0000000000..b500224c46 --- /dev/null +++ b/intl/icu_capi/js/package/docs/source/properties_names_ffi.rst @@ -0,0 +1,102 @@ +``properties_names::ffi`` +========================= + +.. js:class:: ICU4XGeneralCategoryNameToMaskMapper + + A type capable of looking up General Category mask values from a string name. + + See the `Rust documentation for get_name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.GeneralCategoryGroup.html#method.get_name_to_enum_mapper>`__ for more information. + + See the `Rust documentation for PropertyValueNameToEnumMapper <https://docs.rs/icu/latest/icu/properties/names/struct.PropertyValueNameToEnumMapper.html>`__ for more information. + + + .. js:method:: get_strict(name) + + Get the mask value matching the given name, using strict matching + + Returns 0 if the name is unknown for this property + + + .. js:method:: get_loose(name) + + Get the mask value matching the given name, using loose matching + + Returns 0 if the name is unknown for this property + + + .. js:function:: load(provider) + + See the `Rust documentation for get_name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.GeneralCategoryGroup.html#method.get_name_to_enum_mapper>`__ for more information. + + +.. js:class:: ICU4XPropertyValueNameToEnumMapper + + A type capable of looking up a property value from a string name. + + See the `Rust documentation for PropertyValueNameToEnumMapper <https://docs.rs/icu/latest/icu/properties/names/struct.PropertyValueNameToEnumMapper.html>`__ for more information. + + See the `Rust documentation for PropertyValueNameToEnumMapperBorrowed <https://docs.rs/icu/latest/icu/properties/names/struct.PropertyValueNameToEnumMapperBorrowed.html>`__ for more information. + + + .. js:method:: get_strict(name) + + Get the property value matching the given name, using strict matching + + Returns -1 if the name is unknown for this property + + See the `Rust documentation for get_strict <https://docs.rs/icu/latest/icu/properties/names/struct.PropertyValueNameToEnumMapperBorrowed.html#method.get_strict>`__ for more information. + + + .. js:method:: get_loose(name) + + Get the property value matching the given name, using loose matching + + Returns -1 if the name is unknown for this property + + See the `Rust documentation for get_loose <https://docs.rs/icu/latest/icu/properties/names/struct.PropertyValueNameToEnumMapperBorrowed.html#method.get_loose>`__ for more information. + + + .. js:function:: load_general_category(provider) + + See the `Rust documentation for get_name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.GeneralCategory.html#method.get_name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_bidi_class(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.BidiClass.html#method.name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_east_asian_width(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.EastAsianWidth.html#method.name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_indic_syllabic_category(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.IndicSyllabicCategory.html#method.name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_line_break(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.LineBreak.html#method.name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_grapheme_cluster_break(provider) + + See the `Rust documentation for get_name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.GraphemeClusterBreak.html#method.get_name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_word_break(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.WordBreak.html#method.name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_sentence_break(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.SentenceBreak.html#method.name_to_enum_mapper>`__ for more information. + + + .. js:function:: load_script(provider) + + See the `Rust documentation for name_to_enum_mapper <https://docs.rs/icu/latest/icu/properties/struct.Script.html#method.name_to_enum_mapper>`__ for more information. + |