API for string
(master branch)
by
Unknown
Usage:
(ns your-namespace
(:require clojure.contrib.string))
Overview
Public Variables and Functions
as-str
function
Usage: (as-str)
(as-str x)
(as-str x & ys)
Like clojure.core/str, but if an argument is a keyword or symbol,
its name will be used instead of its literal representation.
Example:
(str :foo :bar) ;;=> ":foo:bar"
(as-str :foo :bar) ;;=> "foobar"
Note that this does not apply to keywords or symbols nested within
data structures; they will be rendered as with str.
Example:
(str {:foo :bar}) ;;=> "{:foo :bar}"
(as-str {:foo :bar}) ;;=> "{:foo :bar}"
Source
blank?
function
Usage: (blank? s)
True if s is nil, empty, or contains only whitespace.
Source
butlast
function
Usage: (butlast n s)
Returns s without the last n characters. Returns an empty string
if n is greater than the length of s.
Source
capitalize
function
Usage: (capitalize s)
Converts first character of the string to upper-case, all other
characters to lower-case.
Source
chomp
function
Usage: (chomp s)
Removes all trailing newline \n or return \r characters from
string. Note: String.trim() is similar and faster.
Source
chop
function
Usage: (chop s)
Removes the last character of string, does nothing on a zero-length
string.
Source
codepoints
function
Usage: (codepoints s)
Returns a sequence of integer Unicode code points in s. Handles
Unicode supplementary characters (above U+FFFF) correctly.
Source
dochars
macro
Usage: (dochars bindings & body)
bindings => [name string]
Repeatedly executes body, with name bound to each character in
string. Does NOT handle Unicode supplementary characters (above
U+FFFF).
Source
docodepoints
macro
Usage: (docodepoints bindings & body)
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.
Source
drop
function
Usage: (drop n s)
Drops first n characters from s. Returns an empty string if n is
greater than the length of s.
Source
escape
function
Usage: (escape cmap s)
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.
Source
get
function
Usage: (get s i)
Gets the i'th character in string.
Source
grep
function
Usage: (grep re coll)
Filters elements of coll by a regular expression. The String
representation (with str) of each element is tested with re-find.
Source
join
function
Usage: (join separator coll)
Returns a string of all elements in coll, separated by
separator. Like Perl's join.
Source
lower-case
function
Usage: (lower-case s)
Converts string to all lower-case.
Source
ltrim
function
Usage: (ltrim s)
Removes whitespace from the left side of string.
Source
map-str
function
Usage: (map-str f coll)
Apply f to each element of coll, concatenate all results into a
String.
Source
partition
function
Usage: (partition re s)
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 #"[a-z]+" "abc123def")
returns: ("" "abc" "123" "def")
Source
repeat
function
Usage: (repeat n s)
Returns a new String containing s repeated n times.
Source
replace-by
function
Usage: (replace-by re f s)
Replaces all matches of re in s with the result of
(f (re-groups the-match)).
Source
replace-char
function
Usage: (replace-char a b s)
Replaces all instances of character a with character b in s.
Source
replace-first-by
function
Usage: (replace-first-by re f s)
Replace first match of re in s with the result of
(f (re-groups the-match)).
Source
replace-first-re
function
Usage: (replace-first-re re replacement s)
Replace first match of re in s.
Source
replace-first-str
function
Usage: (replace-first-str a b s)
Replace first occurance of substring a with b in s.
Source
replace-re
function
Usage: (replace-re re replacement s)
Replaces all matches of re with replacement in s.
Source
replace-str
function
Usage: (replace-str a b s)
Replaces all instances of substring a with b in s.
Source
reverse
function
Usage: (reverse s)
Returns s with its characters reversed.
Source
rtrim
function
Usage: (rtrim s)
Removes whitespace from the right side of string.
Source
split
function
Usage: (split re s)
(split re limit s)
Splits string on a regular expression. Optional argument limit is
the maximum number of splits.
Source
split-lines
function
Usage: (split-lines s)
Splits s on \n or \r\n.
Source
substring?
function
Usage: (substring? substring s)
True if s contains the substring.
Source
swap-case
function
Usage: (swap-case s)
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.
Source
tail
function
Usage: (tail n s)
Returns the last n characters of s.
Source
take
function
Usage: (take n s)
Take first n characters from s, up to the length of s.
Source
trim
function
Usage: (trim s)
Removes whitespace from both ends of string.
Source
upper-case
function
Usage: (upper-case s)
Converts string to all upper-case.
Source