物件FileHandle

文件句柄對象

1
var fd = fs.open('test.txt');

繼承關係

成員屬性

fd

Integer, 查詢目前檔案描述符

1
readonly Integer FileHandle.fd;

成員函數

chmod

查詢目前文件的存取權限，Windows 不支援此方法

1
FileHandle.chmod(Integer mode) async;

呼叫參數:

• mode: Integer, 指定設定的存取權限

---

stat

查詢當前文件的基礎信息

1
Stat FileHandle.stat() async;

回傳結果:

• Stat, 返回文件的基礎訊息

---

read

根據檔案描述符，讀取檔案內容

1
2
3
4
Integer FileHandle.read(Buffer buffer,
    Integer offset = 0,
    Integer length = 0,
    Integer position = -1) async;

呼叫參數:

• buffer:Buffer, 讀取結果寫入的Buffer物件
• offset: Integer,Buffer寫入偏移量， 預設為 0
• length: Integer, 檔案讀取位元組數，預設為 0
• position: Integer, 檔案讀取位置，預設為目前檔案位置

回傳結果:

• Integer, 實際讀取的位元組數

---

write

根據文件描述符，寫入內容

1
2
3
4
Integer FileHandle.write(Buffer buffer,
    Integer offset = 0,
    Integer length = -1,
    Integer position = -1) async;

呼叫參數:

• buffer:Buffer, 待寫入的Buffer物件
• offset: Integer,Buffer資料讀取偏移量， 預設為 0
• length: Integer, 檔案寫入位元組數，預設為-1
• position: Integer, 檔案寫入取位置，預設為目前檔案位置

回傳結果:

• Integer, 實際寫入的位元組數

---

根據文件描述符，寫入內容

1
2
3
Integer FileHandle.write(String string,
    Integer position = -1,
    String encoding = "utf8") async;

呼叫參數:

• string: String, 待寫入的字串
• position: Integer, 檔案寫入取位置，預設為目前檔案位置
• encoding: String, 指定解碼方式，預設解碼utf8

回傳結果:

• Integer, 實際寫入的位元組數

---

close

關閉目前文件句柄

1
FileHandle.close() async;

---

toString

傳回物件的字串表示，一般回傳"[Native Object]"，物件可以根據自己的特性重新實現

1
String FileHandle.toString();

回傳結果:

• String, 傳回物件的字串表示

---

toJSON

傳回物件的JSON 格式表示，一般傳回物件定義的可讀屬性集合

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

呼叫參數:

• key: String, 未使用

回傳結果:

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