io - io操作(扩展)#

已适配 Air780E/Air700E Air780EP Air601 Air101/Air103 Air105 ESP32C3 ESP32S3

备注

本页文档由这个文件自动生成。如有错误，请提交issue或帮忙修改后pr，谢谢！

小技巧

示例

-- io模块是lua原生模块,LuatOS增加了一些API
-- 请配合os模块一起使用

-- 只读模式, 打开文件
local fd = io.open("/xxx.txt", "rb")
-- 读写默认,打开文件
local fd = io.open("/xxx.txt", "wb")
-- 写入文件,且截断为0字节
local fd = io.open("/xxx.txt", "wb+")
-- 追加模式
local fd = io.open("/xxx.txt", "a")

-- 若文件打开成功, fd不为nil,否则就是失败了
-- 注意, 刷机时所添加的文件, 均在 /luadb 目录下, 只读
if fd then
  -- 读取指定字节数,如果数据不足,就只返回实际长度的数据
  local data = fd:read(12)
  -- 按行读取
  local line = fd:read("*l")
  -- 全部读取
  local line = fd:read("*a")

  -- 数据写入, 仅w或a模式可调用
  -- 数据需要是字符串, lua的字符串是带长度的,可以包含任何二进制数据
  fd:write("xxxx") 
  -- 以下是写入0x12, 0x13
  fd:write(string.char(0x12, 0x13))

  -- 移动句柄,绝对坐标
  fd:seek(1024, io.SEEK_SET)
  -- 移动句柄,相对坐标
  fd:seek(1024, io.SEEK_CUR)
  -- 移动句柄,反向绝对坐标,从文件结尾往文件头部算
  fd:seek(124, io.SEEK_END)

  -- 执行完操作后,一定要关掉文件
  fd:close()
end

io.exists(path)#

判断文件是否存在

参数

传入值类型	解释
string	文件路径

返回值

返回值类型	解释
bool	存在返回true,否则返回false

例子

log.info("io", "file exists", io.exists("/boottime"))

io.fileSize(path)#

获取文件大小

参数

传入值类型	解释
string	文件路径

返回值

返回值类型	解释
int	文件数据,若文件不存在会返回nil

例子

local fsize = io.fileSize("/bootime")
if fsize and fsize > 1024 then
  log.info("io", "file size", fsize)
end

io.readFile(path, mode, offset, len)#

读取整个文件,请注意内存消耗

参数

传入值类型	解释
string	文件路径
string	读取模式, 默认 “rb”
int	起始位置,默认0
int	读取长度,默认整个文件

返回值

返回值类型	解释
string	文件数据,若文件不存在会返回nil

例子

local data = io.readFile("/bootime")
-- 注意: offset和len参数是 2023.6.6添加的
-- 读取abc.txt, 先跳过128字节, 然后读取512字节数据
local data = io.readFile("/abc.txt", "rb", 128, 512)

io.writeFile(path, data)#

将数据写入文件

参数

传入值类型	解释
string	文件路径
string	数据

返回值

返回值类型	解释
boolean	成功返回true, 否则返回false

例子

io.writeFile("/bootime", "1")

io.fill(buff, offset, len)#

读取文件并填充到zbuff内,但不移动指针位置

参数

传入值类型	解释
userdata	zbuff实体
int	写入的位置,默认是0
int	写入的长度,默认是zbuff的len减去offset

返回值

返回值类型	解释
boolean	成功返回true,否则返回false
int	返回实际读取到的长度，如果小于0也说明是读取失败了

例子

local buff = zbuff.create(1024)
local f = io.open("/sd/test.txt")
if f then
  f:fill(buff)
end

io.mkfs(path)#

格式化文件系统,需指定挂载点

参数

传入值类型	解释
string	挂载点

返回值

返回值类型	解释
bool	成功与否
int	底层返回值

例子

local ret, errio = io.mkfs("/sd")
log.info("fs", "mkfs", ret, errio)

io.mkdir(path)#

创建文件夹

参数

传入值类型	解释
string	需要建立的目录路径

返回值

返回值类型	解释
bool	成功与否
int	底层返回值

例子

local ret, errio = io.mkdir("/data/")
log.info("fs", "mkdir", ret, errio)

io.rmdir(path)#

删除文件夹

参数

传入值类型	解释
string	需要移除的目录路径

返回值

返回值类型	解释
bool	成功与否
int	底层返回值

例子

local ret, errio = io.rmdir("/data/")
log.info("fs", "rmdir", ret, errio)

io.lsdir(path, len, offset)#

列出目录下的文件

参数

传入值类型	解释
string	需要枚举的目录路径
int	最大长度, 默认10, 最高50
int	偏移量, 默认0, 当目录文件很多时分页查询用

返回值

返回值类型	解释
bool	成功与否
int	底层返回值

例子

local ret, data = io.lsdir("/data/", 10, 0)
if ret then
  log.info("fs", "lsdir", json.encode(data))
else
  log.info("fs", "lsdir", "fail", ret, data)
end

io.lsmount()#

列出所有挂载点

参数

无

返回值

返回值类型	解释
table	挂载点列表

例子

local data = io.lsmount()
log.info("fs", "lsmount", json.encode(data))