text

Measuring, searching, slicing, splitting and joining text. Positions and lengths count Unicode characters, not bytes, and start at 0.

text.from

text.from value -> Text

Converts value to text, the way a template renders it:

A promise gives Undefined. Use text.from to build text out of numbers, since + does not mix types.

text.from 42         # => "42"
text.from 42 + "!"   # => "42!"
text.from (1, TRUE)  # => ("1", "TRUE")

text.size

text.size string -> Numb

Returns the number of characters in string.

text.size "hello"    # => 5
text.size "héllo"    # => 5
text.size ""         # => 0

text.enum

text.enum string -> Tuple

Returns the characters of string as a tuple of one-character texts.

text.enum "abc"      # => ("a", "b", "c")

text.lower

text.lower string -> Text

Returns string with every letter in lower case.

text.lower "TeXL"    # => "texl"

text.upper

text.upper string -> Text

Returns string with every letter in upper case.

text.upper "TeXL"    # => "TEXL"

text.trim

text.trim string -> Text

Returns string without the white space (spaces, tabs, line breaks) at its start and end.

text.trim "  padded  "         # => "padded"

text.trim_head

text.trim_head string -> Text

Returns string without the white space at its start.

text.trim_head "  padded  "    # => "padded  "

text.trim_tail

text.trim_tail string -> Text

Returns string without the white space at its end. It is handy to remove the final line break of an imported document.

text.trim_tail "  padded  "    # => "  padded"

text.find

text.find needle haystack -> Numb

Returns the position of the first occurrence of the text needle in the text haystack, or -1 if there is none.

text.find "l" "hello"          # => 2
text.find "lo" "hello"         # => 3
text.find "z" "hello"          # => -1

text.rfind

text.rfind needle haystack -> Numb

Returns the position of the last occurrence of the text needle in the text haystack, or -1 if there is none.

text.rfind "l" "hello"         # => 3

text.head

text.head n string -> Text

Returns the first n characters of string. A negative n returns all the characters except the last -n. A fractional n is truncated toward zero.

text.head 3 "swanky"           # => "swa"
text.head (-2) "swanky"        # => "swan"
text.head 10 "swan"            # => "swan"

text.tail

text.tail n string -> Text

Returns the characters of string from position n on, that is, all but the first n. A negative n returns the last -n characters. A fractional n is truncated toward zero.

text.tail 4 "swanky"           # => "ky"
text.tail (-3) "swanky"        # => "nky"

Combined with text.rfind, it extracts the end of a path:

path = "docs/guide/intro.texl"
text.tail (text.rfind "/" path + 1) path # => "intro.texl"

text.split

text.split separator string -> Tuple

Splits string at every occurrence of the text separator and returns the parts as a tuple. If separator does not occur, the result is string itself.

text.split "," "a,b,c"         # => ("a", "b", "c")
text.split ", " "red, green"   # => ("red", "green")
text.split "," "abc"           # => "abc"

text.join

text.join separator items -> Text

Joins the texts of the tuple items, putting separator between them. Every item must be a text; otherwise the result is Undefined. items is taken as a whole, so text.join returns a single text.

text.join "-" ("a", "b", "c")  # => "a-b-c"
text.join "" ("a", "b")        # => "ab"
text.join ", " ((1, 2) => text.from)     # => "1, 2"
text.join ", " (list.enum ["x", "y"])    # => "x, y"

To join with line breaks, put a real line break between the quotes, since Swan text has no escapes:

<% text.join "
" ("first", "second") %>

first
second