Public Member Functions
static function	byte (local s, local i, local j)

static function	capitalize (local s)

static function	capwords (local s, local sep)

static function	char (local ...)

static function	dump (local func, local strip)

static function	ends_with (local s, local str)

static function	fileext (local s)

static function	filefolder (local s)

static function	filename (local s, local with_ext)

static function	find (local s, local pattern, local init, local plain)

static function	format (local formatstring, local ...)

static function	gmatch (local s, local pattern)

static function	gsub (local s, local pattern, local repl, local n)

static function	is_ascii_letter (local s)

static function	is_ascii_lowercase (local s)

static function	is_ascii_uppercase (local s)

static function	is_digit (local s)

static function	is_hexdigit (local s)

static function	is_octdigit (local s)

static function	is_printable (local s)

static function	is_punctuation (local s)

static function	is_whitespace (local s)

static function	len (local s)

static function	lower (local s)

static function	match (local s, local pattern, local init)

static function	pack (local fmt, local ...)

static function	packsize (local fmt)

static function	path_uniform (local s)

static function	remove (local s, local pattern)

static function	rep (local s, local n, local sep)

static function	reverse (local s)

static function	starts_with (local s, local str)

static function	sub (local s, local i, local j)

static function	unpack (local fmt, local s, local pos)

static function	upper (local s)

Detailed Description

类型 string 表示一个不可变的字节序列。Lua 对 8 位是友好的：

字符串可以容纳任意 8 位值，其中包含零 ('\0') 。

Lua 的字符串与编码无关；它不关心字符串中具体内容。

字符串库提供了字符串处理的通用函数。

例如字符串查找、子串、模式匹配等。

当在 Lua 中对字符串做索引时，第一个字符从 1 开始计算（而不是 C 里的 0 ）。

索引可以是负数，它指从字符串末尾反向解析。

即，最后一个字符在 -1 位置处，等等。

字符串库中的所有函数都在表 string 中。

它还将其设置为字符串元表的 __index 域。

因此，你可以以面向对象的形式使用字符串函数。

例如，string.byte(s,i) 可以写成 s:byte(i)。

字符串库假定采用单字节字符编码。

Member Function Documentation

◆ byte()

static function byte	(	local	s,
		local	i,
		local	j
	)

返回字符 s[i]，s[i+1]， ...　，s[j] 的内部数字编码。

