p-string

The string module provides utility functions for string manipulation.

use p-string as s

Query

len[str]

Returns the length of the string.

use p-string as s
s.len[///hello///]  -- 5

contains[str; sub]

Returns true if str contains sub.

use p-string as s
s.contains[///hello world///; ///world///]  -- true

startswith[str; prefix]

Returns true if str starts with prefix.

endswith[str; suffix]

Returns true if str ends with suffix.

use p-string as s
s.startswith[///hello///; ///he///]  -- true
s.endswith[///hello///; ///lo///]    -- true

indexof[str; sub]

Returns the index of the first occurrence of sub in str, or -1 if not found.

use p-string as s
s.indexof[///hello///; ///ll///]  -- 2
s.indexof[///hello///; ///xyz///] -- -1

count[str; sub]

Returns the number of non-overlapping occurrences of sub in str.

use p-string as s
s.count[///banana///; ///an///]  -- 2

Transform

upper[str]

Returns the string converted to uppercase.

lower[str]

Returns the string converted to lowercase.

use p-string as s
s.upper[///hello///]  -- "HELLO"
s.lower[///HELLO///]  -- "hello"

capitalize[str]

Returns the string with the first character capitalized.

title[str]

Returns the string with the first character of each word capitalized.

use p-string as s
s.capitalize[///hello world///]  -- "Hello world"
s.title[///hello world///]       -- "Hello World"

trim[str]

Removes whitespace from both ends.

trimstart[str]

Removes whitespace from the start.

trimend[str]

Removes whitespace from the end.

use p-string as s
s.trim[///  hello  ///]       -- "hello"
s.trimstart[///  hello  ///]  -- "hello  "
s.trimend[///  hello  ///]    -- "  hello"

reverse[str]

Returns the reversed string.

use p-string as s
s.reverse[///hello///]  -- "olleh"

repeat[str; n]

Returns the string repeated n times.

use p-string as s
s.repeat[///ab///; 3]  -- "ababab"

replace[str; old; new]

Replaces all occurrences of old with new.

replacefirst[str; old; new]

Replaces the first occurrence of old with new.

use p-string as s
s.replace[///aabaa///; ///a///; ///x///]       -- "xxbxx"
s.replacefirst[///aabaa///; ///a///; ///x///]   -- "xabaa"

padstart[str; len; fill]

Pads the start of the string to reach len. The fill character defaults to a space.

padend[str; len; fill]

Pads the end of the string to reach len. The fill character defaults to a space.

use p-string as s
s.padstart[///42///; 5; ///0///]  -- "00042"
s.padend[///hi///; 5; ///.///]    -- "hi..."

Split / Join

split[str; sep]

Splits the string by sep and returns an array.

lines[str]

Splits the string by newlines.

words[str]

Splits the string by whitespace, ignoring empty segments.

join[arr; sep]

Joins an array of strings with sep.

chars[str]

Returns an array of individual characters.

use p-string as s
s.split[///a,b,c///; ///,///]   -- ["a", "b", "c"]
s.words[///hello  world///]     -- ["hello", "world"]
s.join[[///a///; ///b///]; ///-///]  -- "a-b"
s.chars[///hi///]               -- ["h", "i"]

Slice

slice[str; start; end]

Returns a substring from start to end (exclusive).

charat[str; i]

Returns the character at index i.

codeat[str; i]

Returns the Unicode code point at index i.

fromcode[code]

Returns the character for the given Unicode code point.

use p-string as s
s.slice[///hello///; 1; 3]   -- "el"
s.charat[///hello///; 0]     -- "h"
s.codeat[///A///; 0]         -- 65
s.fromcode[65]               -- "A"