string

From Teverse

Taken from the Lua 5.1 Reference Manual:

String represents arrays of characters. Lua is 8-bit clean: strings can contain any 8-bit character, including embedded zeros ('\0').

Methods

byte

number string.byte(string s, number i, number j)
Returns the internal numerical codes of the characters s[i], s[i+1], ยทยทยท, s[j]. The default value for i is 1; the default value for j is i.

char

string string.char(...)
Receives zero or more integers. Returns a string with length equal to the number of arguments, in which each character has the internal numerical code equal to its corresponding argument.

dump

string string.dump(function f)
Returns a string containing a binary representation of the given function, so that a later loadstring on this string returns a copy of the function. function must be a Lua function without upvalues.

find

string string.find(Looks for, then find, it returns, optional numerical, optional argument, so the, with no, then init)

format

string string.format(string formatString, ...)
Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string). The format string follows the same rules as the printf family of standard C functions. The only differences are that the options/modifiers *, l, L, n, p, and h are not supported and that there is an extra option, q. The q option formats a string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written. For instance, the call.

gmatch

function string.gmatch(string s, string pattern)
Returns an iterator function that, each time it is called, returns the next captures from pattern over string s. If pattern specifies no captures, then the whole match is produced in each call.

gsub

string string.gsub(string s, string pattern, string repl, number n)
Returns a copy of s in which all (or the first n, if given) occurrences of the pattern have been replaced by a replacement string specified by repl, which can be a string, a table, or a function. gsub also returns, as its second value, the total number of matches that occurred.

If repl is a string, then its value is used for replacement. The character % works as an escape character: any sequence in repl of the form %n, with n between 1 and 9, stands for the value of the n-th captured substring (see below). The sequence %0 stands for the whole match. The sequence %% stands for a single %.

If repl is a table, then the table is queried for every match, using the first capture as the key; if the pattern specifies no captures, then the whole match is used as the key.

If repl is a function, then this function is called every time a match occurs, with all captured substrings passed as arguments, in order; if the pattern specifies no captures, then the whole match is passed as a sole argument.

If the value returned by the table query or by the function call is a string or a number, then it is used as the replacement string; otherwise, if it is false or nil, then there is no replacement (that is, the original match is kept in the string).

len

number string.len(string s)
Returns the length of string s. An empty string ("") equals 0.

lower

string string.lower(string s)
Returns string s with all uppercase letters turned into lowercase.

match

string string.match(string s, string pattern, number init)
Looks for the first match of pattern in the string s. If it finds one, then match returns the captures from the pattern; otherwise it returns nil. If pattern specifies no captures, then the whole match is returned. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative.

rep

string string.rep(string s, number n)
Returns a string that is the concatenation of n copies of the string s.

reverse

string string.reverse(string s)
Returns string s in reversed order.
print(string.reverse("Hello world!")) -- !dlrow olleH

sub

string string.sub(string s, number i, number j)
Returns the substring of s that starts at i and continues until j; i and j can be negative. If j is absent, then it is assumed to be equal to -1 (which is the same as the string length). In particular, the call string.sub(s,1,j) returns a prefix of s with length j, and string.sub(s, -i) returns a suffix of s with length i.

upper

string string.upper(string s)
Returns string s with all lowercase letters turned into uppercase.