-
-
Notifications
You must be signed in to change notification settings - Fork 367
/
std.ddoc
337 lines (314 loc) · 15.8 KB
/
std.ddoc
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
BR = <br>
DDOC_DITTO = $(BR)$0
DDOC_SUMMARY = $0$(P)
DDOC_DESCRIPTION = $0$(P)
DDOC_AUTHORS = $(B Authors:)$(BR)$0$(P)
DDOC_BUGS = $(RED BUGS:)$(BR)$0$(P)
DDOC_COPYRIGHT = $(B Copyright:)$(BR)$0$(P)
DDOC_DATE = $(B Date:)$(BR)$0$(P)
DDOC_DEPRECATED = $(RED Deprecated:)$(BR)$0$(P)
DDOC_EXAMPLES = $(B Examples:)$(BR)$0$(P)
DDOC_HISTORY = $(B History:)$(BR)$0$(P)
DDOC_LICENSE = $(B License:)$(BR)$0$(P)
DDOC_RETURNS = $(B Returns:)$(BR)$0$(P)
DDOC_SEE_ALSO = $(B See Also:)$(BR)$0$(P)
DDOC_STANDARDS = $(B Standards:)$(BR)$0$(P)
DDOC_THROWS = $(B Throws:)$(BR)$0$(P)
DDOC_VERSION = $(B Version:)$(BR)$0$(P)
DDOC_SECTION_H = $(B $0)$(BR)
DDOC_SECTION = $0$(P)
DDOC_PARAMS = $(B Parameters:)<table class=parms>$0</table>$(P)
DDOC_BLANKLINE = $(P)
ARGS=$0
D_RUN_CODE =
<div>
<div class="d_code">$1</div>
<div class="d_run_code">
<textarea class="d_code">$4</textarea>
<div class="d_code_stdin"><span class="d_code_title">Standard input</span><br /><textarea class="d_code_stdin">$2</textarea></div>
<div class="d_code_args"><span class="d_code_title">Command line arguments</span><br /><textarea class="d_code_args">$3</textarea></div>
<div class="d_code_output"><span class="d_code_title">Application output</span><br /><textarea class="d_code_output" readonly>Running...</textarea></div>
<input type="button" class="editButton" value="Edit">
<input type="button" class="argsButton" value="Args">
<input type="button" class="inputButton" value="Input">
<input type="button" class="runButton" value="Run">
<input type="button" class="resetButton" value="Reset">
</div>
</div>
DDOC = <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html lang='en-US'>
<!--
Copyright (c) 1999-2010 by Digital Mars
All Rights Reserved Written by Walter Bright
http://www.digitalmars.com
-->
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" >
<title>$(TITLE) - D Programming Language - Digital Mars</title>
<link rel="stylesheet" type="text/css" href="../css/codemirror.css" />
<link rel="stylesheet" type="text/css" href="../css/style.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js" type="text/javascript"></script>
<script src="/js/codemirror-compressed.js"></script>
<script src="/js/run.js" type="text/javascript"></script>
<script type="text/javascript">
function listanchors()
{
if (typeof inhibitQuickIndex !== 'undefined') return;
var a = document.getElementById("quickindex");
if (!a) return;
var newText = "";
var hash = new Array;
var n = 0;
var values = new Array;
// List all anchors.
for (var i = 0; i < document.anchors.length; i++)
{
var a = document.anchors[i];
var text = a.name;
// ignore anchors from DDOC_PSYMBOL
if (text[0] != '.') continue;
if (hash[text] > 0) continue;
hash[text] = 1;
values[n++] = a.name
}
// we won't display the qualifying names to save space, so sort by last name
var lastName = function(a){
var li = a.lastIndexOf('.');
return a.slice(li + 1);
}
values.sort(function(a,b){
return function(aa, bb){
return aa == bb ? 0 : (aa < bb ? -1 : 1);
}(lastName(a).toLowerCase(), lastName(b).toLowerCase());
});
for(var i = 0; i < values.length; i++) {
var a = values[i];
var text = lastName(a);
newText += ' \x3Ca href="\x23' + a +
'"\x3E\x3Cspan class="d_psymbol"\x3E' + text + '\x3C/span\x3E\x3C/a\x3E';
}
if (newText != "") newText = "\x3Cp\x3E\x3Cb\x3EJump to:\x3C/b\x3E" + newText + "\x3C/p\x3E";
var a = document.getElementById("quickindex");
a.innerHTML = newText;
}
jQuery(document).ready(listanchors);
</script>
</head>
<body class='hyphenate'>
<div id="top">
<div id="search-box">
<form method="get" action="http://google.com/search">
<img src="/images/search-left.gif" width="11" height="22" alt=""><input id="q" name="q"><input type="image" id="search-submit" name="submit" src="/images/search-button.gif">
<input type="hidden" id="domains" name="domains" value="dlang.org">
<input type="hidden" id="sourceid" name="sourceid" value="google-search">
<div id="search-dropdown">
<select id="sitesearch" name="sitesearch" size="1">
<option value="dlang.org">Entire D $(VER) Site</option>
<option value="dlang.org/phobos">Library Reference</option>
<option value="www.digitalmars.com/d/archives">Newsgroup Archives</option>
</select>
</div>
</form>
</div>
<div id="header">
<a href="/"><img id="logo" width="125" height="95" border="0" alt="D Logo" src="/images/dlogo.png"></a>
<a id="d-language" href="/">D Programming Language $(VER)</a>
</div>
</div>
<div id="navigation">
$(TOP)
$(NAVIGATION_PHOBOS)
</div><!--/navigation-->
<div id="content">
$(PAGE_TOOLS)
<h1>$(TITLE)</h1>
<div id=quickindex class=quickindex></div>
$(BODY)
</div><!--/content-->
<div id="copyright">
$(COPYRIGHT) |
Page generated by $(LINK2 http://www.digitalmars.com/d/2.0/ddoc.html, Ddoc).
</div>
</body>
</html>
PAGE_TOOLS=
<div id="tools">
<!--span id="lastupdate">Last update $(GEN_DATETIME)</span-->
<span class="tip">
<a href="https://github.com/D-Programming-Language/$(PROJECT)/edit/master/$(SRCFILENAME)" class="button">Improve this page</a>
<span>
Quickly fork, edit online, and submit a pull request for this page.
Requires a signed-in GitHub account. This works well for small changes.
If you'd like to make larger changes you may want to consider using
local clone.
</span>
</span>
<span class="tip">
<a href="http://wiki.dlang.org/DocComments/$(WIKI)" class="button">Page wiki</a>
<span>
View or edit the community-maintained wiki page associated with this page.
</span>
</span>
</div>
TOP=
<div class="navblock">
<form method="get" action="http://www.google.com/search">
<div id="searchbox">
<input name="q" size="10" value="RTL Search" onFocus='if(this.value == "RTL Search"){this.value="";}'>
<input type="hidden" name="domains" value="www.digitalmars.com">
<input type="hidden" name="sitesearch" value="dlang.org/phobos">
<input type="hidden" name="sourceid" value="google-search">
<input type="submit" name="submit" value="Go">
</div>
</form>
<div id="toctop">
$(UL
$(LI <a href="../index.html" title="D Programming Language">D</a>)
$(LI <a href="../spec.html" title="D Language Specification">Language</a>)
$(LI <a href="../phobos/index.html" title="D Runtime Library">Phobos $(LATEST)</a>)
$(LI <a href="../phobos-prerelease/index.html" title="D Runtime Library (prerelease)">Phobos (prerelease)</a>)
$(LI <a href="../comparison.html" title="Language Comparisons">Comparisons</a>)
)
</div>
</div>
NAVIGATION_PHOBOS=
<div class="navblock">
$(UL
$(LI <a href="object.html" title="root of object hierarchy">object</a>)
)
$(H2 <a href="index.html#std" title="D standard modules">std</a>)
$(UL
$(LI <a href="std_algorithm.html" title="General-purpose algorithms">std.algorithm</a>)
$(LI <a href="std_array.html" title="Array functions">std.array</a>)
$(LI <a href="std_ascii.html" title="Functions which operate on ASCII characters">std.ascii</a>)
$(LI <a href="std_base64.html" title="Encode/decode base64 format">std.base64</a>)
$(LI <a href="std_bigint.html" title="Arbitrary-precision ('bignum') arithmetic">std.bigint</a>)
$(LI <a href="std_bitmanip.html" title="Bit-level manipulation">std.bitmanip</a>)
$(LI <a href="std_compiler.html" title="Information about the D compiler implementation">std.compiler</a>)
$(LI <a href="std_complex.html" title="Complex numbers">std.complex</a>)
$(LI <a href="std_concurrency.html" title="Message Passing">std.concurrency</a>)
$(LI <a href="std_container.html" title="Containers">std.container</a>)
$(LI <a href="std_conv.html" title="Conversion of strings to integers">std.conv</a>)
$(LI <a href="std_csv.html" title="CSV file parser">std.csv</a>)
$(LI <a href="std_datetime.html" title="Date and time-related types and functions">std.datetime</a>)
$(LI <a href="std_encoding.html" title="Character and string encoding">std.encoding</a>)
$(LI <a href="std_exception.html" title="Exceptions and error handling">std.exception</a>)
$(LI <a href="std_file.html" title="Basic file operations">std.file</a>)
$(LI <a href="std_format.html" title="Formatted conversions of values to strings">std.format</a>)
$(LI <a href="std_functional.html" title="functional">std.functional</a>)
$(LI <a href="std_getopt.html" title="Command line options">std.getopt</a>)
$(LI <a href="std_json.html" title="JSON reader">std.json</a>)
$(LI <a href="std_math.html" title="the usual math functions">std.math</a>)
$(LI <a href="std_mathspecial.html" title="mathematical special functions">std.mathspecial</a>)
$(LI <a href="std_mmfile.html" title="Memory mapped files">std.mmfile</a>)
$(LI <a href="std_numeric.html" title="Numeric algorithms">std.numeric</a>)
$(LI <a href="std_outbuffer.html" title="Assemble data into an array of bytes">std.outbuffer</a>)
$(LI <a href="std_parallelism.html" title="High-level primitives for SMP parallelism">std.parallelism</a>)
$(LI <a href="std_path.html" title="Manipulate file names, path names, etc.">std.path</a>)
$(LI <a href="std_process.html" title="Create/destroy processes">std.process</a>)
$(LI <a href="std_random.html" title="Random number generation">std.random</a>)
$(LI <a href="std_range.html" title="Ranges">std.range</a>)
$(LI <a href="std_regex.html" title="regular expressions">std.regex</a>)
$(LI <a href="std_signals.html" title="Signals">std.signals</a>)
$(LI <a href="std_socket.html" title="Sockets">std.socket</a>)
$(LI <a href="std_socketstream.html" title="Stream for a blocking, connected Socket">std.socketstream</a>)
$(LI <a href="std_stdio.html" title="Standard I/O">std.stdio</a>)
$(LI <a href="std_cstream.html" title="Stream I/O">std.cstream</a>)
$(LI <a href="std_stream.html" title="Stream I/O">std.stream</a>)
$(LI <a href="std_string.html" title="Basic string operations">std.string</a>)
$(LI <a href="std_system.html" title="Inquire about the CPU, operating system">std.system</a>)
$(LI <a href="std_traits.html" title="Type traits">std.traits</a>)
$(LI <a href="std_typecons.html" title="Type constructors">std.typecons</a>)
$(LI <a href="std_typetuple.html" title="Type tuples">std.typetuple</a>)
$(LI <a href="std_uni.html" title="Unicode classification">std.uni</a>)
$(LI <a href="std_uri.html" title="Encode and decode Uniform Resource Identifiers (URIs)">std.uri</a>)
$(LI <a href="std_utf.html" title="Encode and decode utf character encodings">std.utf</a>)
$(LI <a href="std_uuid.html" title="Generate and use UUIDs">std.uuid</a>)
$(LI <a href="std_variant.html" title="Stores all types in a uniform, dynamically-checked representation">std.variant</a>)
$(LI <a href="std_xml.html" title="XML file processing">std.xml</a>)
$(LI <a href="std_zip.html" title="Read/write zip archives">std.zip</a>)
$(LI <a href="std_zlib.html" title="Compression / Decompression of data">std.zlib</a>)
$(LI <a href="std_net_curl.html" title="High level curl wrapper">std.net.curl</a>)
$(LI <a href="std_net_isemail.html" title="Validate e-mail addresses">std.net.isemail</a>)
$(LI <a href="std_digest_crc.html" title="CRC digest functions">std.digest.crc</a>)
$(LI <a href="std_digest_digest.html" title="API for digest functions">std.digest.digest</a>)
$(LI <a href="std_digest_md.html" title="MD digest functions">std.digest.md</a>)
$(LI <a href="std_digest_ripemd.html" title="RIPEMD digest functions">std.digest.ripemd</a>)
$(LI <a href="std_digest_sha.html" title="SHA digest functions">std.digest.sha</a>)
$(LI <a href="std_windows_charset.html" title="Conversion to/from Windows character sets">std.windows.charset</a>)
)
$(H2 <a href="index.html#etc" title="D etc modules">etc</a>)
$(UL
$(LI <a href="etc_c_curl.html" title="Interface to libcurl library">etc.c.curl</a>)
$(LI <a href="etc_c_sqlite3.html" title="Interface to sqlite3 library">etc.c.sqlite3</a>)
$(LI <a href="etc_c_zlib.html" title="Interface to zlib library">etc.c.zlib</a>)
)
$(H2 <a href="index.html#core" title="D core modules">core</a>)
$(UL
$(LI <a href="core_atomic.html" title="Atomic operations">core.atomic</a>)
$(LI <a href="core_bitop.html" title="Bitwise operations">core.bitop</a>)
$(LI <a href="core_cpuid.html" title="CPU identification">core.cpuid</a>)
$(LI <a href="core_demangle.html" title="D symbol mangling">core.demangle</a>)
$(LI <a href="core_exception.html" title="Root of exception hierarchy">core.exception</a>)
$(LI <a href="core_memory.html" title="Interface to memory management">core.memory</a>)
$(LI <a href="core_runtime.html" title="Interface to D runtime library internals">core.runtime</a>)
$(LI <a href="core_simd.html" title="Builtin SIMD intrinsics">core.simd</a>)
$(LI <a href="core_thread.html" title="Thread management">core.thread</a>)
$(LI <a href="core_time.html" title="Core time functionality">core.time</a>)
$(LI <a href="core_vararg.html" title="Variable function arguments">core.vararg</a>)
$(LI <a href="core_sync_barrier.html" title="Synchronizing progress of a group of threads">core.sync.barrier</a>)
$(LI <a href="core_sync_condition.html" title="Synchronized condition checking">core.sync.condition</a>)
$(LI <a href="core_sync_config.html" title="Stuff for core.sync">core.sync.config</a>)
$(LI <a href="core_sync_exception.html" title="SyncException">core.sync.exception</a>)
$(LI <a href="core_sync_mutex.html" title="Mutexes">core.sync.mutex</a>)
$(LI <a href="core_sync_rwmutex.html" title="R/W mutually exclusive access">core.sync.rwmutex</a>)
$(LI <a href="core_sync_semaphore.html" title="Semaphores">core.sync.semaphore</a>)
)
</div>
RED = <span style="color:red">$0</span>
GREEN = <span style="color:green">$0</span>
BLUE = <span style="color:blue">$0</span>
YELLOW = <span style="color:yellow">$0</span>
BLACK = <span style="color:black">$0</span>
WHITE = <span style="color:white">$0</span>
D_COMMENT = <span class="d_comment">$0</span>
D_STRING = <span class="d_string">$0</span>
D_KEYWORD = <span class="d_keyword">$0</span>
D_PSYMBOL = <span class="d_psymbol">$0</span>
D_PARAM = <span class="d_param">$0</span>
RPAREN = )
LPAREN = (
LESS = <
GREATER = >
HTTP = $(LINK2 http://$1,$2)
HTTPS = $(LINK2 https://$1,$2)
WEB = $(HTTP $1,$2)
LUCKY = $(HTTP
google.com/search?btnI=I%27m+Feeling+Lucky&ie=UTF-8&oe=UTF-8&q=$0,$0)
D = <span class="d_inlinecode">$0</span>
BIGOH = <b><i>Ο</i>(</b>$(D $0)<b><i>)</i></b>
GLOSSARY = $(LINK2 ../glossary.html#$0, $0)
DDOC_PSYMBOL = <a name="$0"></a><span class="ddoc_psymbol">$0</span>
DDOC_ANCHOR = <a name=".$1"></a>
DDOC_DECL = <dt class="d_decl">$0</dt>
XREF = <a href="std_$1.html#$2">$(D std.$1.$2)</a>
CXREF = <a href="core_$1.html#$2">$(D core.$1.$2)</a>
ECXREF = <a href="etc_c_$1.html#$2">$(D etc.c.$1.$2)</a>
LREF = <a href="#$1">$(D $1)</a>
BUGZILLA = $(LINK2 https://issues.dlang.org/show_bug.cgi?id=$0, Bugzilla $0)
PRE = <pre>$0</pre>
PHOBOSSRC=$(LINK2 https://github.com/D-Programming-Language/phobos/blob/master/$0, $0)
DRUNTIMESRC=$(LINK2 https://github.com/D-Programming-Language/druntime/blob/master/src/$0, $0)
SAMPLESRC=$(LINK2 https://github.com/D-Programming-Language/dmd/blob/master/samples/$0, /dmd/samples/d/$0)
BOOKTABLE = <table cellspacing=0 cellpadding=5 class=book><caption>$1</caption>$2</table>
LEADINGROW = <tr class=leadingrow><td colspan=2><b><em> $0</em></b></td></tr>
TABLE = <table cellspacing=0 cellpadding=5><caption>$1</caption>$2</table>
TD = <td valign=top>$0</td>
TDNW = <td valign=top class="donthyphenate" nowrap>$0</td>
SUB_IS_DEPRECATED=kept for compatibility, but collides with SUB=⊂ use SUBSCRIPT instead (this is a comment and can be changed into one if ddoc files ever start supporting comments)
SUB = <sub>$0</sub>
SUPERSCRIPT = <sup>$0</sup>
SUBSCRIPT = <sub>$0</sub>
COPYRIGHT= Copyright © 1999-$(YEAR) by Digital Mars, All Rights Reserved
H2=<h2>$0</h2>