diff options
author | Tom Faulhaber <git_net@infolace.com> | 2009-08-17 00:11:22 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2009-08-17 00:11:22 -0700 |
commit | 3ce40658ed003ba07d45f91e4e94a30d621274be (patch) | |
tree | cbb1f3d063c792c2022321a31b6eb0132f0db431 /duck-streams-api.html | |
parent | e69a3d7ade498c867d234949b22c885286b44fa6 (diff) |
Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc9b9d
Diffstat (limited to 'duck-streams-api.html')
-rw-r--r-- | duck-streams-api.html | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/duck-streams-api.html b/duck-streams-api.html index c9402c11..02ea16cc 100644 --- a/duck-streams-api.html +++ b/duck-streams-api.html @@ -1,6 +1,6 @@ <html> <head> - <title>clojure contrib - duck-streams API reference</title> + <title>duck-streams API reference (clojure.contrib)</title> <link href="file/view/favicon.png" rel="icon" /> <link href="file/view/favicon.png" rel="shortcut icon" /> <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" /> @@ -120,6 +120,7 @@ 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="duck-streams/*append-to-writer*">*append-to-writer*</h2> <span id="var-type">var</span><br /> @@ -128,6 +129,7 @@ or "just-give-me-a-stream", but ducks are funnier.</pre> Defaults to false. Use append-writer or append-spit.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L141" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/*buffer-size*">*buffer-size*</h2> <span id="var-type">var</span><br /> @@ -136,6 +138,7 @@ Defaults to false. Use append-writer or append-spit.</pre> copying streams.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L76" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/*byte-array-type*">*byte-array-type*</h2> <span id="var-type">var</span><br /> @@ -143,6 +146,7 @@ copying streams.</pre> <pre id="var-docstr">Type object for a Java primitive byte array.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L81" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/*default-encoding*">*default-encoding*</h2> <span id="var-type">var</span><br /> @@ -151,6 +155,7 @@ copying streams.</pre> Default is UTF-8.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L70" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/append-spit">append-spit</h2> <span id="var-type">function</span><br /> @@ -159,6 +164,7 @@ Default is UTF-8.</pre> <pre id="var-docstr">Like spit but appends to file.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L257" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/append-writer">append-writer</h2> <span id="var-type">function</span><br /> @@ -168,6 +174,7 @@ Default is UTF-8.</pre> that are already open.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L209" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/copy">copy</h2> <span id="var-type">multimethod</span><br /> @@ -183,6 +190,7 @@ Does not close any streams except those it opens itself Writing a File fails if the parent directory does not exist.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L293" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/file-str">file-str</h2> <span id="var-type">function</span><br /> @@ -193,6 +201,7 @@ 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/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L86" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/make-parents">make-parents</h2> <span id="var-type">function</span><br /> @@ -201,6 +210,7 @@ the path with the user.home system property.</pre> <pre id="var-docstr">Creates all parent directories of file.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L380" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/pwd">pwd</h2> <span id="var-type">function</span><br /> @@ -210,6 +220,7 @@ the path with the user.home system property.</pre> Note: In Java, you cannot change the current working directory.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L263" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/read-lines">read-lines</h2> <span id="var-type">function</span><br /> @@ -219,6 +230,7 @@ Note: In Java, you cannot change the current working directory.</pre> closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L228" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/reader">reader</h2> <span id="var-type">multimethod</span><br /> @@ -236,6 +248,7 @@ Should be used inside with-open to ensure the Reader is properly closed.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L100" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/slurp*">slurp*</h2> <span id="var-type">function</span><br /> @@ -244,6 +257,7 @@ closed.</pre> <pre id="var-docstr">Like clojure.core/slurp but opens f with reader.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L239" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/spit">spit</h2> <span id="var-type">function</span><br /> @@ -253,6 +267,7 @@ closed.</pre> closes f.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L250" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/to-byte-array">to-byte-array</h2> <span id="var-type">multimethod</span><br /> @@ -263,6 +278,7 @@ 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/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L385" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/with-in-reader">with-in-reader</h2> <span id="var-type">macro</span><br /> @@ -271,6 +287,7 @@ a byte array, returns it.</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/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L286" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/with-out-append-writer">with-out-append-writer</h2> <span id="var-type">macro</span><br /> @@ -279,6 +296,7 @@ a byte array, returns it.</pre> <pre id="var-docstr">Like with-out-writer but appends to file.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L279" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/with-out-writer">with-out-writer</h2> <span id="var-type">macro</span><br /> @@ -288,6 +306,7 @@ a byte array, returns it.</pre> Anything printed within body will be written to f.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L271" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/write-lines">write-lines</h2> <span id="var-type">function</span><br /> @@ -297,6 +316,7 @@ Anything printed within body will be written to f.</pre> writer, and automatically closed at the end of the sequence.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/94ce3fbbbc180e10fc8f5e4412f68f72cde938c6/src/clojure/contrib/duck_streams.clj#L217" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="duck-streams/writer">writer</h2> <span id="var-type">multimethod</span><br /> |