Ruby 内置函数

由于Kernel模块被Object类包含，因此它的方法在Ruby程序的任何地方都可用。它们可以在没有接收者的情况下被调用（函数形式）。因此，它们通常被称为函数。

此处提供完整的内置函数列表以供参考 -

序号	方法及描述
1	abort 终止程序。如果引发异常（即$！不为nil），则显示其错误消息。
2	Array( obj) 使用to_ary或to_a将obj转换为数组后返回obj。
3	at_exit {...} 注册一个块，以便在程序退出时执行。类似于END语句，但END语句仅注册一次块。
4	autoload( classname, file) 注册一个类classname，以便在第一次使用时从文件加载。classname可以是字符串或符号。
5	binding 返回当前变量和方法绑定。返回的Binding对象可以作为第二个参数传递给eval方法。
6	block_given? 如果方法是用块调用的，则返回true。
7	callcc {\| c\|...} 将Continuation对象c传递给块并执行块。callcc可用于全局退出或循环构造。
8	caller([ n]) 以file:line形式的字符串数组的形式返回当前执行堆栈。如果指定了n，则从第n级开始返回堆栈条目。
9	catch( tag) {...} 捕获在执行其块期间由throw调用的非本地退出。
10	chomp([ rs = $/]) 返回变量$_的值，并删除结尾的换行符，并将结果赋值回$_。换行符字符串的值可以使用rs指定。
11	chomp!([ rs = $/]) 从$_中删除换行符，就地修改字符串。
12	chop 返回$_的值，并删除其最后一个字符（一个字节），并将结果赋值回$_。
13	chop! 从$_中删除最后一个字符，就地修改字符串。
14	eval( str[, scope[, file, line]]) 将str作为Ruby代码执行。可以使用scope指定执行绑定的范围。可以使用file和line指定要编译的代码的文件名和行号。
15	exec( cmd[, arg...]) 通过运行命令cmd替换当前进程。如果指定了多个参数，则命令将不带shell扩展执行。
16	exit([ result = 0]) 退出程序，result作为返回的状态代码。
17	exit!([ result = 0]) 终止程序，绕过退出处理（例如ensure等）。
18	fail(...) 参见raise(...)
19	Float( obj) 将obj转换为浮点数后返回obj。数值对象直接转换；nil转换为0.0；字符串在考虑0x、0b基数前缀的情况下进行转换。其余使用obj.to_f转换。
20	fork fork {...} 创建子进程。在子进程中返回nil，在父进程中返回子进程的ID（整数）。如果指定了块，则在子进程中运行。
21	format( fmt[, arg...]) 参见sprintf。
22	gets([ rs = $/]) 读取命令行中指定的文件名或标准输入中的一行。可以使用rs显式指定记录分隔符字符串。
23	global_variables 返回全局变量名称的数组。
24	gsub( x, y) gsub( x) {...} 将$_中所有与x匹配的字符串替换为y。如果指定了块，则匹配的字符串将替换为块的结果。修改后的结果分配给$_。
25	gsub!( x, y) gsub!( x) {...} 执行与gsub相同的替换，但字符串就地更改。
26	Integer( obj) 将obj转换为整数后返回obj。数值对象直接转换；nil转换为0；字符串在考虑0x、0b基数前缀的情况下进行转换。其余使用obj.to_i转换。
27	lambda {\| x\|...} proc {\| x\|...} lambda proc 将块转换为Proc对象。如果没有指定块，则转换与调用方法关联的块。
28	load( file[, private = false]) 从file加载Ruby程序。与require不同，它不加载扩展库。如果private为true，则程序加载到匿名模块中，从而保护调用程序的命名空间。
29	local_variables 返回局部变量名称的数组。
30	loop {...} 重复一段代码。
31	open( path[, mode = "r"]) open( path[, mode = "r"]) {\| f\|...} 打开一个file。如果指定了块，则使用作为参数传递的打开流执行块。块退出时，文件会自动关闭。如果path以管道\|开头，则以下字符串作为命令运行，并返回与该进程关联的流。
32	p( obj) 使用其inspect方法显示obj（通常用于调试）。
33	print([ arg...]) 将arg打印到$defout。如果没有指定参数，则打印$_的值。
34	printf( fmt[, arg...]) 使用sprintf根据fmt格式化arg，并将结果打印到$defout。有关格式规范的详细信息，请参阅sprintf。
35	proc {\| x\|...} proc 参见lamda。
36	putc( c) 将一个字符打印到默认输出（$defout）。
37	puts([ str]) 将字符串打印到默认输出（$defout）。如果字符串不以换行符结尾，则将换行符追加到字符串。
38	raise(...) fail(...) 引发异常。如果没有指定异常类，则假定为RuntimeError。在rescue子句中不带参数调用raise会重新引发异常。在rescue子句之外这样做会引发无消息的RuntimeError。fail是raise的过时名称。
39	rand([ max = 0]) 生成一个大于或等于0且小于max的伪随机数。如果未指定max或将其设置为0，则返回一个浮点数形式的随机数，该数大于或等于0且小于1。srand可用于初始化伪随机流。
40	readline([ rs = $/]) 等效于gets，除了在读取EOF时引发EOFError异常。
41	readlines([ rs = $/]) 返回一个字符串数组，其中包含作为命令行参数指定的文件名或标准输入的内容。
42	require( lib) 在第一次调用时加载库（包括扩展库）lib。require不会加载同一个库多次。如果在lib中未指定扩展名，则require尝试向其添加.rb、.so等。
43	scan( re) scan( re) {\|x\|...} 等效于$_.scan。
44	select( reads[, writes = nil[, excepts = nil[, timeout = nil]]]) 检查三种类型的IO对象（输入、输出和异常）的状态更改，这些对象作为IO对象的数组传递。对于不需要检查的参数，传递nil。返回一个包含三个元素的数组，其中包含状态发生变化的IO对象的数组。在超时时返回nil。
45	set_trace_func( proc) 设置跟踪处理程序。proc可以是字符串或proc对象。set_trace_func由调试器和分析器使用。
46	sleep([ sec]) 暂停程序执行sec秒。如果未指定sec，则程序将无限期暂停。
47	split([ sep[, max]]) 等效于$_.split。
48	sprintf( fmt[, arg...]) format( fmt[, arg...]) 返回一个字符串，其中arg根据fmt进行格式化。格式规范基本上与C编程语言中sprintf的格式规范相同。fmt中的转换说明符（%后跟转换字段说明符）将替换为相应参数的格式化字符串。下一节将列出转换字段列表。
49	srand([ seed]) 初始化一个随机数数组。如果未指定seed，则使用时间和其他系统信息初始化种子。
50	String( obj) 使用obj.to_s将obj转换为字符串后返回obj。
51	syscall( sys[, arg...]) 调用由数字sys指定的操作系统调用函数。sys的数字和含义与系统相关。
52	system( cmd[, arg...]) 将cmd作为对命令行的调用执行。如果指定了多个参数，则命令将不带shell扩展直接运行。如果返回状态为0（成功），则返回true。
53	sub( x, y) sub( x) {...} 将$_中第一个与x匹配的字符串替换为y。如果指定了块，则匹配的字符串将替换为块的结果。修改后的结果分配给$_。
54	sub!( x, y) sub!( x) {...} 执行与sub相同的替换，但字符串就地更改。
55	test( test, f1[, f2]) 执行由字符test指定的各种文件测试。为了提高可读性，您应该使用File类方法（例如File::readable?）而不是此函数。下一节将列出参数列表。
56	throw( tag[, value = nil]) 跳转到使用符号或字符串tag等待的catch函数。value是要由catch使用的返回值。
57	trace_var( var, cmd) trace_var( var) {...} 设置全局变量的跟踪。变量名称指定为符号。cmd可以是字符串或Proc对象。
58	trap( sig, cmd) trap( sig) {...} 设置信号处理程序。sig 可以是字符串（例如 SIGUSR1）或整数。信号名称中的 SIG 可以省略。EXIT 信号或信号编号 0 的信号处理程序在进程终止之前被调用。
59	untrace_var( var[, cmd]) 移除全局变量的跟踪。如果指定了cmd，则仅移除该命令。

