Object 内置对象

对象 SeekableStream

可移动当前指针的流对象接口

继承关系

%0 object object toString() toJSON() Stream Stream read() write() flush() close() copyTo() object->Stream SeekableStream SeekableStream seek() tell() rewind() size() readAll() truncate() eof() stat() Stream->SeekableStream File File SeekableStream->File MemoryStream MemoryStream SeekableStream->MemoryStream

成员函数

seek

移动文件当前操作位置

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

调用参数:

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

tell

查询流当前位置

1
Long SeekableStream.tell();

返回结果:

  • Long, 返回流当前位置

rewind

移动当前位置到流开头

1
SeekableStream.rewind();

size

查询流尺寸

1
Long SeekableStream.size();

返回结果:

  • Long, 返回流尺寸

readAll

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

1
Buffer SeekableStream.readAll() async;

返回结果:

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

truncate

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

1
SeekableStream.truncate(Long bytes) async;

调用参数:

  • bytes: Long, 新的文件尺寸

eof

查询文件是否到结尾

1
Boolean SeekableStream.eof();

返回结果:

  • Boolean, 返回 True 表示结尾

stat

查询当前文件的基础信息

1
Stat SeekableStream.stat() async;

返回结果:

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

read

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

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

调用参数:

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

返回结果:

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

write

将给定的数据写入流

1
SeekableStream.write(Buffer data) async;

调用参数:

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

flush

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

1
SeekableStream.flush() async;

close

关闭当前流对象

1
SeekableStream.close() async;

copyTo

复制流数据到目标流中

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

调用参数:

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

返回结果:

  • Long, 返回复制的字节数

toString

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

1
String SeekableStream.toString();

返回结果:

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

toJSON

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

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

调用参数:

  • key: String, 未使用

返回结果:

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