diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/normalizer_ffi.rst')
| -rw-r--r-- | intl/icu_capi/cpp/docs/source/normalizer_ffi.rst | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/normalizer_ffi.rst b/intl/icu_capi/cpp/docs/source/normalizer_ffi.rst new file mode 100644 index 0000000000..033cd4e71b --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/normalizer_ffi.rst @@ -0,0 +1,94 @@ +``normalizer::ffi`` +=================== + +.. cpp:class:: ICU4XComposingNormalizer + + See the `Rust documentation for ComposingNormalizer <https://docs.rs/icu/latest/icu/normalizer/struct.ComposingNormalizer.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XComposingNormalizer, ICU4XError> create_nfc(const ICU4XDataProvider& provider) + + Construct a new ICU4XComposingNormalizer instance for NFC + + See the `Rust documentation for new_nfc <https://docs.rs/icu/latest/icu/normalizer/struct.ComposingNormalizer.html#method.new_nfc>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XComposingNormalizer, ICU4XError> create_nfkc(const ICU4XDataProvider& provider) + + Construct a new ICU4XComposingNormalizer instance for NFKC + + See the `Rust documentation for new_nfkc <https://docs.rs/icu/latest/icu/normalizer/struct.ComposingNormalizer.html#method.new_nfkc>`__ for more information. + + + .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> normalize_to_writeable(const std::string_view s, W& write) const + + Normalize a (potentially ill-formed) UTF8 string + + Errors are mapped to REPLACEMENT CHARACTER + + See the `Rust documentation for normalize_utf8 <https://docs.rs/icu/latest/icu/normalizer/struct.ComposingNormalizer.html#method.normalize_utf8>`__ for more information. + + + .. cpp:function:: diplomat::result<std::string, ICU4XError> normalize(const std::string_view s) const + + Normalize a (potentially ill-formed) UTF8 string + + Errors are mapped to REPLACEMENT CHARACTER + + See the `Rust documentation for normalize_utf8 <https://docs.rs/icu/latest/icu/normalizer/struct.ComposingNormalizer.html#method.normalize_utf8>`__ for more information. + + + .. cpp:function:: bool is_normalized(const std::string_view s) const + + Check if a (potentially ill-formed) UTF8 string is normalized + + Errors are mapped to REPLACEMENT CHARACTER + + See the `Rust documentation for is_normalized_utf8 <https://docs.rs/icu/latest/icu/normalizer/struct.ComposingNormalizer.html#method.is_normalized_utf8>`__ for more information. + + +.. cpp:class:: ICU4XDecomposingNormalizer + + See the `Rust documentation for DecomposingNormalizer <https://docs.rs/icu/latest/icu/normalizer/struct.DecomposingNormalizer.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XDecomposingNormalizer, ICU4XError> create_nfd(const ICU4XDataProvider& provider) + + Construct a new ICU4XDecomposingNormalizer instance for NFC + + See the `Rust documentation for new_nfd <https://docs.rs/icu/latest/icu/normalizer/struct.DecomposingNormalizer.html#method.new_nfd>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XDecomposingNormalizer, ICU4XError> create_nfkd(const ICU4XDataProvider& provider) + + Construct a new ICU4XDecomposingNormalizer instance for NFKC + + See the `Rust documentation for new_nfkd <https://docs.rs/icu/latest/icu/normalizer/struct.DecomposingNormalizer.html#method.new_nfkd>`__ for more information. + + + .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> normalize_to_writeable(const std::string_view s, W& write) const + + Normalize a (potentially ill-formed) UTF8 string + + Errors are mapped to REPLACEMENT CHARACTER + + See the `Rust documentation for normalize_utf8 <https://docs.rs/icu/latest/icu/normalizer/struct.DecomposingNormalizer.html#method.normalize_utf8>`__ for more information. + + + .. cpp:function:: diplomat::result<std::string, ICU4XError> normalize(const std::string_view s) const + + Normalize a (potentially ill-formed) UTF8 string + + Errors are mapped to REPLACEMENT CHARACTER + + See the `Rust documentation for normalize_utf8 <https://docs.rs/icu/latest/icu/normalizer/struct.DecomposingNormalizer.html#method.normalize_utf8>`__ for more information. + + + .. cpp:function:: bool is_normalized(const std::string_view s) const + + Check if a (potentially ill-formed) UTF8 string is normalized + + Errors are mapped to REPLACEMENT CHARACTER + + See the `Rust documentation for is_normalized_utf8 <https://docs.rs/icu/latest/icu/normalizer/struct.DecomposingNormalizer.html#method.is_normalized_utf8>`__ for more information. + |