collectgarbage()

类型 函数
(全局)
返回值
修订版 发行版本 2024.3703
关键字 垃圾回收、垃圾、内存、资源

概述

一个 Lua 垃圾回收器的通用接口。由于 Lua 具有自动垃圾回收功能,因此无需使用此函数。

语法

collectgarbage( [opt [, arg]] )
opt (必需)

字符串 根据此选项以不同的方式执行垃圾回收函数。可接受的值包括

  • "collect" - 执行一次完整的垃圾回收循环。这是默认选项。
  • "stop" - 停止垃圾回收器。
  • "restart" - 重新启动垃圾回收器。
  • "count" - 返回 Lua 使用的内存总量(以千字节为单位)。
  • "step" - 执行垃圾回收步骤。Lua 中以未指定的方式控制步骤“大小”,其中 arg 值越大,步骤越多。如果你想控制步骤大小,必须以实验的方式调整 arg 的大小。如果步骤完成一次回收循环,则返回 true
  • "setpause" - 将 arg 设置为回收器暂停的新值。返回暂停的上一个值。
  • "setstepmul" - 将 arg 设置为回收器步骤乘数的新值。返回步骤的上一个值。
arg (可选)

任何。 与你为 opt 选择的值直接相关的自变量。许多选项不需要传递自变量。