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
|
<html>
<head>
<title>monadic-io-streams - clojure-contrib v1.3 API documentation</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">
<span class="toc-header"><span id="project-name">clojure-contrib</span> <span id="version">v1.3</span> API</span><br />
<ul>
<li><a class="wiki_link" href="index.html">Overview</a></li>
<li><a class="wiki_link" href="api-index.html">API Index</a></li>
</ul>
<span class="toc-header">Namespaces</span>
<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="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="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="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="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="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="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="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</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-base64-api.html" class="wiki_link">test-base64</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 class="BranchTOC">
<span class="toc-header">Other Versions</span>
<ul id="left-sidebar-branch-list">
<li><a href="../index.html" class="wiki_link">v1.2 (stable)</a></li><li><a href="../branch-1.1.x/index.html" class="wiki_link">v1.1 (stable)</a></li>
</ul>
</div>
<a href="http://clojure.org" class="wiki_link">Clojure Home</a>
</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.monadic-io-streams/flush">flush</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/print">print</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/println">println</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/read-char">read-char</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/read-line">read-line</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/read-lines">read-lines</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/skip-chars">skip-chars</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/with-io-streams">with-io-streams</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/with-reader">with-reader</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/with-writer">with-writer</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.monadic-io-streams/write">write</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">monadic-io-streams</span>
- <span id="header-project">clojure-contrib</span> <span id="header-version">v1.3</span> (<span id="header-status">in development</span>)
</h1>
<span id="author-line">by <span id="author-name">Konrad Hinsen</span><br /></span>
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.monadic-io-streams</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Monadic I/O with Java input/output streams
Defines monadic I/O statements to be used in a state monad
with an input or output stream as the state. The macro
monadic-io creates a stream, runs a monadic I/O statement
on it, and closes the stream. This structure permits the
definition of purely functional compound I/O statements
which are applied to streams that can never escape from the
monadic statement sequence.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/flush">flush</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (flush)
</pre>
<pre id="var-docstr">Flush</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L62" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/print">print</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (print obj)
</pre>
<pre id="var-docstr">Print obj</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L67" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/println">println</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (println)
(println obj)
</pre>
<pre id="var-docstr">Print obj followed by a newline</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L72" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/read-char">read-char</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (read-char)
</pre>
<pre id="var-docstr">Read a single character</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L42" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/read-line">read-line</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (read-line)
</pre>
<pre id="var-docstr">Read a single line</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L47" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/read-lines">read-lines</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (read-lines)
</pre>
<pre id="var-docstr">Read all lines and return them in a vector</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L126" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/skip-chars">skip-chars</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (skip-chars n)
</pre>
<pre id="var-docstr">Skip n characters</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L52" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/with-io-streams">with-io-streams</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (with-io-streams io-specs statement)
</pre>
<pre id="var-docstr">Open one or more streams as specified by io-spec, run a monadic
I/O statement on them, and close the streams. io-spec is
a binding-like vector in which each stream is specified by
three element: a keyword by which the stream can be referred to,
the stream mode (:read or :write), and a stream specification as
accepted by clojure.java.io/reader (mode :read) or
clojure.java.io/writer (mode :write). The statement
is run on a state which is a map from keywords to corresponding
streams. Single-stream monadic I/O statements must be wrapped
with clojure.contrib.monads/with-state-field.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L98" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/with-reader">with-reader</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (with-reader reader-spec statement)
</pre>
<pre id="var-docstr">Create a reader from reader-spec, run the monadic I/O statement
on it, and close the reader. reader-spec can be any object accepted
by clojure.java.io/reader.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L82" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/with-writer">with-writer</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (with-writer writer-spec statement)
</pre>
<pre id="var-docstr">Create a writer from writer-spec, run the monadic I/O statement
on it, and close the writer. writer-spec can be any object accepted
by clojure.java.io/writer.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L90" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.monadic-io-streams/write">write</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (write text)
</pre>
<pre id="var-docstr">Write text (a string)</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/2c6c9e3eca8039964b451be38cdf9d7044dd0b06/modules/monadic-io-streams/src/main/clojure/clojure/contrib/monadic_io_streams.clj#L57" id="var-source">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2010 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>
|
