diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/locid_transform_ffi.rst')
-rw-r--r-- | intl/icu_capi/cpp/docs/source/locid_transform_ffi.rst | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/locid_transform_ffi.rst b/intl/icu_capi/cpp/docs/source/locid_transform_ffi.rst new file mode 100644 index 0000000000..10d17a9cdf --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/locid_transform_ffi.rst @@ -0,0 +1,76 @@ +``locid_transform::ffi`` +======================== + +.. cpp:class:: ICU4XLocaleCanonicalizer + + A locale canonicalizer. + + See the `Rust documentation for LocaleCanonicalizer <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleCanonicalizer.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLocaleCanonicalizer, ICU4XError> create(const ICU4XDataProvider& provider) + + Create a new :cpp:class:`ICU4XLocaleCanonicalizer`. + + See the `Rust documentation for new <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleCanonicalizer.html#method.new>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLocaleCanonicalizer, ICU4XError> create_extended(const ICU4XDataProvider& provider) + + Create a new :cpp:class:`ICU4XLocaleCanonicalizer` with extended data. + + See the `Rust documentation for new_with_expander <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleCanonicalizer.html#method.new_with_expander>`__ for more information. + + + .. cpp:function:: ICU4XTransformResult canonicalize(ICU4XLocale& locale) const + + FFI version of ``LocaleCanonicalizer::canonicalize()``. + + See the `Rust documentation for canonicalize <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleCanonicalizer.html#method.canonicalize>`__ for more information. + + +.. cpp:class:: ICU4XLocaleExpander + + A locale expander. + + See the `Rust documentation for LocaleExpander <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleExpander.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLocaleExpander, ICU4XError> create(const ICU4XDataProvider& provider) + + Create a new :cpp:class:`ICU4XLocaleExpander`. + + See the `Rust documentation for new <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleExpander.html#method.new>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLocaleExpander, ICU4XError> create_extended(const ICU4XDataProvider& provider) + + Create a new :cpp:class:`ICU4XLocaleExpander` with extended data. + + See the `Rust documentation for new_extended <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleExpander.html#method.new_extended>`__ for more information. + + + .. cpp:function:: ICU4XTransformResult maximize(ICU4XLocale& locale) const + + FFI version of ``LocaleExpander::maximize()``. + + See the `Rust documentation for maximize <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleExpander.html#method.maximize>`__ for more information. + + + .. cpp:function:: ICU4XTransformResult minimize(ICU4XLocale& locale) const + + FFI version of ``LocaleExpander::minimize()``. + + See the `Rust documentation for minimize <https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleExpander.html#method.minimize>`__ for more information. + + +.. cpp:enum-struct:: ICU4XTransformResult + + FFI version of ``TransformResult``. + + See the `Rust documentation for TransformResult <https://docs.rs/icu/latest/icu/locid_transform/enum.TransformResult.html>`__ for more information. + + + .. cpp:enumerator:: Modified + + .. cpp:enumerator:: Unmodified |