Utf8

package lua.lib.luautf8

Available on lua

These are all externs for the lua-utf8 library, which functions as an additional set of string tools.

Note that all relevant indexes are "1" based.

Static methods

staticbyte(str:String, ?index:Int):Int

Returns the internal numerical codes of the characters str[index]. Note that numerical codes are not necessarily portable across platforms.

staticchar(codes:Rest<Int>):String

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. Note that numerical codes are not necessarily portable across platforms.

staticcharCodeAt(str:String, index:Int):Int

Returns the character code at position index of str.

staticcodes(str:String):(String, Int) ‑> StringCodePoint

staticfind(str:String, target:String, ?start:Int, ?plain:Bool):StringFind

Looks for the first match of pattern in the string str. If it finds a match, then find returns the indices of str where this occurrence starts and ends.

Parameters:

target	If the target has captures, then in a successful match the captured values are also returned, after the two indices.
start	specifies where to start the search; its default value is 1 and can be negative.
plain	turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered "magic". Note that if plain is given, then start must be given as well.

staticgmatch(str:String, pattern:String):() ‑> String

staticgmatch(str:String, pattern:String, match:() ‑> String, ?n:Int):String ‑> Void

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

staticgsub(str:String, pattern:String, replace:String, ?n:Int):String

staticgsub(str:String, pattern:String, replace:String ‑> Void, ?n:Int):String

staticgsub(str:String, pattern:String, replace:String ‑> String, ?n:Int):String

staticlen(str:String):Int

Receives a string and returns its length. The empty string "" has length 0. Embedded zeros are counted, so "a\000bc\000" has length 5.

staticlower(str:String):String

Receives a string and returns a copy of this string with all uppercase letters changed to lowercase. All other characters are left unchanged. The definition of what an uppercase letter is depends on the current locale.

staticmatch(str:String, pattern:String, ?n:Int):String

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 null. If pattern specifies no captures, then the whole match is returned. The optional argument n specifies where to start the search; its default value is 1 and can be negative.

staticsub(str:String, start:Int, ?end:Int):StringSub

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

staticupper(str:String):String

Receives a string and returns a copy of this string with all lowercase letters changed to uppercase. All other characters are left unchanged. The definition of what a lowercase letter is depends on the current locale.