Object 内置对象

对象 File

文件操作对象,用于二进制文件读写

文件操作对象用于对二进制文件进行操作,可使用 fs 模块打开和创建文件:

1
var f = fs.openFile('test.txt');

继承关系

成员属性

name

String, 查询当前文件名

1
readonly String File.name;

fd

Integer, 查询当前文件描述符

1
readonly Integer File.fd;

成员函数

chmod

查询当前文件的访问权限,Windows 不支持此方法

1
File.chmod(Integer mode) async;

调用参数:

  • mode: Integer, 指定设定的访问权限

seek

移动文件当前操作位置

1 2
File.seek(Long offset, Integer whence);

调用参数:

  • offset: Long, 指定新的位置
  • whence: Integer, 指定位置基准,允许的值为:SEEK_SET, SEEK_CUR, SEEK_END

tell

查询流当前位置

1
Long File.tell();

返回结果:

  • Long, 返回流当前位置

rewind

移动当前位置到流开头

1
File.rewind();

size

查询流尺寸

1
Long File.size();

返回结果:

  • Long, 返回流尺寸

readAll

从流内读取剩余的全部数据

1
Buffer File.readAll() async;

返回结果:

  • Buffer, 返回从流内读取的数据,若无数据可读,或者连接中断,则返回 null

truncate

修改文件尺寸,如果新尺寸小于原尺寸,则文件被截断

1
File.truncate(Long bytes) async;

调用参数:

  • bytes: Long, 新的文件尺寸

eof

查询文件是否到结尾

1
Boolean File.eof();

返回结果:

  • Boolean, 返回 True 表示结尾

stat

查询当前文件的基础信息

1
Stat File.stat() async;

返回结果:

  • Stat, 返回 Stat 对象描述文件信息

read

从流内读取指定大小的数据

1
Buffer File.read(Integer bytes = -1) async;

调用参数:

  • bytes: Integer, 指定要读取的数据量,缺省为读取随机大小的数据块,读出的数据尺寸取决于设备

返回结果:

  • Buffer, 返回从流内读取的数据,若无数据可读,或者连接中断,则返回 null

write

将给定的数据写入流

1
File.write(Buffer data) async;

调用参数:

  • data: Buffer, 给定要写入的数据

flush

将文件缓冲区内容写入物理设备

1
File.flush() async;

close

关闭当前流对象

1
File.close() async;

copyTo

复制流数据到目标流中

1 2
Long File.copyTo(Stream stm, Long bytes = -1) async;

调用参数:

  • stm: Stream, 目标流对象
  • bytes: Long, 复制的字节数

返回结果:

  • Long, 返回复制的字节数

toString

返回对象的字符串表示,一般返回 "[Native Object]",对象可以根据自己的特性重新实现

1
String File.toString();

返回结果:

  • String, 返回对象的字符串表示

toJSON

返回对象的 JSON 格式表示,一般返回对象定义的可读属性集合

1
Value File.toJSON(String key = "");

调用参数:

  • key: String, 未使用

返回结果:

  • Value, 返回包含可 JSON 序列化的值