<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="Up" href="UnicodeString.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of class methods" rel=Appendix href="index_methods.html"> <link title="Index of classes" rel=Appendix href="index_classes.html"> <link title="Index of class types" rel=Appendix href="index_class_types.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="CaseMap" rel="Chapter" href="CaseMap.html"> <link title="CharEncoding" rel="Chapter" href="CharEncoding.html"> <link title="Default" rel="Chapter" href="Default.html"> <link title="IMap" rel="Chapter" href="IMap.html"> <link title="ISet" rel="Chapter" href="ISet.html"> <link title="Locale" rel="Chapter" href="Locale.html"> <link title="Main" rel="Chapter" href="Main.html"> <link title="OOChannel" rel="Chapter" href="OOChannel.html"> <link title="SubText" rel="Chapter" href="SubText.html"> <link title="UCS4" rel="Chapter" href="UCS4.html"> <link title="UChar" rel="Chapter" href="UChar.html"> <link title="UCharInfo" rel="Chapter" href="UCharInfo.html"> <link title="UCharTbl" rel="Chapter" href="UCharTbl.html"> <link title="UCol" rel="Chapter" href="UCol.html"> <link title="ULine" rel="Chapter" href="ULine.html"> <link title="UMap" rel="Chapter" href="UMap.html"> <link title="UNF" rel="Chapter" href="UNF.html"> <link title="UPervasives" rel="Chapter" href="UPervasives.html"> <link title="URe" rel="Chapter" href="URe.html"> <link title="UReStr" rel="Chapter" href="UReStr.html"> <link title="USet" rel="Chapter" href="USet.html"> <link title="UTF16" rel="Chapter" href="UTF16.html"> <link title="UTF8" rel="Chapter" href="UTF8.html"> <link title="UText" rel="Chapter" href="UText.html"> <link title="UnicodeString" rel="Chapter" href="UnicodeString.html"> <link title="XArray" rel="Chapter" href="XArray.html"> <link title="XString" rel="Chapter" href="XString.html"><title>UnicodeString.Type</title> </head> <body> <div class="navbar"> <a href="UnicodeString.html">Up</a> </div> <center><h1>Module type <a href="type_UnicodeString.Type.html">UnicodeString.Type</a></h1></center> <br> <pre><span class="keyword">module type</span> Type = <code class="code">sig</code> <a href="UnicodeString.Type.html">..</a> <code class="code">end</code></pre><hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre> <div class="info"> The type of string.<br> </div> <pre><span class="keyword">val</span> <a name="VALget"></a>get : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> int -> <a href="UChar.html#TYPEt">UChar.t</a></code></pre><div class="info"> <code class="code">get t i</code> : <code class="code">i</code>-th character of the storage.<br> </div> <pre><span class="keyword">val</span> <a name="VALinit"></a>init : <code class="type">int -> (int -> <a href="UChar.html#TYPEt">UChar.t</a>) -> <a href="UnicodeString.Type.html#TYPEt">t</a></code></pre><div class="info"> <code class="code">init len f</code> creates a new storage. the returned storage has length <code class="code">len</code>, its nth-element is <code class="code">f n</code>. <code class="code">f</code> is called with integers <code class="code">0 ... len - 1</code>, only once for each integer. The call is in the increasing order f 0, f 1, f 2, ...<br> </div> <pre><span class="keyword">val</span> <a name="VALlength"></a>length : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> int</code></pre><div class="info"> The number of Unicode characters in the storage<br> </div> <pre><span class="keyword">type</span> <a name="TYPEindex"></a><code class="type"></code>index </pre> <div class="info"> locations in storages.<br> </div> <pre><span class="keyword">val</span> <a name="VALlook"></a>look : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> <a href="UChar.html#TYPEt">UChar.t</a></code></pre><div class="info"> <code class="code">look t i</code> : The character in the location <code class="code">i</code> of <code class="code">t</code>.<br> </div> <pre><span class="keyword">val</span> <a name="VALnth"></a>nth : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> int -> <a href="UnicodeString.Type.html#TYPEindex">index</a></code></pre><div class="info"> <code class="code">nth t n</code> : the location of the <code class="code">n</code>-th character in <code class="code">t</code>.<br> </div> <br> <code class="code">next x i, prev x i</code> : The operation is valid if <code class="code">i</code> points the valid element, i.e. the returned value may point the location beyond valid elements by one. If <code class="code">i</code> does not point a valid element, the results are unspecified.<br> <pre><span class="keyword">val</span> <a name="VALnext"></a>next : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a></code></pre><pre><span class="keyword">val</span> <a name="VALprev"></a>prev : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a></code></pre><pre><span class="keyword">val</span> <a name="VALout_of_range"></a>out_of_range : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALiter"></a>iter : <code class="type">(<a href="UChar.html#TYPEt">UChar.t</a> -> unit) -> <a href="UnicodeString.Type.html#TYPEt">t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALcompare"></a>compare : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEt">t</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALfirst"></a>first : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a></code></pre><div class="info"> The location of the first character in the storage.<br> </div> <pre><span class="keyword">val</span> <a name="VALlast"></a>last : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a></code></pre><div class="info"> The location of the last character in the storage.<br> </div> <pre><span class="keyword">val</span> <a name="VALmove"></a>move : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -><br> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> int -> <a href="UnicodeString.Type.html#TYPEindex">index</a></code></pre><div class="info"> <code class="code">move t i n</code> : if <code class="code">n</code> >= 0, then returns <code class="code">n</code>-th character after <code class="code">i</code> and otherwise returns -<code class="code">n</code>-th character before <code class="code">i</code>. If there is no such character, or <code class="code">i</code> does not point a valid character, the result is unspecified.<br> </div> <pre><span class="keyword">val</span> <a name="VALcompare_index"></a>compare_index : <code class="type"><a href="UnicodeString.Type.html#TYPEt">t</a> -><br> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> <a href="UnicodeString.Type.html#TYPEindex">index</a> -> int</code></pre><div class="info"> <code class="code">compare_index t i j</code> returns a positive integer if <code class="code">i</code> is the location placed after <code class="code">j</code> in <code class="code">t</code>, 0 if <code class="code">i</code> and <code class="code">j</code> point the same location, and a negative integer if <code class="code">i</code> is the location placed before <code class="code">j</code> in <code class="code">t</code>.<br> </div> <pre><span class="keyword">module</span> <a href="UnicodeString.Type.Buf.html">Buf</a>: <code class="code">sig</code> <a href="UnicodeString.Type.Buf.html">..</a> <code class="code">end</code></pre><div class="info"> Character buffers. </div> </body></html>