package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=9b654edb663ae697563f150824047052f3b1bf760398f24bce6350553f031f73c46b6337239a1acd871e61238597ea92046809e3358290ff14d6ba671b449085
doc/orsetto.ucs/Ucs_transport_utf8/index.html
Module Ucs_transport_utf8
Module Inclusion
include Ucs_transport_aux.Profile
A Latin-1 text string containing the name of the transport form, e.g. "UTF-8"
or "UTF-16LE"
.
val size_of_uchar : Uchar.t -> int
Use size_of_uchar c
to compute the number of octets required to represent c
in this transport form.
val uchar_decode_scheme : Uchar.t Cf_decode.scheme
Use s#scan uchar_decode_scheme
to scan the next Unicode code point available as encoded octets to s
. Raises Cf_decode.Invalid
if the octets do not comprise a valid Unicode character.
val uchar_encode_scheme : Uchar.t Cf_encode.scheme
Use e#emit of_char uchar_encode_scheme c
to emit c
as encoded octets with e
.
val bom_decode_scheme : unit Cf_decode.scheme
Use s#scan bom_decode_scheme
to scan the octets of the next code point in the stream and, if they are the encoding of the Unicode Byte Order Mark (BOM) character, U+FEFF
, to produce the unit value. Raises Cf_decode.Invalid
if the octets do not comprise a BOM character.
val bom_encode_scheme : unit Cf_encode.scheme
Use e#emit bom_encode_scheme `UTF8
to emit the encoding of the Unicode Byte Order Mark (BOM) character, U+FEFF
.
val seq_of_scanner : Cf_decode.scanner -> Uchar.t Seq.t
Use seq_of_scanner sxr
to make a volatile sequence that scans Unicode characters with sxr
. Consuming the sequence can raise exceptions from
f_decode
.
Use seq_of_string str
to make a volatile sequence that scans Unicode characters from str
. Consuming the sequence can raise exceptions from
f_decode
.
val seq_of_slice : string Cf_slice.t -> Uchar.t Seq.t
Use seq_of_slice str
to make a volatile sequence that scans Unicode characters from str
. Consuming the sequence can raise exceptions from
f_decode
.
val seq_to_emitter : Cf_encode.emitter -> Uchar.t Seq.t -> unit
Use seq_to_emitter exr s
to consume all the Unicode characters in s
and emit them with exr
.
Use seq_to_string s
to make a string containing all the Unicode characters in s
encoded according to the transport form. Raises Failure
if more than Sys.max_string_length
octets are required.
Use validate_string s
to raise Cf_decode.Invalid
with the position in s
of the first invalid octet. Returns normally if the string is a valid encoding.
val validate_slice : string Cf_slice.t -> unit
Use validate_slice s
to raise Cf_decode.Invalid
with the position in s
of the first invalid octet. Returns normally if the slice comprises a valid encoding.
Use is_valid_string s
to test whether s
comprises a valid encoding of octets in the transport form.
val is_valid_slice : string Cf_slice.t -> bool
Use is_valid_slice s
to test whether s
comprises a valid encoding of octets in the transport form.