diff options
Diffstat (limited to 'intl/icu_capi/cpp/docs/source/segmenter_line_ffi.rst')
-rw-r--r-- | intl/icu_capi/cpp/docs/source/segmenter_line_ffi.rst | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/intl/icu_capi/cpp/docs/source/segmenter_line_ffi.rst b/intl/icu_capi/cpp/docs/source/segmenter_line_ffi.rst new file mode 100644 index 0000000000..2d2aa514b1 --- /dev/null +++ b/intl/icu_capi/cpp/docs/source/segmenter_line_ffi.rst @@ -0,0 +1,155 @@ +``segmenter_line::ffi`` +======================= + +.. cpp:class:: ICU4XLineBreakIteratorLatin1 + + See the `Rust documentation for LineBreakIterator <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakIterator.html>`__ for more information. + + Additional information: `1 <https://docs.rs/icu/latest/icu/segmenter/type.LineBreakIteratorLatin1.html>`__ + + + .. cpp:function:: int32_t next() + + Finds the next breakpoint. Returns -1 if at the end of the string or if the index is out of range of a 32-bit signed integer. + + See the `Rust documentation for next <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakIterator.html#method.next>`__ for more information. + + +.. cpp:class:: ICU4XLineBreakIteratorUtf16 + + See the `Rust documentation for LineBreakIterator <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakIterator.html>`__ for more information. + + Additional information: `1 <https://docs.rs/icu/latest/icu/segmenter/type.LineBreakIteratorUtf16.html>`__ + + + .. cpp:function:: int32_t next() + + Finds the next breakpoint. Returns -1 if at the end of the string or if the index is out of range of a 32-bit signed integer. + + See the `Rust documentation for next <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakIterator.html#method.next>`__ for more information. + + +.. cpp:class:: ICU4XLineBreakIteratorUtf8 + + See the `Rust documentation for LineBreakIterator <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakIterator.html>`__ for more information. + + Additional information: `1 <https://docs.rs/icu/latest/icu/segmenter/type.LineBreakIteratorPotentiallyIllFormedUtf8.html>`__ + + + .. cpp:function:: int32_t next() + + Finds the next breakpoint. Returns -1 if at the end of the string or if the index is out of range of a 32-bit signed integer. + + See the `Rust documentation for next <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakIterator.html#method.next>`__ for more information. + + +.. cpp:struct:: ICU4XLineBreakOptionsV1 + + See the `Rust documentation for LineBreakOptions <https://docs.rs/icu/latest/icu/segmenter/struct.LineBreakOptions.html>`__ for more information. + + + .. cpp:member:: ICU4XLineBreakStrictness strictness + + .. cpp:member:: ICU4XLineBreakWordOption word_option + + .. cpp:member:: bool ja_zh + +.. cpp:enum-struct:: ICU4XLineBreakStrictness + + See the `Rust documentation for LineBreakStrictness <https://docs.rs/icu/latest/icu/segmenter/enum.LineBreakStrictness.html>`__ for more information. + + + .. cpp:enumerator:: Loose + + .. cpp:enumerator:: Normal + + .. cpp:enumerator:: Strict + + .. cpp:enumerator:: Anywhere + +.. cpp:enum-struct:: ICU4XLineBreakWordOption + + See the `Rust documentation for LineBreakWordOption <https://docs.rs/icu/latest/icu/segmenter/enum.LineBreakWordOption.html>`__ for more information. + + + .. cpp:enumerator:: Normal + + .. cpp:enumerator:: BreakAll + + .. cpp:enumerator:: KeepAll + +.. cpp:class:: ICU4XLineSegmenter + + An ICU4X line-break segmenter, capable of finding breakpoints in strings. + + See the `Rust documentation for LineSegmenter <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLineSegmenter, ICU4XError> create_auto(const ICU4XDataProvider& provider) + + Construct a :cpp:class:`ICU4XLineSegmenter` with default options. It automatically loads the best available payload data for Burmese, Khmer, Lao, and Thai. + + See the `Rust documentation for new_auto <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.new_auto>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLineSegmenter, ICU4XError> create_lstm(const ICU4XDataProvider& provider) + + Construct a :cpp:class:`ICU4XLineSegmenter` with default options and LSTM payload data for Burmese, Khmer, Lao, and Thai. + + See the `Rust documentation for new_lstm <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.new_lstm>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLineSegmenter, ICU4XError> create_dictionary(const ICU4XDataProvider& provider) + + Construct a :cpp:class:`ICU4XLineSegmenter` with default options and dictionary payload data for Burmese, Khmer, Lao, and Thai.. + + See the `Rust documentation for new_dictionary <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.new_dictionary>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLineSegmenter, ICU4XError> create_auto_with_options_v1(const ICU4XDataProvider& provider, ICU4XLineBreakOptionsV1 options) + + Construct a :cpp:class:`ICU4XLineSegmenter` with custom options. It automatically loads the best available payload data for Burmese, Khmer, Lao, and Thai. + + See the `Rust documentation for new_auto_with_options <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.new_auto_with_options>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLineSegmenter, ICU4XError> create_lstm_with_options_v1(const ICU4XDataProvider& provider, ICU4XLineBreakOptionsV1 options) + + Construct a :cpp:class:`ICU4XLineSegmenter` with custom options and LSTM payload data for Burmese, Khmer, Lao, and Thai. + + See the `Rust documentation for new_lstm_with_options <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.new_lstm_with_options>`__ for more information. + + + .. cpp:function:: static diplomat::result<ICU4XLineSegmenter, ICU4XError> create_dictionary_with_options_v1(const ICU4XDataProvider& provider, ICU4XLineBreakOptionsV1 options) + + Construct a :cpp:class:`ICU4XLineSegmenter` with custom options and dictionary payload data for Burmese, Khmer, Lao, and Thai. + + See the `Rust documentation for new_dictionary_with_options <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.new_dictionary_with_options>`__ for more information. + + + .. cpp:function:: ICU4XLineBreakIteratorUtf8 segment_utf8(const std::string_view input) const + + Segments a (potentially ill-formed) UTF-8 string. + + See the `Rust documentation for segment_utf8 <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.segment_utf8>`__ for more information. + + Lifetimes: ``this``, ``input`` must live at least as long as the output. + + + .. cpp:function:: ICU4XLineBreakIteratorUtf16 segment_utf16(const diplomat::span<const uint16_t> input) const + + Segments a UTF-16 string. + + See the `Rust documentation for segment_utf16 <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.segment_utf16>`__ for more information. + + Lifetimes: ``this``, ``input`` must live at least as long as the output. + + + .. cpp:function:: ICU4XLineBreakIteratorLatin1 segment_latin1(const diplomat::span<const uint8_t> input) const + + Segments a Latin-1 string. + + See the `Rust documentation for segment_latin1 <https://docs.rs/icu/latest/icu/segmenter/struct.LineSegmenter.html#method.segment_latin1>`__ for more information. + + Lifetimes: ``this``, ``input`` must live at least as long as the output. + |