summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/js/package/docs/source/normalizer_properties_ffi.rst
blob: b8b0a0265fa170589da63aa22cd0dc2fbec9992b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
``normalizer_properties::ffi``
==============================

.. js:class:: ICU4XCanonicalCombiningClassMap

    Lookup of the Canonical_Combining_Class Unicode property

    See the `Rust documentation for CanonicalCombiningClassMap <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalCombiningClassMap.html>`__ for more information.


    .. js:function:: create(provider)

        Construct a new ICU4XCanonicalCombiningClassMap instance for NFC

        See the `Rust documentation for new <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalCombiningClassMap.html#method.new>`__ for more information.


    .. js:method:: get(ch)

        See the `Rust documentation for get <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalCombiningClassMap.html#method.get>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/properties/properties/struct.CanonicalCombiningClass.html>`__


    .. js:method:: get32(ch)

        See the `Rust documentation for get32 <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalCombiningClassMap.html#method.get32>`__ for more information.

        Additional information: `1 <https://docs.rs/icu/latest/icu/properties/properties/struct.CanonicalCombiningClass.html>`__


.. js:class:: ICU4XCanonicalComposition

    The raw canonical composition operation.

    Callers should generally use ICU4XComposingNormalizer unless they specifically need raw composition operations

    See the `Rust documentation for CanonicalComposition <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalComposition.html>`__ for more information.


    .. js:function:: create(provider)

        Construct a new ICU4XCanonicalComposition instance for NFC

        See the `Rust documentation for new <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalComposition.html#method.new>`__ for more information.


    .. js:method:: compose(starter, second)

        Performs canonical composition (including Hangul) on a pair of characters or returns NUL if these characters don’t compose. Composition exclusions are taken into account.

        See the `Rust documentation for compose <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalComposition.html#method.compose>`__ for more information.


.. js:class:: ICU4XCanonicalDecomposition

    The raw (non-recursive) canonical decomposition operation.

    Callers should generally use ICU4XDecomposingNormalizer unless they specifically need raw composition operations

    See the `Rust documentation for CanonicalDecomposition <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalDecomposition.html>`__ for more information.


    .. js:function:: create(provider)

        Construct a new ICU4XCanonicalDecomposition instance for NFC

        See the `Rust documentation for new <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalDecomposition.html#method.new>`__ for more information.


    .. js:method:: decompose(c)

        Performs non-recursive canonical decomposition (including for Hangul).

        See the `Rust documentation for decompose <https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalDecomposition.html#method.decompose>`__ for more information.


.. js:class:: ICU4XDecomposed

    The outcome of non-recursive canonical decomposition of a character. ``second`` will be NUL when the decomposition expands to a single character (which may or may not be the original one)

    See the `Rust documentation for Decomposed <https://docs.rs/icu/latest/icu/normalizer/properties/enum.Decomposed.html>`__ for more information.


    .. js:attribute:: first

    .. js:attribute:: second