Clojure v1.3 API
Namespaces
Other Versions
Clojure Home

API for clojure.string - Clojure v1.3 (legacy)


Full namespace name: clojure.string

Overview











  

  
Public Variables and Functions

  

    

    

    
blank?

    function

    
Usage: (blank? s)


    
True if s is nil, empty, or contains only whitespace.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
capitalize

    function

    
Usage: (capitalize s)


    
Converts first character of the string to upper-case, all other
characters to lower-case.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
escape

    function

    
Usage: (escape s cmap)


    
Return a new string, using cmap to escape each character ch
from s as follows:

If (cmap ch) is nil, append ch to the new string.
If (cmap ch) is non-nil, append (str (cmap ch)) instead.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
join

    function

    
Usage: (join coll)
       (join separator coll)


    
Returns a string of all elements in coll, as returned by (seq coll),
separated by an optional separator.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
lower-case

    function

    
Usage: (lower-case s)


    
Converts string to all lower-case.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
replace

    function

    
Usage: (replace s match replacement)


    
Replaces all instance of match with replacement in s.

match/replacement can be:

string / string
char / char
pattern / (string or function of match).

See also replace-first.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
replace-first

    function

    
Usage: (replace-first s match replacement)


    
Replaces the first instance of match with replacement in s.

match/replacement can be:

char / char
string / string
pattern / (string or function of match).

See also replace-all.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
reverse

    function

    
Usage: (reverse s)


    
Returns s with its characters reversed.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
split

    function

    
Usage: (split s re)
       (split s re limit)


    
Splits string on a regular expression.  Optional argument limit is
the maximum number of splits. Not lazy. Returns vector of the splits.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
split-lines

    function

    
Usage: (split-lines s)


    
Splits s on \n or \r\n.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
trim

    function

    
Usage: (trim s)


    
Removes whitespace from both ends of string.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
trim-newline

    function

    
Usage: (trim-newline s)


    
Removes all trailing newline \n or return \r characters from
string.  Similar to Perl's chomp.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
triml

    function

    
Usage: (triml s)


    
Removes whitespace from the left side of string.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
trimr

    function

    
Usage: (trimr s)


    
Removes whitespace from the right side of string.

    Added in Clojure version 1.2

    
    Source
  

    

    

    
upper-case

    function

    
Usage: (upper-case s)


    
Converts string to all upper-case.

    Added in Clojure version 1.2

    
    Source
  







              

            

          

	

	
      

      
Logo & site design by Tom Hickey.

      Clojure auto-documentation system by Tom Faulhaber.