對象File

文件操作對象，用於二進製文件讀寫

文件操作對像用於對二進製文件進行操作，可使用fs模塊打開和創建文件：

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

繼承關係

成員屬性

name

String, 查詢當前文件名

1
readonly String File.name;

---

fd

Integer, 查詢當前文件描述符

1
readonly Integer File.fd;

---

Integer, 查詢Stream對應的文件描述符值, 由子類實現

1
readonly Integer File.fd;

成員函數

chmod

查詢當前文件的訪問權限，Windows 不支持此方法

1
File.chmod(Integer mode) async;

調用參數:

• mode: Integer, 指定設定的訪問權限

---

seek

移動文件當前操作位置

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

調用參數:

• 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 序列化的值