数字函数

以下是与数字相关的内置函数列表。它们应按如下方式使用：

实时演示

#!/usr/bin/ruby

num = 12.40
puts num.floor      # 12
puts num + 10       # 22.40
puts num.integer?   # false  as num is a float.

这将产生以下结果：

12
22.4
false

假设，n 是一个数字：

序号	方法及描述
1	n + num n - num *n num n / num** 执行算术运算：加法、减法、乘法和除法。
2	n % num 返回 n 的模。
3	n num** 指数运算。
4	n.abs 返回 n 的绝对值。
5	n.ceil 返回大于或等于 n 的最小整数。
6	n.coerce( num) 返回一个数组，其中包含 num 和 n，两者都可能转换为允许它们相互运算的类型。用于数值运算符中的自动类型转换。
7	n.divmod( num) 返回一个数组，其中包含将 n 除以 num 得到的商和余数。
8	n.floor 返回小于或等于 n 的最大整数。
9	n.integer? 如果 n 是整数，则返回 true。
10	n.modulo( num) 返回通过将 n 除以 num 并使用floor对商进行舍入得到的模。
11	n.nonzero? 如果 n 不为零，则返回 n，否则返回 nil。
12	n.remainder( num) 返回通过将n除以num并从商中删除小数得到的余数。结果和n始终具有相同的符号。
13	n.round 返回四舍五入到最接近整数的 n。
14	n.truncate 返回 n 作为整数，并删除小数。
15	n.zero? 如果 n 为 0，则返回零。
16	n & num n \| num n ^ num 按位运算：AND、OR、XOR 和反转。
17	n << num n >> num 按位左移和右移。
18	n[num] 返回从最低有效位开始的第num位的数值，即 n[0]。
19	n.chr 返回一个包含字符代码n对应字符的字符串。
20	n.next n.succ 返回紧随 n 之后的下一个整数。等价于 n + 1。
21	n.size 返回n的机器表示中的字节数。
22	n.step( upto, step) {\|n\| ...} 从n迭代到upto，每次递增step。
23	n.times {\|n\| ...} 迭代块n次。
24	n.to_f 将n转换为浮点数。浮点数转换可能会丢失精度信息。
25	n.to_int 转换为整数后返回n。

