380 lines
3.4 KiB
HTML
380 lines
3.4 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Stdlib.Uchar</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Stdlib.Uchar</H1>
|
|
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Stdlib.Uchar - no description
|
|
<A NAME="lbAC"> </A>
|
|
<H2>Module</H2>
|
|
|
|
Module Stdlib.Uchar
|
|
<A NAME="lbAD"> </A>
|
|
<H2>Documentation</H2>
|
|
|
|
<P>
|
|
Module
|
|
<B>Uchar</B>
|
|
|
|
<BR> :
|
|
<B>(module Stdlib__uchar)</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>type t </I>
|
|
|
|
<P>
|
|
<P>
|
|
The type for Unicode characters.
|
|
<P>
|
|
A value of this type represents a Unicode
|
|
scalar
|
|
value which is an integer in the ranges
|
|
<B>0x0000</B>
|
|
|
|
...
|
|
<B>0xD7FF</B>
|
|
|
|
or
|
|
<B>0xE000</B>
|
|
|
|
...
|
|
<B>0x10FFFF</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val min </I>
|
|
|
|
:
|
|
<B>t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>min</B>
|
|
|
|
is U+0000.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val max </I>
|
|
|
|
:
|
|
<B>t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>max</B>
|
|
|
|
is U+10FFFF.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val bom </I>
|
|
|
|
:
|
|
<B>t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>bom</B>
|
|
|
|
is U+FEFF, the
|
|
byte order mark (BOM)
|
|
character.
|
|
<P>
|
|
<P>
|
|
<B>Since</B>
|
|
|
|
4.06.0
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rep </I>
|
|
|
|
:
|
|
<B>t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>rep</B>
|
|
|
|
is U+FFFD, the
|
|
replacement
|
|
character.
|
|
<P>
|
|
<P>
|
|
<B>Since</B>
|
|
|
|
4.06.0
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val succ </I>
|
|
|
|
:
|
|
<B>t -> t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>succ u</B>
|
|
|
|
is the scalar value after
|
|
<B>u</B>
|
|
|
|
in the set of Unicode scalar
|
|
values.
|
|
<P>
|
|
<P>
|
|
<B>Raises Invalid_argument</B>
|
|
|
|
if
|
|
<B>u</B>
|
|
|
|
is
|
|
<B>Uchar.max</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val pred </I>
|
|
|
|
:
|
|
<B>t -> t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>pred u</B>
|
|
|
|
is the scalar value before
|
|
<B>u</B>
|
|
|
|
in the set of Unicode scalar
|
|
values.
|
|
<P>
|
|
<P>
|
|
<B>Raises Invalid_argument</B>
|
|
|
|
if
|
|
<B>u</B>
|
|
|
|
is
|
|
<B>Uchar.min</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val is_valid </I>
|
|
|
|
:
|
|
<B>int -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>is_valid n</B>
|
|
|
|
is
|
|
<B>true</B>
|
|
|
|
iff
|
|
<B>n</B>
|
|
|
|
is a Unicode scalar value
|
|
(i.e. in the ranges
|
|
<B>0x0000</B>
|
|
|
|
...
|
|
<B>0xD7FF</B>
|
|
|
|
or
|
|
<B>0xE000</B>
|
|
|
|
...
|
|
<B>0x10FFFF</B>
|
|
|
|
).
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val of_int </I>
|
|
|
|
:
|
|
<B>int -> t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>of_int i</B>
|
|
|
|
is
|
|
<B>i</B>
|
|
|
|
as a Unicode character.
|
|
<P>
|
|
<P>
|
|
<B>Raises Invalid_argument</B>
|
|
|
|
if
|
|
<B>i</B>
|
|
|
|
does not satisfy
|
|
<B>Uchar.is_valid</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val to_int </I>
|
|
|
|
:
|
|
<B>t -> int</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>to_int u</B>
|
|
|
|
is
|
|
<B>u</B>
|
|
|
|
as an integer.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val is_char </I>
|
|
|
|
:
|
|
<B>t -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>is_char u</B>
|
|
|
|
is
|
|
<B>true</B>
|
|
|
|
iff
|
|
<B>u</B>
|
|
|
|
is a latin1 OCaml character.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val of_char </I>
|
|
|
|
:
|
|
<B>char -> t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>of_char c</B>
|
|
|
|
is
|
|
<B>c</B>
|
|
|
|
as a Unicode character.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val to_char </I>
|
|
|
|
:
|
|
<B>t -> char</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>to_char u</B>
|
|
|
|
is
|
|
<B>u</B>
|
|
|
|
as an OCaml latin1 character.
|
|
<P>
|
|
<P>
|
|
<B>Raises Invalid_argument</B>
|
|
|
|
if
|
|
<B>u</B>
|
|
|
|
does not satisfy
|
|
<B>Uchar.is_char</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val equal </I>
|
|
|
|
:
|
|
<B>t -> t -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>equal u u'</B>
|
|
|
|
is
|
|
<B>u = u'</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val compare </I>
|
|
|
|
:
|
|
<B>t -> t -> int</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>compare u u'</B>
|
|
|
|
is
|
|
<B>Stdlib.compare u u'</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val hash </I>
|
|
|
|
:
|
|
<B>t -> int</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>hash u</B>
|
|
|
|
associates a non-negative integer to
|
|
<B>u</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">Module</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:57 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|