Uchar - Unicode characters.

       Module Uchar
        : sigend

       Unicode characters.

       Since 4.03

       typet

       The type for Unicode characters.

       A  value  of  this  type  represents  a Unicode scalar value which is an integer in the ranges 0x0000 ...
       0xD7FF or 0xE000 ...  0x10FFFF .

       valmin : tmin is U+0000.

       valmax : tmax is U+10FFFF.

       valbom : tbom is U+FEFF, the byte order mark (BOM) character.

       Since 4.06

       valrep : trep is U+FFFD, the replacement character.

       Since 4.06

       valsucc : t->tsuccu is the scalar value after u in the set of Unicode scalar values.

       RaisesInvalid_argument if u is Uchar.max .

       valpred : t->tpredu is the scalar value before u in the set of Unicode scalar values.

       RaisesInvalid_argument if u is Uchar.min .

       valis_valid : int->boolis_validn is true if and only if n is a Unicode scalar value (i.e. in the ranges 0x0000 ...   0xD7FF  or
       0xE000 ...  0x10FFFF ).

       valof_int : int->tof_inti is i as a Unicode character.

       RaisesInvalid_argument if i does not satisfy Uchar.is_valid .

       valto_int : t->intto_intu is u as an integer.

       valis_char : t->boolis_charu is true if and only if u is a latin1 OCaml character.

       valof_char : char->tof_charc is c as a Unicode character.

       valto_char : t->charto_charu is u as an OCaml latin1 character.

       RaisesInvalid_argument if u does not satisfy Uchar.is_char .

       valequal : t->t->boolequaluu' is u=u' .

       valcompare : t->t->intcompareuu' is Stdlib.compareuu' .

       valseeded_hash : int->t->intseeded_hashseedu  A  seeded  hash  function  with the same output value as Hashtbl.seeded_hash . This
       function allows this module to be passed as an argument to the functor Hashtbl.MakeSeeded .

       Since 5.3

       valhash : t->int

       An unseeded hash function with the same output value as Hashtbl.hash .  This function allows this  module
       to be passed as an argument to the functor Hashtbl.Make .

       Since 5.3

   UTFcodecstoolstypeutf_decode

       The  type  for  UTF  decode results. Values of this type represent the result of a Unicode Transformation
       Format decoding attempt.

       valutf_decode_is_valid : utf_decode->boolutf_decode_is_validd is true if and only if d holds a valid decode.

       valutf_decode_uchar : utf_decode->tutf_decode_uchard is the Unicode character decoded by d if utf_decode_is_validd is true  and  Uchar.rep
       otherwise.

       valutf_decode_length : utf_decode->intutf_decode_lengthd  is the number of elements from the source that were consumed by the decode d . This
       is always strictly positive and smaller or equal to 4 . The kind of source elements depends on the actual
       decoder; for the decoders of the standard library this function always returns a length in bytes.

       valutf_decode : int->t->utf_decodeutf_decodenu is a valid UTF decode for u that consumed n elements from the source for decoding.  n must
       be positive and smaller or equal to 4 (this is not checked by the module).

       valutf_decode_invalid : int->utf_decodeutf_decode_invalidn is an invalid UTF decode that consumed n elements from the source to error.  n  must
       be  positive  and  smaller  or  equal  to 4 (this is not checked by the module). The resulting decode has
       Uchar.rep as the decoded Unicode character.

       valutf_8_byte_length : t->intutf_8_byte_lengthu is the number of bytes needed to encode u in UTF-8.

       valutf_16_byte_length : t->intutf_16_byte_lengthu is the number of bytes needed to encode u in UTF-16.

OCamldoc                                           2025-06-12                                          Uchar(3o)

       Module   Uchar

       Uchar - Unicode characters.