diff options
Diffstat (limited to 'branch-master/str-utils2-api.html')
| -rw-r--r-- | branch-master/str-utils2-api.html | 578 |
1 files changed, 578 insertions, 0 deletions
diff --git a/branch-master/str-utils2-api.html b/branch-master/str-utils2-api.html new file mode 100644 index 00000000..bb610ed9 --- /dev/null +++ b/branch-master/str-utils2-api.html @@ -0,0 +1,578 @@ +<html> + <head> + <title>str-utils2 - clojure-contrib next 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">next</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="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-complex-numbers-api.html" class="wiki_link">test-complex-numbers</a></li><li><a href="test-core-api.html" class="wiki_link">test-core</a></li><li><a href="test-dataflow-api.html" class="wiki_link">test-dataflow</a></li><li><a href="test-def-api.html" class="wiki_link">test-def</a></li><li><a href="test-fnmap-api.html" class="wiki_link">test-fnmap</a></li><li><a href="test-graph-api.html" class="wiki_link">test-graph</a></li><li><a href="test-greatest-least-api.html" class="wiki_link">test-greatest-least</a></li><li><a href="test-io-api.html" class="wiki_link">test-io</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="test-jmx-api.html" class="wiki_link">test-jmx</a></li><li><a href="test-json-api.html" class="wiki_link">test-json</a></li><li><a href="test-lazy-seqs-api.html" class="wiki_link">test-lazy-seqs</a></li><li><a href="test-logging-api.html" class="wiki_link">test-logging</a></li><li><a href="test-macro-utils-api.html" class="wiki_link">test-macro-utils</a></li><li><a href="test-math-api.html" class="wiki_link">test-math</a></li><li><a href="test-miglayout-api.html" class="wiki_link">test-miglayout</a></li><li><a href="test-mock-api.html" class="wiki_link">test-mock</a></li><li><a href="test-monads-api.html" class="wiki_link">test-monads</a></li><li><a href="test-profile-api.html" class="wiki_link">test-profile</a></li><li><a href="test-properties-api.html" class="wiki_link">test-properties</a></li><li><a href="test-prxml-api.html" class="wiki_link">test-prxml</a></li><li><a href="test-repl-utils-api.html" class="wiki_link">test-repl-utils</a></li><li><a href="test-seq-api.html" class="wiki_link">test-seq</a></li><li><a href="test-shell-api.html" class="wiki_link">test-shell</a></li><li><a href="test-sql-api.html" class="wiki_link">test-sql</a></li><li><a href="test-string-api.html" class="wiki_link">test-string</a></li><li><a href="test-strint-api.html" class="wiki_link">test-strint</a></li><li><a href="test-trace-api.html" class="wiki_link">test-trace</a></li><li><a href="test-with-ns-api.html" class="wiki_link">test-with-ns</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 (beta 1)</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.str-utils2/blank?">blank?</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/butlast">butlast</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/capitalize">capitalize</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/chomp">chomp</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/chop">chop</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/codepoints">codepoints</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/contains?">contains?</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/dochars">dochars</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/docodepoints">docodepoints</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/drop">drop</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/escape">escape</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/get">get</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/grep">grep</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/join">join</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/lower-case">lower-case</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/ltrim">ltrim</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/map-str">map-str</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/partial">partial</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/partition">partition</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/repeat">repeat</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/replace">replace</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/replace-first">replace-first</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/reverse">reverse</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/rtrim">rtrim</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/split">split</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/split-lines">split-lines</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/swap-case">swap-case</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/tail">tail</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/take">take</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/trim">trim</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.str-utils2/upper-case">upper-case</a> + </div> + <br /> + </div> +</div> +</div> + <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">str-utils2</span> + - <span id="header-project">clojure-contrib</span> <span id="header-version">next</span> (<span id="header-status">in development</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.str-utils2</span>)) +</pre><pre> +</pre><h2>Overview</h2> +<pre id="namespace-docstr">This is a library of string manipulation functions. It +is intented as a replacement for clojure.contrib.str-utils. + +You cannot (use 'clojure.contrib.str-utils2) because it defines +functions with the same names as functions in clojure.core. +Instead, do (require '[clojure.contrib.str-utils2 :as s]) +or something similar. + +Goals: + 1. Be functional + 2. String argument first, to work with -> + 3. Performance linear in string length + +Some ideas are borrowed from +<a href="http://github.com/francoisdevlin/devlinsf-clojure-utils/">http://github.com/francoisdevlin/devlinsf-clojure-utils/</a></pre> + +<span class="ns-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span> +<br /> +<h2>Public Variables and Functions</h2> +<div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/blank?">blank?</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (blank? s) +</pre> + <pre id="var-docstr">True if s is nil, empty, or contains only whitespace.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L105" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/butlast">butlast</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (butlast s n) +</pre> + <pre id="var-docstr">Returns s without the last n characters. Returns an empty string +if n is greater than the length of s. + +Note the argument order is the opposite of clojure.core/butlast; +this is to keep the string as the first argument for use with -></pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L131" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/capitalize">capitalize</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (capitalize s) +</pre> + <pre id="var-docstr">Converts first character of the string to upper-case, all other +characters to lower-case.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L288" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/chomp">chomp</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (chomp s) +</pre> + <pre id="var-docstr">Removes all trailing newline \n or return \r characters from +string. Note: String.trim() is similar and faster.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L261" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/chop">chop</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (chop s) +</pre> + <pre id="var-docstr">Removes the last character of string, does nothing on a zero-length +string.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L252" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/codepoints">codepoints</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (codepoints s) +</pre> + <pre id="var-docstr">Returns a sequence of integer Unicode code points in s. Handles +Unicode supplementary characters (above U+FFFF) correctly.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L80" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/contains?">contains?</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (contains? s substring) +</pre> + <pre id="var-docstr">True if s contains the substring.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L367" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/dochars">dochars</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (dochars bindings & body) +</pre> + <pre id="var-docstr">bindings => [name string] + +Repeatedly executes body, with name bound to each character in +string. Does NOT handle Unicode supplementary characters (above +U+FFFF).</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L40" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/docodepoints">docodepoints</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (docodepoints bindings & body) +</pre> + <pre id="var-docstr">bindings => [name string] + +Repeatedly executes body, with name bound to the integer code point +of each Unicode character in the string. Handles Unicode +supplementary characters (above U+FFFF) correctly.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L56" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/drop">drop</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (drop s n) +</pre> + <pre id="var-docstr">Drops first n characters from s. Returns an empty string if n is +greater than the length of s. + +Note the argument order is the opposite of clojure.core/drop; this +is to keep the string as the first argument for use with -></pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L120" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/escape">escape</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (escape s cmap) +</pre> + <pre id="var-docstr">Returns a new String by applying cmap (a function or a map) to each +character in s. If cmap returns nil, the original character is +added to the output unchanged.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L93" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/get">get</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (get s i) +</pre> + <pre id="var-docstr">Gets the i'th character in string.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L372" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/grep">grep</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (grep re coll) +</pre> + <pre id="var-docstr">Filters elements of coll by a regular expression. The String +representation (with str) of each element is tested with re-find.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L320" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/join">join</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (join separator coll) +</pre> + <pre id="var-docstr">Returns a string of all elements in coll, separated by +separator. Like Perl's join.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L246" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/lower-case">lower-case</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (lower-case s) +</pre> + <pre id="var-docstr">Converts string to all lower-case.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L351" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/ltrim">ltrim</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (ltrim s) +</pre> + <pre id="var-docstr">Removes whitespace from the left side of string.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L297" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/map-str">map-str</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (map-str f coll) +</pre> + <pre id="var-docstr">Apply f to each element of coll, concatenate all results into a +String.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L313" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/partial">partial</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (partial f & args) +</pre> + <pre id="var-docstr">Like clojure.core/partial for functions that take their primary +argument first. + +Takes a function f and its arguments, NOT INCLUDING the first +argument. Returns a new function whose first argument will be the +first argument to f. + +Example: (str-utils2/partial str-utils2/take 2) + ;;=> (fn [s] (str-utils2/take s 2))</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L326" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/partition">partition</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (partition s re) +</pre> + <pre id="var-docstr">Splits the string into a lazy sequence of substrings, alternating +between substrings that match the patthern and the substrings +between the matches. The sequence always starts with the substring +before the first match, or an empty string if the beginning of the +string matches. + +For example: (partition "abc123def" #"[a-z]+") +returns: ("" "abc" "123" "def")</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L225" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/repeat">repeat</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (repeat s n) +</pre> + <pre id="var-docstr">Returns a new String containing s repeated n times.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L149" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/replace">replace</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (replace string pattern replacement) +</pre> + <pre id="var-docstr">Replaces all instances of pattern in string with replacement. + +Allowed argument types for pattern and replacement are: + 1. String and String + 2. Character and Character + 3. regex Pattern and String + (Uses java.util.regex.Matcher.replaceAll) + 4. regex Pattern and function + (Calls function with re-groups of each match, uses return + value as replacement.)</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L159" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/replace-first">replace-first</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (replace-first s pattern replacement) +</pre> + <pre id="var-docstr">Replaces the first instance of pattern in s with replacement. + +Allowed argument types for pattern and replacement are: + 1. String and String + 2. regex Pattern and String + (Uses java.util.regex.Matcher.replaceAll) + 3. regex Pattern and function</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L195" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/reverse">reverse</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (reverse s) +</pre> + <pre id="var-docstr">Returns s with its characters reversed.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L154" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/rtrim">rtrim</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (rtrim s) +</pre> + <pre id="var-docstr">Removes whitespace from the right side of string.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L302" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/split">split</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (split s re) + (split s re limit) +</pre> + <pre id="var-docstr">Splits string on a regular expression. Optional argument limit is +the maximum number of splits.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L356" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/split-lines">split-lines</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (split-lines s) +</pre> + <pre id="var-docstr">Splits s on \n or \r\n.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L307" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/swap-case">swap-case</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (swap-case s) +</pre> + <pre id="var-docstr">Changes upper case characters to lower case and vice-versa. +Handles Unicode supplementary characters correctly. Uses the +locale-sensitive String.toUpperCase() and String.toLowerCase() +methods.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L270" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/tail">tail</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (tail s n) +</pre> + <pre id="var-docstr">Returns the last n characters of s.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L142" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/take">take</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (take s n) +</pre> + <pre id="var-docstr">Take first n characters from s, up to the length of s. + +Note the argument order is the opposite of clojure.core/take; this +is to keep the string as the first argument for use with -></pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L110" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/trim">trim</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (trim s) +</pre> + <pre id="var-docstr">Removes whitespace from both ends of string.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L362" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.str-utils2/upper-case">upper-case</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (upper-case s) +</pre> + <pre id="var-docstr">Converts string to all upper-case.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/str-utils2/target/classes/clojure/contrib/str_utils2.clj#L346" 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>
\ No newline at end of file |