summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/cpp/docs/source/script_ffi.rst
blob: a6c06879e20e3d6e5b5112724da46ad18a309639 (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
``script::ffi``
===============

.. cpp:class:: ICU4XScriptExtensionsSet

    An object that represents the Script_Extensions property for a single character

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


    .. cpp:function:: bool contains(uint16_t script) const

        Check if the Script_Extensions property of the given code point covers the given script

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


    .. cpp:function:: size_t count() const

        Get the number of scripts contained in here

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


    .. cpp:function:: diplomat::result<uint16_t, std::monostate> script_at(size_t index) const

        Get script at index, returning an error if out of bounds

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


.. cpp:class:: ICU4XScriptWithExtensions

    An ICU4X ScriptWithExtensions map object, capable of holding a map of codepoints to scriptextensions values

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


    .. cpp:function:: static diplomat::result<ICU4XScriptWithExtensions, ICU4XError> create(const ICU4XDataProvider& provider)

        See the `Rust documentation for script_with_extensions <https://docs.rs/icu/latest/icu/properties/script/fn.script_with_extensions.html>`__ for more information.


    .. cpp:function:: uint16_t get_script_val(uint32_t code_point) const

        Get the Script property value for a code point

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


    .. cpp:function:: bool has_script(uint32_t code_point, uint16_t script) const

        Check if the Script_Extensions property of the given code point covers the given script

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


    .. cpp:function:: ICU4XScriptWithExtensionsBorrowed as_borrowed() const

        Borrow this object for a slightly faster variant with more operations

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

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


    .. cpp:function:: CodePointRangeIterator iter_ranges_for_script(uint16_t script) const

        Get a list of ranges of code points that contain this script in their Script_Extensions values

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

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


.. cpp:class:: ICU4XScriptWithExtensionsBorrowed

    A slightly faster ICU4XScriptWithExtensions object

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


    .. cpp:function:: uint16_t get_script_val(uint32_t code_point) const

        Get the Script property value for a code point

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


    .. cpp:function:: ICU4XScriptExtensionsSet get_script_extensions_val(uint32_t code_point) const

        Get the Script property value for a code point

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

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


    .. cpp:function:: bool has_script(uint32_t code_point, uint16_t script) const

        Check if the Script_Extensions property of the given code point covers the given script

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


    .. cpp:function:: ICU4XCodePointSetData get_script_extensions_set(uint16_t script) const

        Build the CodePointSetData corresponding to a codepoints matching a particular script in their Script_Extensions

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