物件File
檔案操作對象,用於二進位檔案讀寫
文件操作物件用於對二進位檔案進行操作,可使用fs模組開啟和建立檔案:
1var f = fs.openFile('test.txt');
繼承關係
成員屬性
name
String, 查詢目前檔名
1readonly String File.name;
fd
Integer, 查詢目前檔案描述符
1readonly Integer File.fd;
Integer, 查詢Stream對應的文件描述符值, 由子類實現
1readonly Integer File.fd;
成員函數
chmod
查詢目前文件的存取權限,Windows 不支援此方法
1File.chmod(Integer mode) async;
呼叫參數:
- mode: Integer, 指定設定的存取權限
seek
移動文件目前操作位置
1
2File.seek(Long offset,
Integer whence = fs.SEEK_SET);
呼叫參數:
- offset: Long, 指定新的位置
- whence: Integer, 指定位置基準,允許的值為:SEEK_SET, SEEK_CUR, SEEK_END
tell
查詢流目前位置
1Long File.tell();
回傳結果:
- Long, 返回流當前位置
rewind
移動當前位置到流開頭
1File.rewind();
size
查詢流尺寸
1Long File.size();
回傳結果:
- Long, 返回流尺寸
readAll
從流內讀取剩餘的全部數據
1Buffer File.readAll() async;
回傳結果:
- Buffer, 傳回從流內讀取的數據,若無數據可讀,或連線中斷,則傳回null
truncate
修改檔案尺寸,如果新尺寸小於原尺寸,則檔案被截斷
1File.truncate(Long bytes) async;
呼叫參數:
- bytes: Long, 新的文件尺寸
eof
查詢文件是否到結尾
1Boolean File.eof();
回傳結果:
- Boolean, 回傳True 表示結尾
stat
查詢當前文件的基礎信息
1Stat File.stat() async;
回傳結果:
read
從流內讀取指定大小的數據
1Buffer File.read(Integer bytes = -1) async;
呼叫參數:
- bytes: Integer, 指定要讀取的資料量,預設為讀取隨機大小的資料區塊,讀取的資料尺寸取決於設備
回傳結果:
- Buffer, 傳回從流內讀取的數據,若無數據可讀,或連線中斷,則傳回null
write
將給定的資料寫入流
1File.write(Buffer data) async;
呼叫參數:
- data:Buffer, 給定要寫入的數據
flush
將檔案緩衝區內容寫入實體設備
1File.flush() async;
close
關閉目前流對象
1File.close() async;
copyTo
複製流資料到目標流中
1
2Long File.copyTo(Stream stm,
Long bytes = -1) async;
呼叫參數:
- stm:Stream, 目標流對象
- bytes: Long, 複製的位元組數
回傳結果:
- Long, 傳回複製的位元組數
toString
傳回物件的字串表示,一般回傳"[Native Object]",物件可以根據自己的特性重新實現
1String File.toString();
回傳結果:
- String, 傳回物件的字串表示
toJSON
傳回物件的JSON 格式表示,一般傳回物件定義的可讀屬性集合
1Value File.toJSON(String key = "");
呼叫參數:
- key: String, 未使用
回傳結果:
- Value, 傳回包含可JSON 序列化的值