Library
Module
Module type
Parameter
Class
Class type
decoder encoding src
is a decoder that inputs from src
.
Encoding. encoding
specifies the decoded encoding scheme.
The type for input sources. With a `Manual
source the client must provide input with src
.
val pp_decode : Format.formatter -> decode -> unit
pp_decode ppf v
prints an unspecified representation of v
on ppf
.
src d s j l
provides d
with l
bytes to read, starting at j
in s
. This byte range is read by calls to decode
with d
until `Await
is returned. To signal the end of input call the function with l = 0
.
decoder encoding src
is a decoder that inputs from src
.
Encoding. encoding
specifies the decoded encoding scheme.
decode d
is:
`Await
if d
has a `Manual
input source and awaits for more input. The client must use src
to provide it.`Uchar u
if a Unicode scalar value u
was decoder.`End
if the end of input was reached.`Malformed err
if d
encountered an error err
.Note. Repeated invocation always eventually returns `End
, even in case of errors.
val decoder_line : decoder -> int
decoder_line d
is the line number of the last decoded (or malformed) character. See decoder
for details.
val decoder_column : decoder -> int
decoder_column d
is the column number of the last decoder (or malformed) character. See decoder
for details.
val decoder_byte_count : decoder -> int
decoder_byte_count d
is the number of characters already decoder on d
(including malformed ones). This is the last decode
's and byte offset counting from beginning of the stream.
val decoder_count : decoder -> int
decoder_count d
is the number of characters already decoded on d
(including malformed ones). See decoder
for details.
module String : sig ... end