i 的默认值是 1 ；j的默认值是i`。

这些索引以函数 string.sub 的规则修正。

数字编码没有必要跨平台。

重载: fun(s:string):number

Parameters

s	string
i	number
j	number

Returns: number

◆ capitalize()

static function capitalize ( local s )

Parameters

s string

◆ capwords()

static function capwords	(	local	s,
		local	sep
	)

◆ char()

static function char ( local ... )

接收零或更多的整数。

返回和参数数量相同长度的字符串。

其中每个字符的内部编码值等于对应的参数值。

数字编码没有必要跨平台。

Returns: string

◆ dump()

static function dump	(	local	func,
		local	strip
	)

返回包含有以二进制方式表示的（一个 二进制代码块 ）指定函数的字符串。

之后可以用 load 调用这个字符串获得该函数的副本（但是绑定新的上值）。

如果 strip 为真值，二进制代码块不携带该函数的调试信息

（局部变量名，行号，等等）。

带上值的函数只保存上值的数目。

当（再次）加载时，这些上值被更新为 nil 的实例。

（你可以使用调试库按你需要的方式来序列化上值，并重载到函数中）

Parameters

func	fun()
strip	boolean

Returns: string

重载: fun(func:fun()):string

◆ ends_with()

static function ends_with	(	local	s,
		local	str
	)

Parameters

s	string
str	string

◆ fileext()

static function fileext ( local s )

file extention from path

Parameters

s string

Returns: string

◆ filefolder()

static function filefolder ( local s )

file folder from path

Parameters

s string

Returns: string

◆ filename()

static function filename	(	local	s,
		local	with_ext
	)

filename from path

Parameters

s	string
with_ext	boolean

Returns: string

◆ find()

static function find	(	local	s,
		local	pattern,
		local	init,
		local	plain
	)

查找第一个字符串 s 中匹配到的 pattern 。

如果找到一个匹配，find 会返回 s 中关于它起始及终点位置的索引；

否则，返回 **nil**。

第三个可选数字参数 init 指明从哪里开始搜索；

默认值为 1 ，同时可以是负值。

第四个可选参数 plain 为 true 时，关闭模式匹配机制。

此时函数仅做直接的 “查找子串”的操作，而 pattern 中没有字符被看作魔法字符。

注意，如果给定了 plain　，就必须写上 init 。

如果在模式中定义了捕获，捕获到的若干值也会在两个索引之后返回。

Parameters

s	string
pattern	string
init	number
plain	boolean

Returns: number, number, string

重载: fun(s:string, pattern:string):number, number, string

◆ format()

static function format	(	local	formatstring,
		local ...
	)

返回不定数量参数的格式化版本，格式化串为第一个参数（必须是一个字符串）。

格式化字符串遵循 ISO C 函数 sprintf 的规则。

不同点在于选项 *, h, L, l, n, p 不支持，

另外还增加了一个选项 q。

q 选项将一个字符串格式化为两个双引号括起，对内部字符做恰当的转义处理的字符串。

该字符串可以安全的被 Lua 解释器读回来。

例如，调用

string.format('%q', 'a string with "quotes" and \n new line')

会产生字符串：

"a string with \"quotes\" and \
 
 new line"

选项 A 和 a （如果有的话），E, e, f, G, 和 g 都期待一个对应的数字参数。

选项 c, d, i, o, u, X, 和 x 则期待一个整数。

选项 q 期待一个字符串；

选项 s 期待一个没有内嵌零的字符串。

如果选项 s 对应的参数不是字符串，它会用和 tostring 一致的规则转换成字符串。

Parameters

formatstring string

Returns: string

◆ gmatch()

static function gmatch	(	local	s,
		local	pattern
	)

返回一个迭代器函数。

每次调用这个函数都会继续以 pattern 对 s 做匹配，并返回所有捕获到的值。

如果 pattern 中没有指定捕获，则每次捕获整个 pattern 。

下面这个例子会循环迭代字符串 s 中所有的单词，并逐行打印：

s = "hello world from Lua"
 
for w in string.gmatch(s, "%a+") do
 
  print(w)
 
end

下一个例子从指定的字符串中收集所有的键值对 key=value 置入一张表：

t = {}
 
s = "from=world, to=Lua"
 
for k, v in string.gmatch(s, "(%w+)=(%w+)") do
 
  t[k] = v
 
end

对这个函数来说，模板前开始的 '^' 不会当成锚点。因为这样会阻止迭代。

Parameters

s	string
pattern	string

Returns: fun():string, table

◆ gsub()

static function gsub	(	local	s,
		local	pattern,
		local	repl,
		local	n
	)

将字符串 s 中，所有的（或是在 n 给出时的前 n 个）

pattern 都替换成 repl ，并返回其副本。

repl 可以是字符串、表、或函数。

gsub 还会在第二个返回值返回一共发生了多少次匹配。

gsub 这个名字来源于 Global SUBstitution 。

如果 repl 是一个字符串，那么把这个字符串作为替换品。

字符 % 是一个转义符：

repl 中的所有形式为 d 的串表示第 d 个捕获到的子串，*d* 可以是 1 到 9 。

串 %0 表示整个匹配。

串 %% 表示单个 %。

如果 repl 是一张表，每次匹配时都会用第一个捕获物作为键去查这张表。

如果 repl 是一个函数，则在每次匹配发生时都会调用这个函数。

所有捕获到的子串依次作为参数传入。

任何情况下，模板中没有设定捕获都看成是捕获整个模板。

如果表的查询结果或函数的返回结果是一个字符串或是个数字，都将其作为替换用串；

而在返回 false 或 **nil**　时不作替换（即保留匹配前的原始串）。

这里有一些用例：

x = string.gsub("hello world", "(%w+)", "%1 %1")
 
--> x="hello hello world world"
 
x = string.gsub("hello world", "%w+", "%0 %0", 1)
 
--> x="hello hello world"
 
x = string.gsub("hello world from Lua", "(%w+)%s*(%w+)", "%2 %1")
 
--> x="world hello Lua from"
 
x = string.gsub("home = $HOME, user = $USER", "%$(%w+)", os.getenv)
 
--> x="home = /home/roberto, user = roberto"
 
x = string.gsub("4+5 = $return 4+5$", "%$(.-)%$", function (s)
 
      return load(s)()
 
    end)
 
--> x="4+5 = 9"
 
local t = {name="lua", version="5.3"}
 
x = string.gsub("$name-$version.tar.gz", "%$(%w+)", t)
 
--> x="lua-5.3.tar.gz"

Parameters

s	string
pattern	string
repl	string\|fun()
n	number

Returns: string, number

重载: fun(s:string, pattern:string, repl:string|fun()):string, number

◆ is_ascii_letter()

static function is_ascii_letter ( local s )

◆ is_ascii_lowercase()

static function is_ascii_lowercase ( local s )

◆ is_ascii_uppercase()

static function is_ascii_uppercase ( local s )

◆ is_digit()

static function is_digit ( local s )

◆ is_hexdigit()

static function is_hexdigit ( local s )

◆ is_octdigit()

static function is_octdigit ( local s )

◆ is_printable()

static function is_printable ( local s )

◆ is_punctuation()

static function is_punctuation ( local s )

◆ is_whitespace()

static function is_whitespace ( local s )

◆ len()

static function len ( local s )

接收一个字符串，返回其长度。

空串 "" 的长度为 0 。

内嵌零也统计在内，因此 "a\000bc\000" 的长度为 5 。

Parameters

s string

Returns: number

◆ lower()

static function lower ( local s )

接收一个字符串，将其中的大写字符都转为小写后返回其副本。

其它的字符串不会更改。

对大写字符的定义取决于当前的区域设置。

Parameters

s string

Returns: string

◆ match()

static function match	(	local	s,
		local	pattern,
		local	init
	)

在字符串 s 中找到第一个能用 pattern 匹配到的部分。

如果能找到，match 返回其中的捕获物；否则返回 nil 。

如果 pattern 中未指定捕获，返回整个 pattern 捕获到的串。

第三个可选数字参数 init 指明从哪里开始搜索；

它默认为 1 且可以是负数。

Parameters

s	string
pattern	string
init	number

Returns: any

重载: fun(s:string, pattern:string):any

◆ pack()

static function pack	(	local	fmt,
		local ...
	)

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).

Parameters

fmt string

Returns: string

◆ packsize()

static function packsize ( local fmt )

Returns the size of a string resulting from string.pack with the given format. The format string cannot have the variable-length options 's' or 'z' (see §6.4.2).

Parameters

fmt string

Returns: number

◆ path_uniform()

static function path_uniform ( local s )

Parameters

s string

Returns: string

◆ remove()

static function remove	(	local	s,
		local	pattern
	)

Parameters

s	string
sep	string
s	string

◆ rep()

static function rep	(	local	s,
		local	n,
		local	sep
	)

返回 n 个字符串 s 以字符串 sep

为分割符连在一起的字符串。

默认的 sep 值为空字符串（即没有分割符）。

如果 n 不是正数则返回空串。

Parameters

s	string
n	number
sep	string

Returns: string

重载: fun(s:string, n:number):string

◆ reverse()

static function reverse ( local s )

返回字符串 s 的翻转串。

Parameters

s string

Returns: string

◆ starts_with()

static function starts_with	(	local	s,
		local	str
	)

Parameters

s	string
str	string

◆ sub()

static function sub	(	local	s,
		local	i,
		local	j
	)

返回 s 的子串，该子串从 i 开始到 j 为止； i 和 j 都可以为负数。

如果不给出 j ，就当它是 -1 （和字符串长度相同）。

特别地，调用 string.sub(s,1,j) 可以返回 s 的长度为 j 的前缀串，

而 string.sub(s, -i) 返回长度为 i 的后缀串。

如果在对负数索引转义后 i 小于 1 的话，就修正回 1 。

如果 j 比字符串的长度还大，就修正为字符串长度。

如果在修正之后，i 大于 j，

函数返回空串。

Parameters

s	string
i	number
j	number

Returns: string

重载: fun(s:string, i:number):string

◆ unpack()

static function unpack	(	local	fmt,
		local	s,
		local	pos
	)

Returns the values packed in string s (see string.pack) according to the format string fmt (see §6.4.2). An optional pos marks where to start reading in s (default is 1). After the read values, this function also returns the index of the first unread byte in s.

Parameters

fmt	string
s	string
pos	number optional

◆ upper()

static function upper ( local s )

接收一个字符串，将其中的小写字符都转为大写后返回其副本。

其它的字符串不会更改。

对小写字符的定义取决于当前的区域设置。

Parameters

s string

Returns: string

The documentation for this class was generated from the following files:

lua/string_pack.lua.hpp
luajit/string.lua.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ byte()

◆ capitalize()

◆ capwords()

◆ char()

◆ dump()

◆ ends_with()

◆ fileext()

◆ filefolder()

◆ filename()

◆ find()

◆ format()

◆ gmatch()

◆ gsub()

◆ is_ascii_letter()

◆ is_ascii_lowercase()

◆ is_ascii_uppercase()

◆ is_digit()

◆ is_hexdigit()

◆ is_octdigit()

◆ is_printable()

◆ is_punctuation()

◆ is_whitespace()

◆ len()

◆ lower()

◆ match()

◆ pack()

◆ packsize()

◆ path_uniform()

◆ remove()

◆ rep()

◆ reverse()

◆ starts_with()

◆ sub()

◆ unpack()

◆ upper()