# Index of values

A
add_utf_16be [Uutf.Buffer] | `add_utf_16be b u` adds the UTF-16BE encoding of the unicode scalar value `u` to `b`.
add_utf_16le [Uutf.Buffer] | `add_utf_16le b u` adds the UTF-16LE encoding of the unicode scalar value `u` to `b`.
add_utf_8 [Uutf.Buffer] | `add_utf_8 b u` adds the UTF-8 encoding of the unicode scalar value `u` to `b`.
C
cp_to_string [Uutf] | `cp_to_string cp` represents the code point `cp` in ASCII according to the Unicode notational convention (see Appendix A in Unicode 6.1.0).
D
decode [Uutf] | `decode d` is: ``Await` if `d` has a ``Manual` input source and awaits for more input. The client must use `Uutf.Manual.src` to provide it., ``Uchar u` if a Unicode scalar value `u` was decoded., ``End` if the end of input was reached., ``Malformed bytes` if the `bytes` sequence is malformed according to the decoded encoding scheme. If you are interested in a best-effort decoding you can still continue to decode after an error until the decoder synchronizes again on valid bytes. It may however be a good idea to signal the malformed characters by adding an `Uutf.u_rep` character to the parsed data, see the examples.
decoder [Uutf] | `decoder nln encoding src` is a decoder that inputs from `src`.
decoder_col [Uutf] | `decoder_col d` is the column number of the last decoded (or malformed) character.
decoder_count [Uutf] | `decoder_count d` is the number of characters already decoded on `d` (including malformed ones).
decoder_encoding [Uutf] | `decoder_encoding d` is `d`'s the decoded encoding scheme of `d`.
decoder_line [Uutf] | `decoder_line d` is the line number of the last decoded (or malformed) character.
decoder_nln [Uutf] | `decoder_nln d` returns `d`'s newline normalization (if any).
decoder_removed_bom [Uutf] | `decoder_removed_bom d` is `true` iff an initial BOM was removed from the input stream.
decoder_src [Uutf] | `decoder_src d` is `d`'s input source.
dst [Uutf.Manual] | `dst e s j l` provides `e` with `l` bytes to write, starting at `j` in `s`.
dst_rem [Uutf.Manual] | `dst_rem e` is the remaining number of non-written, free bytes in the last buffer provided with `Uutf.Manual.dst`.
E
encode [Uutf] | `encode e v` is : ``Partial` iff `e` has a ``Manual` destination and needs more output storage. The client must use `Uutf.Manual.dst` to provide a new buffer and then call `Uutf.encode` with ``Await` until ``Ok` is returned., ``Ok` when the encoder is ready to encode a new ``Uchar` or ``End`
encoder [Uutf] | `encoder encoding dst` is an encoder for `encoding` that outputs to `dst`.
encoder_dst [Uutf] | `encoder_dst e` is `e`'s output destination.
encoder_encoding [Uutf] | `encoder_encoding e` is `e`'s encoding.
encoding_guess [Uutf.String] | `encoding_guess s` is the encoding guessed for `s` coupled with `true` iff there's an initial BOM.
encoding_of_string [Uutf] | `encoding_of_string s` converts a (case insensitive) IANA character set name to an encoding.
encoding_to_string [Uutf] | `encoding_to_string e` is a IANA character set name for `e`.
F
fold_utf_16be [Uutf.String] | `fold_utf_16be f a s` is `f (` ...
fold_utf_16le [Uutf.String] | `fold_utf_16le f a s` is `f (` ...
fold_utf_8 [Uutf.String] | `fold_utf_8 f a s` is `f (` ...
I
is_uchar [Uutf] | `is_uchar cp` is `true` iff `cp` is a Unicode scalar value.
P
pp_cp [Uutf] | `pp_cp ppf cp` prints `cp` on `ppf`.
pp_decode [Uutf] | `pp_decode ppf v` prints an unspecified representation of `v` on `ppf`.
S
src [Uutf.Manual] | `src d s j l` provides `d` with `l` bytes to read, starting at `j` in `s`.
U
u_bom [Uutf] | `u_bom` is the byte order mark (BOM) character (`U+FEFF`).
u_rep [Uutf] | `u_rep` is the replacement character (`U+FFFD`).