浮点数函数

以下是专门用于浮点数的 Ruby 内置函数列表。假设我们有一个浮点数f：

序号	方法及描述
1	Float::induced_from(num) 返回将num转换为浮点数的结果。
2	f.finite? 如果f不是无穷大且 f.nan 为假，则返回 true。
3	f.infinite? 如果f为正无穷大，则返回 1；如果为负无穷大，则返回 -1；否则返回 nil。
4	f.nan? 如果f不是有效的 IEEE 浮点数，则返回 true。

数学函数

以下是 Ruby 内置数学函数列表：

序号	方法及描述
1	atan2( x, y) 计算反正切。
2	cos( x) 计算 x 的余弦。
3	exp( x) 计算指数函数（e 的 x 次幂）。
4	frexp( x) 返回一个包含 x 的标准化分数和指数的两个元素数组。
5	ldexp( x, exp) 返回 x 乘以 2 的 exp 次幂的值。
6	log( x) 计算 x 的自然对数。
7	log10( x) 计算 x 的以 10 为底的对数。
8	sin( x) 计算 x 的正弦。
9	sqrt( x) 返回 x 的平方根。x 必须为正数。
10	tan( x) 计算 x 的正切。

转换字段说明符

函数sprintf( fmt[, arg...]) 和 format( fmt[, arg...])返回一个字符串，其中 arg 根据 fmt 进行格式化。格式化规范与 C 编程语言中 sprintf 的格式化规范基本相同。fmt中的转换说明符（% 后跟转换字段说明符）将被相应参数的格式化字符串替换。

序号	说明符 & 描述
1	b 二进制整数
2	c 单个字符
3	d,i 十进制整数
4	e 指数表示法（例如，2.44e6）
5	E 指数表示法（例如，2.44E6）
6	f 浮点数（例如，2.44）
7	g 如果指数小于 -4，则使用 %e，否则使用 %f
8	G 如果指数小于 -4，则使用 %E，否则使用 %f
9	o 八进制整数
10	s 字符串或使用 to_s 转换的任何对象
11	u 无符号十进制整数
12.	x 十六进制整数（例如，39ff）
13	X 十六进制整数（例如，39FF）

Ruby 的 format 支持以下转换说明符：

以下是用法示例：

实时演示

#!/usr/bin/ruby

str = sprintf("%s\n", "abc")   # => "abc\n" (simplest form)
puts str 

str = sprintf("d=%d", 42)      # => "d=42" (decimal output)
puts str 

str = sprintf("%04x", 255)     # => "00ff" (width 4, zero padded)
puts str 

str = sprintf("%8s", "hello")  # => " hello" (space padded)
puts str 

str = sprintf("%.2s", "hello") # => "he" (trimmed by precision)
puts str

这将产生以下结果：

abc
d = 42
00ff
   hello
he

测试函数参数

函数test( test, f1[, f2])执行由字符test指定的以下文件测试之一。为了提高可读性，您应该使用 File 类方法（例如，File::readable?）而不是此函数。

以下是带一个参数的文件测试：

序号	参数 & 描述
1	?r f1 是否可被调用者的有效 uid 读取？
2	?w f1 是否可被调用者的有效 uid 写入？
3	?x f1 是否可被调用者的有效 uid 执行？
4	?o f1 是否归调用者的有效 uid 所有？
5	?R f1 是否可被调用者的真实 uid 读取？
6	?W f1 是否可被调用者的真实 uid 写入？
7	?X f1 是否可被调用者的真实 uid 执行？
8	?O f1 是否归调用者的真实 uid 所有？
9	?e f1 是否存在？
10	?z f1 的长度是否为零？
11	?s f1 的文件大小（如果为 0 则为 nil）
12	?f f1 是否为普通文件？
13	?d f1 是否为目录？
14	?l f1 是否为符号链接？
15	?p f1 是否为命名管道 (FIFO)？
16	?S f1 是否为套接字？
17	?b f1 是否为块设备？
18	?c f1 是否为字符设备？
19	?u f1 是否设置了 setuid 位？
20	?g f1 是否设置了 setgid 位？
21	?k f1 是否设置了粘滞位？
22	?M f1 的上次修改时间。
23	?A f1 的上次访问时间。
24	?C f1 的上次 inode 更改时间。

带两个参数的文件测试如下：

序号	参数 & 描述
1	?= f1 和 f2 的修改时间是否相等？
2	?> f1 的修改时间是否比 f2 新？
3	?< f1 的修改时间是否比 f2 旧？
4	?- f1 是否是 f2 的硬链接？

以下是用法示例。假设 main.rb 存在并具有读、写权限，但没有执行权限：

实时演示

#!/usr/bin/ruby

puts test(?r, "main.rb" )   # => true
puts test(?w, "main.rb" )   # => true
puts test(?x, "main.rb" )   # => false

这将产生以下结果：

true
false
false

打印页面