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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
|
<html>
<head>
<title>io API reference (clojure-contrib)</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<div class="BranchTOC">
<a class="wiki_link" href="#">Branches</a>
<ul id="left-sidebar-branch-list">
<li><a href="index.html" class="wiki_link">master</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li>
</ul>
</div>
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="priority-map-api.html" class="wiki_link">priority-map</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-api.html" class="wiki_link">shell</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/*append*">*append*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/*buffer-size*">*buffer-size*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/*byte-array-type*">*byte-array-type*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/*char-array-type*">*char-array-type*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/*default-encoding*">*default-encoding*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/append-output-stream">append-output-stream</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/append-spit">append-spit</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/append-writer">append-writer</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/as-url">as-url</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/copy">copy</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/delete-file">delete-file</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/delete-file-recursively">delete-file-recursively</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/file">file</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/file-str">file-str</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/input-stream">input-stream</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/make-parents">make-parents</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/output-stream">output-stream</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/pwd">pwd</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/read-lines">read-lines</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/reader">reader</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/relative-path-string">relative-path-string</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/slurp*">slurp*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/spit">spit</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/to-byte-array">to-byte-array</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/with-in-reader">with-in-reader</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/with-out-append-writer">with-out-append-writer</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/with-out-writer">with-out-writer</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/write-lines">write-lines</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.io/writer">writer</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">io</span>
<span id="branch-name">(master branch)</span></h1>
<span id="author-line">by <span id="author-name">Stuart Sierra</span><br /></span>
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.io</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">This file defines polymorphic I/O utility functions for Clojure.
The Streams protocol defines reader, writer, input-stream and
output-stream methods that return BufferedReader, BufferedWriter,
BufferedInputStream and BufferedOutputStream instances (respectively),
with default implementations extended to a variety of argument
types: URLs or filenames as strings, java.io.File's, Sockets, etc.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/*append*">*append*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">If true, writer, output-stream and spit will open files in append mode.
Defaults to false. Instead of binding this var directly, use append-writer,
append-output-stream or append-spit.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L104" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/*buffer-size*">*buffer-size*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Size, in bytes or characters, of the buffer used when
copying streams.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L76" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/*byte-array-type*">*byte-array-type*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Type object for a Java primitive byte array.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L81" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/*char-array-type*">*char-array-type*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Type object for a Java primitive char array.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L85" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/*default-encoding*">*default-encoding*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Name of the default encoding to use when reading & writing.
Default is UTF-8.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L70" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/append-output-stream">append-output-stream</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (append-output-stream x)
</pre>
<pre id="var-docstr">Like output-stream but opens file for appending. Does not work on streams
that are already open.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L277" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/append-spit">append-spit</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (append-spit f content)
</pre>
<pre id="var-docstr">Like spit but appends to file.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L331" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/append-writer">append-writer</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (append-writer x)
</pre>
<pre id="var-docstr">Like writer but opens file for appending. Does not work on streams
that are already open.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L284" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/as-url">as-url</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (as-url arg)
</pre>
<pre id="var-docstr">Coerces argument (URL, URI, or String) to a java.net.URL.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L541" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/copy">copy</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (copy input output)
</pre>
<pre id="var-docstr">Copies input to output. Returns nil.
Input may be an InputStream, Reader, File, byte[], or String.
Output may be an OutputStream, Writer, or File.
Does not close any streams except those it opens itself
(on a File).
Writing a File fails if the parent directory does not exist.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L367" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/delete-file">delete-file</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (delete-file f & [silently])
</pre>
<pre id="var-docstr">Delete file f. Raise an exception if it fails unless silently is true.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L524" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/delete-file-recursively">delete-file-recursively</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (delete-file-recursively f & [silently])
</pre>
<pre id="var-docstr">Delete file f. If it's a directory, recursively delete all its contents.
Raise an exception if any deletion fails unless silently is true.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L531" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/file">file</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (file arg)
(file parent child)
(file parent child & more)
</pre>
<pre id="var-docstr">Returns a java.io.File from string or file args.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L515" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/file-str">file-str</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (file-str & args)
</pre>
<pre id="var-docstr">Concatenates args as strings and returns a java.io.File. Replaces
all / and \ with File/separatorChar. Replaces ~ at the start of
the path with the user.home system property.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L90" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/input-stream">input-stream</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (input-stream x)
</pre>
<pre id="var-docstr">Attempts to coerce its argument into an open java.io.InputStream.
The default implementations of this protocol always return a
java.io.BufferedInputStream.
Default implementations are defined for OutputStream, File, URI, URL,
Socket, byte array, and String arguments.
If the argument is a String, it tries to resolve it first as a URI, then
as a local file name. URIs with a 'file' protocol are converted to
local file names.
Should be used inside with-open to ensure the InputStream is properly
closed.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/make-parents">make-parents</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (make-parents file)
</pre>
<pre id="var-docstr">Creates all parent directories of file.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L463" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/output-stream">output-stream</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (output-stream x)
</pre>
<pre id="var-docstr">Attempts to coerce its argument into an open java.io.OutputStream.
The default implementations of this protocol always return a
java.io.BufferedOutputStream.
Default implementations are defined for OutputStream, File, URI, URL,
Socket, and String arguments.
If the argument is a String, it tries to resolve it first as a URI, then
as a local file name. URIs with a 'file' protocol are converted to
local file names.
Should be used inside with-open to ensure the OutputStream is
properly closed.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/pwd">pwd</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (pwd)
</pre>
<pre id="var-docstr">Returns current working directory as a String. (Like UNIX 'pwd'.)
Note: In Java, you cannot change the current working directory.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L337" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/read-lines">read-lines</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (read-lines f)
</pre>
<pre id="var-docstr">Like clojure.core/line-seq but opens f with reader. Automatically
closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L302" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/reader">reader</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (reader x)
</pre>
<pre id="var-docstr">Attempts to coerce its argument into an open java.io.Reader.
The default implementations of this protocol always return a
java.io.BufferedReader.
Default implementations are provided for Reader, BufferedReader,
InputStream, File, URI, URL, Socket, byte arrays, character arrays,
and String.
If argument is a String, it tries to resolve it first as a URI, then
as a local file name. URIs with a 'file' protocol are converted to
local file names. If this fails, a final attempt is made to resolve
the string as a resource on the CLASSPATH.
Uses *default-encoding* as the text encoding.
Should be used inside with-open to ensure the Reader is properly
closed.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/relative-path-string">relative-path-string</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">Interpret a String or java.io.File as a relative path string.
Building block for clojure.contrib.java/file.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L494" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/slurp*">slurp*</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (slurp* f)
</pre>
<pre id="var-docstr">Like clojure.core/slurp but opens f with reader.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L313" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/spit">spit</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (spit f content)
</pre>
<pre id="var-docstr">Opposite of slurp. Opens f with writer, writes content, then
closes f.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L324" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/to-byte-array">to-byte-array</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (to-byte-array arg)
</pre>
<pre id="var-docstr">Converts argument into a Java byte array. Argument may be
a String, File, InputStream, or Reader. If the argument is already
a byte array, returns it.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L468" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/with-in-reader">with-in-reader</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-in-reader f & body)
</pre>
<pre id="var-docstr">Opens a PushbackReader on f, binds it to *in*, and evaluates body.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L360" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/with-out-append-writer">with-out-append-writer</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-out-append-writer f & body)
</pre>
<pre id="var-docstr">Like with-out-writer but appends to file.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L353" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/with-out-writer">with-out-writer</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-out-writer f & body)
</pre>
<pre id="var-docstr">Opens a writer on f, binds it to *out*, and evalutes body.
Anything printed within body will be written to f.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L345" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/write-lines">write-lines</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (write-lines f lines)
</pre>
<pre id="var-docstr">Writes lines (a seq) to f, separated by newlines. f is opened with
writer, and automatically closed at the end of the sequence.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/io.clj#L291" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.io/writer">writer</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (writer x)
</pre>
<pre id="var-docstr">Attempts to coerce its argument into an open java.io.Writer.
The default implementations of this protocol always return a
java.io.BufferedWriter.
Default implementations are provided for Writer, BufferedWriter,
OutputStream, File, URI, URL, Socket, and String.
If the argument is a String, it tries to resolve it first as a URI, then
as a local file name. URIs with a 'file' protocol are converted to
local file names.
Should be used inside with-open to ensure the Writer is properly
closed.</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>
|
