diff options
Diffstat (limited to 'branch-1.1.x/monadic-io-streams-api.html')
| -rw-r--r-- | branch-1.1.x/monadic-io-streams-api.html | 163 |
1 files changed, 160 insertions, 3 deletions
diff --git a/branch-1.1.x/monadic-io-streams-api.html b/branch-1.1.x/monadic-io-streams-api.html index 894f51c8..93616326 100644 --- a/branch-1.1.x/monadic-io-streams-api.html +++ b/branch-1.1.x/monadic-io-streams-api.html @@ -40,7 +40,7 @@ namespace. <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="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.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</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="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="prxml-api.html" class="wiki_link">prxml</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-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-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="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> + <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="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.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</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="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="prxml-api.html" class="wiki_link">prxml</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-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-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="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> @@ -53,7 +53,29 @@ namespace. <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> @@ -79,7 +101,142 @@ 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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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.contrib.duck-streams/reader (mode :read) or +clojure.contrib.duck-streams/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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.contrib.duck-streams/reader.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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.contrib.duck-streams/writer.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/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/richhickey/clojure-contrib/blob/f9b111c67752220c9d45a7d6ef22c6eecf400c87/src/clojure/contrib/monadic_io_streams.clj#L57" id="var-source">Source</a> +</div> </div> |