Pandoc Lua 过滤器 - pandoc.system 模块
访问系统的相关信息和文件功能。
Fields
arch
程序运行所在的机器架构。( string
)
os
程序运行的操作系统。( string
)
Functions
cputime
cputime ()
返回当前程序使用的 CPU 时间(以微微秒为单位)。该结果的精度可能会在不同版本和平台上有所变化。
返回值
- CPU 时间(以微微秒为单位)(
integer
)
自版本:3.1.1
environment
environment ()
获取整个环境作为一个以字符串索引的表。
返回值
- 一个表,将环境变量名称映射到它们的值。(
table
)
自版本:2.7.3
get_working_directory
get_working_directory ()
获取当前工作目录的绝对路径。
返回值
- 当前工作目录。(
string
)
自版本:2.8
list_directory
list_directory ([directory])
列出目录的内容。
参数 | 描述 |
---|---|
directory |
要列出内容的目录的路径,默认为 . 。( string ) |
返回值
- 包含
directory
中所有条目的表,除了特殊条目(.
和..
)。(table
)
自版本:2.19
make_directory
make_directory (dirname[, create_parent])
创建一个新的、初始为空(或尽可能接近空)的目录。如果无法创建目录(例如,父目录不存在或同名目录已存在),此函数会抛出错误。
如果提供了可选的第二个参数且为真,则会根据需要创建所有目录,包括父目录。
参数 | 描述 |
---|---|
dirname |
新目录的名称。( string ) |
create_parent |
如果需要,创建父目录。( boolean ) |
自版本:2.19
remove_directory
remove_directory (dirname[, recursive])
删除现有且为空的目录。如果提供了recursive
参数,则递归删除目录及其内容。
参数 | 描述 |
---|---|
dirname |
要删除的目录的名称。( string ) |
recursive |
递归删除内容。( boolean ) |
自版本:2.19
with_environment
with_environment (environment, callback)
在自定义环境中运行操作。当调用callback
时,仅设置由environment
给定的环境变量。即使在执行回调操作时发生错误,此函数完成后也会恢复原始环境。
参数 | 描述 |
---|---|
environment |
在运行 callback 之前要设置的环境变量及其值。( table ) |
callback |
在自定义环境中执行的操作。( function ) |
返回值
- 调用
callback
的结果。
自版本:2.7.3
with_temporary_directory
with_temporary_directory (parent_dir, templ, callback)
在给定目录内创建并使用临时目录。回调返回后,该目录会被删除。
参数 | 描述 |
---|---|
parent_dir |
创建目录的父目录。如果省略此参数,则使用系统的标准临时目录。( string ) |
templ |
目录名称模板。( string ) |
callback |
接受临时目录名称作为第一个参数的函数。( function ) |
返回值
- 调用
callback
的结果。
自版本:2.8
with_working_directory
with_working_directory (directory, callback)
在不同的目录中运行操作。此函数将工作目录更改为 directory
,执行 callback
,然后切换回原始工作目录,即使在执行回调操作时发生错误也是如此。
参数 | 描述 |
---|---|
directory |
应在其中执行给定 callback 的目录。( string ) |
callback |
在给定目录中执行的操作。( function ) |
返回值
- 调用
callback
的结果。
自版本:2.7.3