diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/collator_ffi.rst')
| -rw-r--r-- | intl/icu_capi/cpp/docs/source/collator_ffi.rst | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/collator_ffi.rst b/intl/icu_capi/cpp/docs/source/collator_ffi.rst new file mode 100644 index 0000000000..ce3c24f07b --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/collator_ffi.rst @@ -0,0 +1,147 @@ +``collator::ffi`` +================= + +.. cpp:class:: ICU4XCollator + + See the `Rust documentation for Collator <https://docs.rs/icu/latest/icu/collator/struct.Collator.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XCollator, ICU4XError> create_v1(const ICU4XDataProvider& provider, const ICU4XLocale& locale, ICU4XCollatorOptionsV1 options) + + Construct a new Collator instance. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/collator/struct.Collator.html#method.try_new>`__ for more information. + + + .. cpp:function:: ICU4XOrdering compare(const std::string_view left, const std::string_view right) const + + Compare potentially ill-formed UTF-8 strings. + + Ill-formed input is compared as if errors had been replaced with REPLACEMENT CHARACTERs according to the WHATWG Encoding Standard. + + See the `Rust documentation for compare_utf8 <https://docs.rs/icu/latest/icu/collator/struct.Collator.html#method.compare_utf8>`__ for more information. + + + .. cpp:function:: ICU4XOrdering compare_valid_utf8(const std::string_view left, const std::string_view right) const + + Compare guaranteed well-formed UTF-8 strings. + + Note: In C++, passing ill-formed UTF-8 strings is undefined behavior (and may be memory-unsafe to do so, too). + + See the `Rust documentation for compare <https://docs.rs/icu/latest/icu/collator/struct.Collator.html#method.compare>`__ for more information. + + + .. cpp:function:: ICU4XOrdering compare_utf16(const diplomat::span<const uint16_t> left, const diplomat::span<const uint16_t> right) const + + Compare potentially ill-formed UTF-16 strings, with unpaired surrogates compared as REPLACEMENT CHARACTER. + + See the `Rust documentation for compare_utf16 <https://docs.rs/icu/latest/icu/collator/struct.Collator.html#method.compare_utf16>`__ for more information. + + +.. cpp:enum-struct:: ICU4XCollatorAlternateHandling + + See the `Rust documentation for AlternateHandling <https://docs.rs/icu/latest/icu/collator/enum.AlternateHandling.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: NonIgnorable + + .. cpp:enumerator:: Shifted + +.. cpp:enum-struct:: ICU4XCollatorBackwardSecondLevel + + See the `Rust documentation for BackwardSecondLevel <https://docs.rs/icu/latest/icu/collator/enum.BackwardSecondLevel.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Off + + .. cpp:enumerator:: On + +.. cpp:enum-struct:: ICU4XCollatorCaseFirst + + See the `Rust documentation for CaseFirst <https://docs.rs/icu/latest/icu/collator/enum.CaseFirst.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Off + + .. cpp:enumerator:: LowerFirst + + .. cpp:enumerator:: UpperFirst + +.. cpp:enum-struct:: ICU4XCollatorCaseLevel + + See the `Rust documentation for CaseLevel <https://docs.rs/icu/latest/icu/collator/enum.CaseLevel.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Off + + .. cpp:enumerator:: On + +.. cpp:enum-struct:: ICU4XCollatorMaxVariable + + See the `Rust documentation for MaxVariable <https://docs.rs/icu/latest/icu/collator/enum.MaxVariable.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Space + + .. cpp:enumerator:: Punctuation + + .. cpp:enumerator:: Symbol + + .. cpp:enumerator:: Currency + +.. cpp:enum-struct:: ICU4XCollatorNumeric + + See the `Rust documentation for Numeric <https://docs.rs/icu/latest/icu/collator/enum.Numeric.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Off + + .. cpp:enumerator:: On + +.. cpp:struct:: ICU4XCollatorOptionsV1 + + See the `Rust documentation for CollatorOptions <https://docs.rs/icu/latest/icu/collator/struct.CollatorOptions.html>`__ for more information. + + + .. cpp:member:: ICU4XCollatorStrength strength + + .. cpp:member:: ICU4XCollatorAlternateHandling alternate_handling + + .. cpp:member:: ICU4XCollatorCaseFirst case_first + + .. cpp:member:: ICU4XCollatorMaxVariable max_variable + + .. cpp:member:: ICU4XCollatorCaseLevel case_level + + .. cpp:member:: ICU4XCollatorNumeric numeric + + .. cpp:member:: ICU4XCollatorBackwardSecondLevel backward_second_level + +.. cpp:enum-struct:: ICU4XCollatorStrength + + See the `Rust documentation for Strength <https://docs.rs/icu/latest/icu/collator/enum.Strength.html>`__ for more information. + + + .. cpp:enumerator:: Auto + + .. cpp:enumerator:: Primary + + .. cpp:enumerator:: Secondary + + .. cpp:enumerator:: Tertiary + + .. cpp:enumerator:: Quaternary + + .. cpp:enumerator:: Identical |