221 lines
6.2 KiB
Lua
221 lines
6.2 KiB
Lua
---@meta
|
|
|
|
---
|
|
---
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string)
|
|
---
|
|
---@class stringlib
|
|
string = {}
|
|
|
|
---
|
|
---Returns the internal numeric codes of the characters `s[i], s[i+1], ..., s[j]`.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.byte)
|
|
---
|
|
---@param s string
|
|
---@param i? integer
|
|
---@param j? integer
|
|
---@return integer ...
|
|
---@nodiscard
|
|
function string.byte(s, i, j) end
|
|
|
|
---
|
|
---Returns a string with length equal to the number of arguments, in which each character has the internal numeric code equal to its corresponding argument.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.char)
|
|
---
|
|
---@param byte integer
|
|
---@param ... integer
|
|
---@return string
|
|
---@nodiscard
|
|
function string.char(byte, ...) end
|
|
|
|
---
|
|
---Returns a string containing a binary representation (a *binary chunk*) of the given function.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.dump)
|
|
---
|
|
---@param f async fun(...):...
|
|
---@param strip? boolean
|
|
---@return string
|
|
---@nodiscard
|
|
function string.dump(f, strip) end
|
|
|
|
---
|
|
---Looks for the first match of `pattern` (see [§6.4.1](http://www.lua.org/manual/5.1/manual.html#6.4.1)) in the string.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.find)
|
|
---
|
|
---@param s string
|
|
---@param pattern string
|
|
---@param init? integer
|
|
---@param plain? boolean
|
|
---@return integer start
|
|
---@return integer end
|
|
---@return any ... captured
|
|
---@nodiscard
|
|
function string.find(s, pattern, init, plain) end
|
|
|
|
---
|
|
---Returns a formatted version of its variable number of arguments following the description given in its first argument.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.format)
|
|
---
|
|
---@param s any
|
|
---@param ... any
|
|
---@return string
|
|
---@nodiscard
|
|
function string.format(s, ...) end
|
|
|
|
---
|
|
---Returns an iterator function that, each time it is called, returns the next captures from `pattern` (see [§6.4.1](http://www.lua.org/manual/5.1/manual.html#6.4.1)) over the string s.
|
|
---
|
|
---As an example, the following loop will iterate over all the words from string s, printing one per line:
|
|
---```lua
|
|
--- s =
|
|
---"hello world from Lua"
|
|
--- for w in string.gmatch(s, "%a+") do
|
|
--- print(w)
|
|
--- end
|
|
---```
|
|
---
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.gmatch)
|
|
---
|
|
---@param s string
|
|
---@param pattern string
|
|
---@return fun():string, ...
|
|
---@nodiscard
|
|
function string.gmatch(s, pattern) end
|
|
|
|
---
|
|
---Returns a copy of s in which all (or the first `n`, if given) occurrences of the `pattern` (see [§6.4.1](http://www.lua.org/manual/5.1/manual.html#6.4.1)) have been replaced by a replacement string specified by `repl`.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.gsub)
|
|
---
|
|
---@param s string
|
|
---@param pattern string
|
|
---@param repl string|number|table|function
|
|
---@param n? integer
|
|
---@return string
|
|
---@return integer count
|
|
---@nodiscard
|
|
function string.gsub(s, pattern, repl, n) end
|
|
|
|
---
|
|
---Returns its length.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.len)
|
|
---
|
|
---@param s string
|
|
---@return integer
|
|
---@nodiscard
|
|
function string.len(s) end
|
|
|
|
---
|
|
---Returns a copy of this string with all uppercase letters changed to lowercase.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.lower)
|
|
---
|
|
---@param s string
|
|
---@return string
|
|
---@nodiscard
|
|
function string.lower(s) end
|
|
|
|
---
|
|
---Looks for the first match of `pattern` (see [§6.4.1](http://www.lua.org/manual/5.1/manual.html#6.4.1)) in the string.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.match)
|
|
---
|
|
---@param s string
|
|
---@param pattern string
|
|
---@param init? integer
|
|
---@return any ...
|
|
---@nodiscard
|
|
function string.match(s, pattern, init) end
|
|
|
|
---@version >5.3
|
|
---
|
|
---Returns a binary string containing the values `v1`, `v2`, etc. packed (that is, serialized in binary form) according to the format string `fmt` (see [§6.4.2](http://www.lua.org/manual/5.1/manual.html#6.4.2)) .
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.pack)
|
|
---
|
|
---@param fmt string
|
|
---@param v1 string|number
|
|
---@param ... string|number
|
|
---@return string binary
|
|
---@nodiscard
|
|
function string.pack(fmt, v1, v2, ...) end
|
|
|
|
---@version >5.3
|
|
---
|
|
---Returns the size of a string resulting from `string.pack` with the given format string `fmt` (see [§6.4.2](http://www.lua.org/manual/5.1/manual.html#6.4.2)) .
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.packsize)
|
|
---
|
|
---@param fmt string
|
|
---@return integer
|
|
---@nodiscard
|
|
function string.packsize(fmt) end
|
|
|
|
---
|
|
---Returns a string that is the concatenation of `n` copies of the string `s` separated by the string `sep`.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.rep)
|
|
---
|
|
---@param s string
|
|
---@param n integer
|
|
---@param sep? string
|
|
---@return string
|
|
---@nodiscard
|
|
function string.rep(s, n, sep) end
|
|
|
|
---
|
|
---Returns a string that is the string `s` reversed.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.reverse)
|
|
---
|
|
---@param s string
|
|
---@return string
|
|
---@nodiscard
|
|
function string.reverse(s) end
|
|
|
|
---
|
|
---Returns the substring of the string that starts at `i` and continues until `j`.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.sub)
|
|
---
|
|
---@param s string
|
|
---@param i integer
|
|
---@param j? integer
|
|
---@return string
|
|
---@nodiscard
|
|
function string.sub(s, i, j) end
|
|
|
|
---@version >5.3
|
|
---
|
|
---Returns the values packed in string according to the format string `fmt` (see [§6.4.2](http://www.lua.org/manual/5.1/manual.html#6.4.2)) .
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.unpack)
|
|
---
|
|
---@param fmt string
|
|
---@param s string
|
|
---@param pos? integer
|
|
---@return any ...
|
|
---@return integer offset
|
|
---@nodiscard
|
|
function string.unpack(fmt, s, pos) end
|
|
|
|
---
|
|
---Returns a copy of this string with all lowercase letters changed to uppercase.
|
|
---
|
|
---[View documents](http://www.lua.org/manual/5.1/manual.html#pdf-string.upper)
|
|
---
|
|
---@param s string
|
|
---@return string
|
|
---@nodiscard
|
|
function string.upper(s) end
|
|
|
|
return string
|