1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link rel="previous" href="Stream.html">
<link rel="next" href="StringLabels.html">
<link rel="Up" href="index.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 modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Dbm" rel="Chapter" href="Dbm.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><title>String</title>
</head>
<body>
<div class="navbar"><a href="Stream.html">Previous</a>
<a href="index.html">Up</a>
<a href="StringLabels.html">Next</a>
</div>
<center><h1>Module <a href="type_String.html">String</a></h1></center>
<br>
<pre><span class="keyword">module</span> String: <code class="code"><span class="keyword">sig</span></code> <a href="String.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>String operations.<br>
<hr width="100%">
<pre><span class="keyword">val</span> <a name="VALlength"></a>length : <code class="type">string -> int</code></pre><div class="info">
Return the length (number of characters) of the given string.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALget"></a>get : <code class="type">string -> int -> char</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.get s n</code> returns character number <code class="code">n</code> in string <code class="code">s</code>.
The first character is character number 0.
The last character is character number <code class="code"><span class="constructor">String</span>.length s - 1</code>.
You can also write <code class="code">s.[n]</code> instead of <code class="code"><span class="constructor">String</span>.get s n</code>.
<p>
Raise <code class="code"><span class="constructor">Invalid_argument</span> <span class="string">"index out of bounds"</span></code>
if <code class="code">n</code> is outside the range 0 to <code class="code">(<span class="constructor">String</span>.length s - 1)</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALset"></a>set : <code class="type">string -> int -> char -> unit</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.set s n c</code> modifies string <code class="code">s</code> in place,
replacing the character number <code class="code">n</code> by <code class="code">c</code>.
You can also write <code class="code">s.[n] <- c</code> instead of <code class="code"><span class="constructor">String</span>.set s n c</code>.
Raise <code class="code"><span class="constructor">Invalid_argument</span> <span class="string">"index out of bounds"</span></code>
if <code class="code">n</code> is outside the range 0 to <code class="code">(<span class="constructor">String</span>.length s - 1)</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">int -> string</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.create n</code> returns a fresh string of length <code class="code">n</code>.
The string initially contains arbitrary characters.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">n < 0</code> or <code class="code">n > <span class="constructor">Sys</span>.max_string_length</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmake"></a>make : <code class="type">int -> char -> string</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.make n c</code> returns a fresh string of length <code class="code">n</code>,
filled with the character <code class="code">c</code>.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">n < 0</code> or <code class="code">n > </code><a href="Sys.html#VALmax_string_length"><code class="code"><span class="constructor">Sys</span>.max_string_length</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcopy"></a>copy : <code class="type">string -> string</code></pre><div class="info">
Return a copy of the given string.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type">string -> int -> int -> string</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.sub s start len</code> returns a fresh string of length <code class="code">len</code>,
containing the characters number <code class="code">start</code> to <code class="code">start + len - 1</code>
of string <code class="code">s</code>.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">start</code> and <code class="code">len</code> do not
designate a valid substring of <code class="code">s</code>; that is, if <code class="code">start < 0</code>,
or <code class="code">len < 0</code>, or <code class="code">start + len > </code><a href="String.html#VALlength"><code class="code"><span class="constructor">String</span>.length</code></a><code class="code"> s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfill"></a>fill : <code class="type">string -> int -> int -> char -> unit</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.fill s start len c</code> modifies string <code class="code">s</code> in place,
replacing the characters number <code class="code">start</code> to <code class="code">start + len - 1</code>
by <code class="code">c</code>.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">start</code> and <code class="code">len</code> do not
designate a valid substring of <code class="code">s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALblit"></a>blit : <code class="type">string -> int -> string -> int -> int -> unit</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.blit src srcoff dst dstoff len</code> copies <code class="code">len</code> characters
from string <code class="code">src</code>, starting at character number <code class="code">srcoff</code>, to
string <code class="code">dst</code>, starting at character number <code class="code">dstoff</code>. It works
correctly even if <code class="code">src</code> and <code class="code">dst</code> are the same string,
and the source and destination chunks overlap.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">srcoff</code> and <code class="code">len</code> do not
designate a valid substring of <code class="code">src</code>, or if <code class="code">dstoff</code> and <code class="code">len</code>
do not designate a valid substring of <code class="code">dst</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALconcat"></a>concat : <code class="type">string -> string list -> string</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.concat sep sl</code> concatenates the list of strings <code class="code">sl</code>,
inserting the separator string <code class="code">sep</code> between each.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALiter"></a>iter : <code class="type">(char -> unit) -> string -> unit</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.iter f s</code> applies function <code class="code">f</code> in turn to all
the characters of <code class="code">s</code>. It is equivalent to
<code class="code">f s.[0]; f s.[1]; ...; f s.[<span class="constructor">String</span>.length s - 1]; ()</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALescaped"></a>escaped : <code class="type">string -> string</code></pre><div class="info">
Return a copy of the argument, with special characters
represented by escape sequences, following the lexical
conventions of Objective Caml. If there is no special
character in the argument, return the original string itself,
not a copy.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALindex"></a>index : <code class="type">string -> char -> int</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.index s c</code> returns the position of the leftmost
occurrence of character <code class="code">c</code> in string <code class="code">s</code>.
Raise <code class="code"><span class="constructor">Not_found</span></code> if <code class="code">c</code> does not occur in <code class="code">s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrindex"></a>rindex : <code class="type">string -> char -> int</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.rindex s c</code> returns the position of the rightmost
occurrence of character <code class="code">c</code> in string <code class="code">s</code>.
Raise <code class="code"><span class="constructor">Not_found</span></code> if <code class="code">c</code> does not occur in <code class="code">s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALindex_from"></a>index_from : <code class="type">string -> int -> char -> int</code></pre><div class="info">
Same as <a href="String.html#VALindex"><code class="code"><span class="constructor">String</span>.index</code></a>, but start
searching at the character position given as second argument.
<code class="code"><span class="constructor">String</span>.index s c</code> is equivalent to <code class="code"><span class="constructor">String</span>.index_from s 0 c</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrindex_from"></a>rindex_from : <code class="type">string -> int -> char -> int</code></pre><div class="info">
Same as <a href="String.html#VALrindex"><code class="code"><span class="constructor">String</span>.rindex</code></a>, but start
searching at the character position given as second argument.
<code class="code"><span class="constructor">String</span>.rindex s c</code> is equivalent to
<code class="code"><span class="constructor">String</span>.rindex_from s (<span class="constructor">String</span>.length s - 1) c</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcontains"></a>contains : <code class="type">string -> char -> bool</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.contains s c</code> tests if character <code class="code">c</code>
appears in the string <code class="code">s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcontains_from"></a>contains_from : <code class="type">string -> int -> char -> bool</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.contains_from s start c</code> tests if character <code class="code">c</code>
appears in the substring of <code class="code">s</code> starting from <code class="code">start</code> to the end
of <code class="code">s</code>.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">start</code> is not a valid index of <code class="code">s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrcontains_from"></a>rcontains_from : <code class="type">string -> int -> char -> bool</code></pre><div class="info">
<code class="code"><span class="constructor">String</span>.rcontains_from s stop c</code> tests if character <code class="code">c</code>
appears in the substring of <code class="code">s</code> starting from the beginning
of <code class="code">s</code> to index <code class="code">stop</code>.
Raise <code class="code"><span class="constructor">Invalid_argument</span></code> if <code class="code">stop</code> is not a valid index of <code class="code">s</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALuppercase"></a>uppercase : <code class="type">string -> string</code></pre><div class="info">
Return a copy of the argument, with all lowercase letters
translated to uppercase, including accented letters of the ISO
Latin-1 (8859-1) character set.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlowercase"></a>lowercase : <code class="type">string -> string</code></pre><div class="info">
Return a copy of the argument, with all uppercase letters
translated to lowercase, including accented letters of the ISO
Latin-1 (8859-1) character set.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcapitalize"></a>capitalize : <code class="type">string -> string</code></pre><div class="info">
Return a copy of the argument, with the first character set to uppercase.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALuncapitalize"></a>uncapitalize : <code class="type">string -> string</code></pre><div class="info">
Return a copy of the argument, with the first character set to lowercase.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t = <code class="type">string</code> </pre>
<div class="info">
An alias for the type of strings.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcompare"></a>compare : <code class="type"><a href="String.html#TYPEt">t</a> -> <a href="String.html#TYPEt">t</a> -> int</code></pre><div class="info">
The comparison function for strings, with the same specification as
<a href="Pervasives.html#VALcompare"><code class="code">compare</code></a>. Along with the type <code class="code">t</code>, this function <code class="code">compare</code>
allows the module <code class="code"><span class="constructor">String</span></code> to be passed as argument to the functors
<a href="Set.Make.html"><code class="code"><span class="constructor">Set</span>.<span class="constructor">Make</span></code></a> and <a href="Map.Make.html"><code class="code"><span class="constructor">Map</span>.<span class="constructor">Make</span></code></a>.<br>
</div>
</body></html>
|
