Index of values


A
add [Uuseg]
add s v is: `Boundary if there is a boundary at that point in the sequence of characters. The client must then call add with `Await until `Await is returned., `Uchar u if u is the next character in the sequence. The client must then call add with `Await until `Await is returned., `Await when the segmenter is ready to add a new `Uchar or `End., `End when `End was added and all `Boundary and `Uchar were output.

B
boundary [Uuseg]
boundary s is the type of boundaries detected by s.

C
copy [Uuseg]
copy s is a copy of s in its current state.
create [Uuseg]
create b is an Unicode text segmenter for boundaries of type b.
custom [Uuseg]
create ~mandatory ~name ~create ~copy ~add is a custom segmenter.

E
err_ended [Uuseg]
err_ended () should be used by custom segmenter when the client tries to Uuseg.add `Uchar or `End after `End was already added.
err_exp_await [Uuseg]
err_exp_await fnd should be used by custom segmenters when the client tries to Uuseg.add an `Uchar or `End while the last returned value was not an `Await.

F
fold_utf_16be [Uuseg_string]
fold_utf16be is like Uuseg_string.fold_utf_8 but on UTF-16BE encoded strings.
fold_utf_16le [Uuseg_string]
fold_utf16le is like Uuseg_string.fold_utf_8 but on UTF-16BE encoded strings.
fold_utf_8 [Uuseg_string]
fold_utf_8 b f acc s folds over the b UTF-8 encoded segments of the UTF-8 encoded string s using f and acc.

M
mandatory [Uuseg]
mandatory s is true if the last `Boundary returned by Uuseg.add was mandatory.

P
pp_boundary [Uuseg]
pp_boundary ppf b prints an unspecified representation of b on ppf.
pp_ret [Uuseg]
pp_ret ppf v prints an unspecified representation of v on ppf.
pp_utf_8 [Uuseg_string]
pp_utf8 ppf s prints the UTF-8 encoded string s.
pp_utf_8_lines [Uuseg_string]
pp_utf_8_lines ppf s prints the UTF-8 encoded string s.
pp_utf_8_text [Uuseg_string]
pp_utf_8_text ppf s prints the UTF-8 encoded string s.

U
unicode_version [Uuseg]
unicode_version is the Unicode version supported by Uuseg.