intl/icu_capi/cpp/docs/source/properties_iter_ffi.rst


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

``properties_iter::ffi``
========================

.. cpp:class:: CodePointRangeIterator

    An iterator over code point ranges, produced by ``ICU4XCodePointSetData`` or one of the ``ICU4XCodePointMapData`` types


    .. cpp:function:: CodePointRangeIteratorResult next()

        Advance the iterator by one and return the next range.

        If the iterator is out of items, ``done`` will be true


.. cpp:struct:: CodePointRangeIteratorResult

    Result of a single iteration of :cpp:class:`CodePointRangeIterator`. Logically can be considered to be an ``Option<RangeInclusive<u32>>``,

    ``start`` and ``end`` represent an inclusive range of code points start, end, and ``done`` will be true if the iterator has already finished. The last contentful iteration will NOT produce a range done=true, in other words ``start`` and ``end`` are useful values if and only if ``done=false``.


    .. cpp:member:: uint32_t start

    .. cpp:member:: uint32_t end

    .. cpp:member:: bool done