mirror of
https://github.com/carp-lang/Carp.git
synced 2024-10-11 20:49:05 +03:00
1 line
13 KiB
HTML
1 line
13 KiB
HTML
<html><head><meta charset="UTF-8"><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"><link href="carp_style.css" rel="stylesheet"></head><body><div class="content"><div class="logo"><a href="http://github.com/carp-lang/Carp"><img src="logo.png"></a><div class="title">core</div><div class="index"><ul><li><a href="Dynamic.html">Dynamic</a></li><li><a href="Int.html">Int</a></li><li><a href="Long.html">Long</a></li><li><a href="Bool.html">Bool</a></li><li><a href="Float.html">Float</a></li><li><a href="Double.html">Double</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="V2.html">V2</a></li><li><a href="Vector3.html">Vector3</a></li><li><a href="V3.html">V3</a></li><li><a href="VectorN.html">VectorN</a></li><li><a href="VN.html">VN</a></li><li><a href="Geometry.html">Geometry</a></li><li><a href="Statistics.html">Statistics</a></li><li><a href="String.html">String</a></li><li><a href="Char.html">Char</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="Array.html">Array</a></li><li><a href="IO.html">IO</a></li><li><a href="System.html">System</a></li><li><a href="Debug.html">Debug</a></li><li><a href="Test.html">Test</a></li><li><a href="Bench.html">Bench</a></li><li><a href="Map.html">Map</a></li></ul></div></div><h1>String</h1><div class="binder"><a href="#/=" class="anchor"><h3 id="/=">/=</h3></a><div class="description">defn</div><p class="sig">(λ [&String, &String] Bool)</p><p class="doc"></p></div><div class="binder"><a href="#=" class="anchor"><h3 id="=">=</h3></a><div class="description">external</div><p class="sig">(λ [&String, &String] Bool)</p><p class="doc"></p></div><div class="binder"><a href="#allocate" class="anchor"><h3 id="allocate">allocate</h3></a><div class="description">external</div><p class="sig">(λ [Int, Char] String)</p><p class="doc"></p></div><div class="binder"><a href="#alpha?" class="anchor"><h3 id="alpha?">alpha?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Check if a string contains only alpha characters (a-Z).</p></div><div class="binder"><a href="#alphanum?" class="anchor"><h3 id="alphanum?">alphanum?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Checks whether a string is alphanumerical.</p></div><div class="binder"><a href="#append" class="anchor"><h3 id="append">append</h3></a><div class="description">external</div><p class="sig">(λ [&String, &String] String)</p><p class="doc"></p></div><div class="binder"><a href="#char-at" class="anchor"><h3 id="char-at">char-at</h3></a><div class="description">external</div><p class="sig">(λ [&String, Int] Char)</p><p class="doc"></p></div><div class="binder"><a href="#chars" class="anchor"><h3 id="chars">chars</h3></a><div class="description">external</div><p class="sig">(λ [&String] (Array Char))</p><p class="doc"></p></div><div class="binder"><a href="#chomp" class="anchor"><h3 id="chomp">chomp</h3></a><div class="description">defn</div><p class="sig">(λ [&String] String)</p><p class="doc">Trims newline from the end of a string.</p></div><div class="binder"><a href="#collapse-whitespace" class="anchor"><h3 id="collapse-whitespace">collapse-whitespace</h3></a><div class="description">defn</div><p class="sig">(λ [&String] String)</p><p class="doc">Collapse groups of whitespace into single spaces.</p></div><div class="binder"><a href="#concat" class="anchor"><h3 id="concat">concat</h3></a><div class="description">defn</div><p class="sig">(λ [(Ref (Array String))] String)</p><p class="doc">Returns a new string which is the concatenation of the provided `strings`.</p></div><div class="binder"><a href="#copy" class="anchor"><h3 id="copy">copy</h3></a><div class="description">external</div><p class="sig">(λ [&String] String)</p><p class="doc"></p></div><div class="binder"><a href="#count-char" class="anchor"><h3 id="count-char">count-char</h3></a><div class="description">defn</div><p class="sig">(λ [&String, Char] Int)</p><p class="doc">Returns the number of occurrences of `c` in the string `s`.</p></div><div class="binder"><a href="#cstr" class="anchor"><h3 id="cstr">cstr</h3></a><div class="description">external</div><p class="sig">(λ [&String] (Ptr Char))</p><p class="doc"></p></div><div class="binder"><a href="#empty?" class="anchor"><h3 id="empty?">empty?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Check if the string is the empty string.</p></div><div class="binder"><a href="#ends-with?" class="anchor"><h3 id="ends-with?">ends-with?</h3></a><div class="description">defn</div><p class="sig">(λ [&String, &String] Bool)</p><p class="doc"></p></div><div class="binder"><a href="#format" class="anchor"><h3 id="format">format</h3></a><div class="description">external</div><p class="sig">(λ [&String, &String] String)</p><p class="doc"></p></div><div class="binder"><a href="#from-chars" class="anchor"><h3 id="from-chars">from-chars</h3></a><div class="description">external</div><p class="sig">(λ [(Ref (Array Char))] String)</p><p class="doc"></p></div><div class="binder"><a href="#hash" class="anchor"><h3 id="hash">hash</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Int)</p><p class="doc"></p></div><div class="binder"><a href="#head" class="anchor"><h3 id="head">head</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Char)</p><p class="doc">Returns the character at start of string.</p></div><div class="binder"><a href="#hex?" class="anchor"><h3 id="hex?">hex?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Checks whether a string is hexadecimal.</p></div><div class="binder"><a href="#in?" class="anchor"><h3 id="in?">in?</h3></a><div class="description">defn</div><p class="sig">(λ [&String, &String] Bool)</p><p class="doc">Checks whether a string contains another string.</p></div><div class="binder"><a href="#index-of" class="anchor"><h3 id="index-of">index-of</h3></a><div class="description">external</div><p class="sig">(λ [&String, Char] Int)</p><p class="doc"></p></div><div class="binder"><a href="#index-of-from" class="anchor"><h3 id="index-of-from">index-of-from</h3></a><div class="description">external</div><p class="sig">(λ [&String, Char, Int] Int)</p><p class="doc"></p></div><div class="binder"><a href="#join" class="anchor"><h3 id="join">join</h3></a><div class="description">defn</div><p class="sig">(λ [String, (Ref (Array String))] String)</p><p class="doc">Returns a new string which is the concatenation of the provided `strings` separated by string `sep`.</p></div><div class="binder"><a href="#join-with-char" class="anchor"><h3 id="join-with-char">join-with-char</h3></a><div class="description">defn</div><p class="sig">(λ [Char, (Ref (Array String))] String)</p><p class="doc">Returns a new string which is the concatenation of the provided `strings` separated by char `sep`.</p></div><div class="binder"><a href="#length" class="anchor"><h3 id="length">length</h3></a><div class="description">external</div><p class="sig">(λ [&String] Int)</p><p class="doc"></p></div><div class="binder"><a href="#lines" class="anchor"><h3 id="lines">lines</h3></a><div class="description">defn</div><p class="sig">(λ [&String] (Array String))</p><p class="doc">Split a string into lines.</p></div><div class="binder"><a href="#lower?" class="anchor"><h3 id="lower?">lower?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Checks whether a string is all lowercase.</p></div><div class="binder"><a href="#num?" class="anchor"><h3 id="num?">num?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Checks whether a string is numerical.</p></div><div class="binder"><a href="#pad-left" class="anchor"><h3 id="pad-left">pad-left</h3></a><div class="description">defn</div><p class="sig">(λ [Int, Char, &String] String)</p><p class="doc"></p></div><div class="binder"><a href="#pad-right" class="anchor"><h3 id="pad-right">pad-right</h3></a><div class="description">defn</div><p class="sig">(λ [Int, Char, &String] String)</p><p class="doc"></p></div><div class="binder"><a href="#prefix-string" class="anchor"><h3 id="prefix-string">prefix-string</h3></a><div class="description">defn</div><p class="sig">(λ [&String, Int] String)</p><p class="doc">Return the first `a` characters of the string `s`.</p></div><div class="binder"><a href="#prn" class="anchor"><h3 id="prn">prn</h3></a><div class="description">external</div><p class="sig">(λ [&String] String)</p><p class="doc"></p></div><div class="binder"><a href="#random-sized" class="anchor"><h3 id="random-sized">random-sized</h3></a><div class="description">defn</div><p class="sig">(λ [Int] String)</p><p class="doc"></p></div><div class="binder"><a href="#rehash" class="anchor"><h3 id="rehash">rehash</h3></a><div class="description">defn</div><p class="sig">(λ [&String, Int] Int)</p><p class="doc"></p></div><div class="binder"><a href="#repeat" class="anchor"><h3 id="repeat">repeat</h3></a><div class="description">defn</div><p class="sig">(λ [Int, &String] String)</p><p class="doc">Returns a new string which is `inpt` repeated `n` times.</p></div><div class="binder"><a href="#reverse" class="anchor"><h3 id="reverse">reverse</h3></a><div class="description">defn</div><p class="sig">(λ [&String] String)</p><p class="doc">Produce a new string which is `s` reversed.</p></div><div class="binder"><a href="#split-by" class="anchor"><h3 id="split-by">split-by</h3></a><div class="description">defn</div><p class="sig">(λ [&String, (Ref (Array Char))] (Array String))</p><p class="doc">Split a string by separators.</p></div><div class="binder"><a href="#starts-with?" class="anchor"><h3 id="starts-with?">starts-with?</h3></a><div class="description">defn</div><p class="sig">(λ [&String, &String] Bool)</p><p class="doc">Check if the string `s` ends with the string `sub`.</p></div><div class="binder"><a href="#str" class="anchor"><h3 id="str">str</h3></a><div class="description">external</div><p class="sig">(λ [&String] String)</p><p class="doc"></p></div><div class="binder"><a href="#string-set!" class="anchor"><h3 id="string-set!">string-set!</h3></a><div class="description">external</div><p class="sig">(λ [&String, Int, Char] ())</p><p class="doc"></p></div><div class="binder"><a href="#string-set-at!" class="anchor"><h3 id="string-set-at!">string-set-at!</h3></a><div class="description">external</div><p class="sig">(λ [&String, Int, &String] ())</p><p class="doc"></p></div><div class="binder"><a href="#substring" class="anchor"><h3 id="substring">substring</h3></a><div class="description">defn</div><p class="sig">(λ [&String, Int, Int] String)</p><p class="doc"></p></div><div class="binder"><a href="#suffix-string" class="anchor"><h3 id="suffix-string">suffix-string</h3></a><div class="description">defn</div><p class="sig">(λ [&String, Int] String)</p><p class="doc">Return the last `b` characters of the string `s`.</p></div><div class="binder"><a href="#sum-length" class="anchor"><h3 id="sum-length">sum-length</h3></a><div class="description">defn</div><p class="sig">(λ [(Ref (Array String))] Int)</p><p class="doc">Returns the sum of lengths from an array of Strings.</p></div><div class="binder"><a href="#tail" class="anchor"><h3 id="tail">tail</h3></a><div class="description">external</div><p class="sig">(λ [&String] String)</p><p class="doc"></p></div><div class="binder"><a href="#trim" class="anchor"><h3 id="trim">trim</h3></a><div class="description">defn</div><p class="sig">(λ [&String] String)</p><p class="doc">Trims whitespace from both sides of a string.</p></div><div class="binder"><a href="#trim-left" class="anchor"><h3 id="trim-left">trim-left</h3></a><div class="description">defn</div><p class="sig">(λ [&String] String)</p><p class="doc">Trims whitespace from the left of a string.</p></div><div class="binder"><a href="#trim-right" class="anchor"><h3 id="trim-right">trim-right</h3></a><div class="description">defn</div><p class="sig">(λ [&String] String)</p><p class="doc">Trims whitespace from the right of a string.</p></div><div class="binder"><a href="#upper?" class="anchor"><h3 id="upper?">upper?</h3></a><div class="description">defn</div><p class="sig">(λ [&String] Bool)</p><p class="doc">Checks whether a string is all uppercase.</p></div><div class="binder"><a href="#words" class="anchor"><h3 id="words">words</h3></a><div class="description">defn</div><p class="sig">(λ [&String] (Array String))</p><p class="doc">Split a string into words.</p></div><div class="binder"><a href="#zero" class="anchor"><h3 id="zero">zero</h3></a><div class="description">defn</div><p class="sig">(λ [] String)</p><p class="doc">The empty string.</p></div></div></body></html> |