diff options
Diffstat (limited to 'branch-1.1.x/io-api.html')
| -rw-r--r-- | branch-1.1.x/io-api.html | 425 |
1 files changed, 425 insertions, 0 deletions
diff --git a/branch-1.1.x/io-api.html b/branch-1.1.x/io-api.html new file mode 100644 index 00000000..b23f2048 --- /dev/null +++ b/branch-1.1.x/io-api.html @@ -0,0 +1,425 @@ +<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="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="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="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="shell-api.html" class="wiki_link">shell</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="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-to-writer*">*append-to-writer*</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/*default-encoding*">*default-encoding*</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-file">as-file</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/make-parents">make-parents</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">(1.1.x branch)</span></h1> +by <span id="author">Stuart Sierra</span><br /> +<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 "duck-typed" I/O utility functions for Clojure. +The 'reader' and 'writer' functions will open and return an +instance of java.io.BufferedReader and java.io.PrintWriter, +respectively, for a variety of argument types -- filenames as +strings, URLs, java.io.File's, etc. 'reader' even works on http +URLs. + +Note: this is not really "duck typing" as implemented in languages +like Ruby. A better name would have been "do-what-I-mean-streams" +or "just-give-me-a-stream", but ducks are funnier.</pre> +<br /> +<h2>Public Variables and Functions</h2> +<div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.io/*append-to-writer*">*append-to-writer*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">If true, writer and spit will open files in append mode. +Defaults to false. Use append-writer or append-spit.</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L145" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/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/bacf49256673242bb7ce09b9f5983c27163e5bfc/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/*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/bacf49256673242bb7ce09b9f5983c27163e5bfc/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-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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L264" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L216" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.io/as-file">as-file</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 a java.io.File as a File. Building block +for clojure.contrib.java/file, which you should prefer +in most cases.</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L431" 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">multimethod</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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L465" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.io/copy">copy</h2> + <span id="var-type">multimethod</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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L300" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L448" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L455" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L439" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L86" id="var-source">Source</a> +</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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L387" id="var-source">Source</a> +</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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L270" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L235" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.io/reader">reader</h2> + <span id="var-type">multimethod</span><br /> + <pre id="var-usage">Usage: (reader x) +</pre> + <pre id="var-docstr">Attempts to coerce its argument into an open +java.io.BufferedReader. Argument may be an instance of Reader, +BufferedReader, InputStream, File, URI, URL, Socket, or 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. Uses *default-encoding* as the text encoding. + +Should be used inside with-open to ensure the Reader is properly +closed.</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L101" id="var-source">Source</a> +</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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L418" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L246" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L257" 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">multimethod</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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L392" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L293" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L286" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L278" 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/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L224" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.io/writer">writer</h2> + <span id="var-type">multimethod</span><br /> + <pre id="var-usage">Usage: (writer x) +</pre> + <pre id="var-docstr">Attempts to coerce its argument into an open java.io.PrintWriter +wrapped around a java.io.BufferedWriter. Argument may be an +instance of Writer, PrintWriter, BufferedWriter, OutputStream, File, +URI, URL, Socket, or 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. + +Should be used inside with-open to ensure the Writer is properly +closed.</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/io.clj#L152" id="var-source">Source</a> +</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>
\ No newline at end of file |