网站如何做推广效果好,免费个人网页模板,建设银行 产品管理中心网站,西安网页设计模板文件管理
该模块提供文件存储管理能力#xff0c;包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。 说明#xff1a; 本模块首批接口从API version 6开始支持。后续版本的新增接口#xff0c;采用上角标单独标记接口的起始版本。 导入模块
impor…文件管理
该模块提供文件存储管理能力包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。 说明 本模块首批接口从API version 6开始支持。后续版本的新增接口采用上角标单独标记接口的起始版本。 导入模块
import fileio from ohos.fileio;使用说明
使用该功能模块对文件/目录进行操作前需要先获取其应用沙箱路径获取方式及其接口用法请参考
import featureAbility from ohos.ability.featureAbility;
let context featureAbility.getContext();
let path ;
context.getFilesDir().then((data) {path data;
})fileio.stat
stat(path: string): Promise
获取文件信息使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待获取文件的应用沙箱路径。
返回值
类型说明Promise[Stat]Promise对象。返回文件的具体信息。
示例
fileio.stat(path).then(function(stat){console.info(getFileInfo succeed: JSON.stringify(stat));
}).catch(function(err){console.info(getFileInfo failed with error: err);
});fileio.stat
stat(path:string, callback:AsyncCallback): void
获取文件信息使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待获取文件的应用沙箱路径。callbackAsyncCallback[Stat]是异步获取文件的信息之后的回调。
示例
fileio.stat(path, function (err, stat) {// example code in Stat
});fileio.statSync
statSync(path:string): Stat
以同步方法获取文件的信息。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待获取文件的应用沙箱路径。
返回值
类型说明[Stat]表示文件的具体信息。
示例
let stat fileio.statSync(path);
// example code in Statfileio.opendir
opendir(path: string): Promise 打开文件目录使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件目录的应用沙箱路径。
返回值
类型说明Promise[Dir]Promise对象。返回Dir对象。
示例
fileio.opendir(path).then(function(dir){console.info(opendir succeed: JSON.stringify(dir));
}).catch(function(err){console.info(opendir failed with error: err);
});fileio.opendir
opendir(path: string, callback: AsyncCallback
): void 打开文件目录使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件目录的应用沙箱路径。callbackAsyncCallback[Dir]是异步打开文件目录之后的回调。
示例
fileio.opendir(path, function (err, dir) { // example code in Dir struct// use read/readSync/close
});fileio.opendirSync
opendirSync(path: string): Dir
以同步方法打开文件目录。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件目录的应用沙箱路径。
返回值
类型说明[Dir]返回Dir对象。
示例
let dir fileio.opendirSync(path);
// example code in Dir struct
// use read/readSync/closefileio.access
access(path: string, mode?: number): Promise
检查当前进程是否可访问某文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待访问文件的应用沙箱路径。modenumber否访问文件时的选项可给定如下选项以按位或的方式使用多个选项默认给定0。 确认当前进程是否具有对应权限 - 0确认文件是否存在。 - 1确认当前进程是否具有可执行权限。 - 2确认当前进程是否具有写权限。 - 4确认当前进程是否具有读权限。
返回值
类型说明PromisePromise对象。无返回值。
示例
fileio.access(path).then(function() {console.info(access succeed);
}).catch(function(err){console.info(access failed with error: err);
});fileio.access
access(path: string, mode: number, callback: AsyncCallback): void
检查当前进程是否可访问某文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待访问文件的应用沙箱路径。modenumber否访问文件时的选项可给定如下选项以按位或的方式使用多个选项默认给定0。 确认当前进程是否具有对应权限 - 0确认文件是否存在。 - 1确认当前进程是否具有可执行权限。 - 2确认当前进程是否具有写权限。 - 4确认当前进程是否具有读权限。callbackAsyncCallback是异步检查当前进程是否可访问某文件之后的回调。
示例
fileio.access(path, function (err) {// do something
});fileio.accessSync
accessSync(path: string, mode?: number): void
以同步方法检查当前进程是否可访问某文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待访问文件的应用沙箱路径。modenumber否访问文件时的选项可给定如下选项以按位或的方式使用多个选项默认给定0。 确认当前进程是否具有对应权限 - 0确认文件是否存在。 - 1确认当前进程是否具有可执行权限。 - 2确认当前进程是否具有写权限。 - 4确认当前进程是否具有读权限。
示例
try {fileio.accessSync(path);
} catch(err) {console.info(accessSync failed with error: err);
}fileio.close7
close(fd: number):Promise
关闭文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待关闭文件的文件描述符。
返回值
类型说明PromisePromise对象。无返回值。
示例
let fd fileio.openSync(path);
fileio.close(fd).then(function(){console.info(close file succeed);
}).catch(function(err){console.info(close file failed with error: err);
});fileio.close7
close(fd: number, callback:AsyncCallback): void
关闭文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待关闭文件的文件描述符。callbackAsyncCallback是异步关闭文件之后的回调。
示例
let fd fileio.openSync(path);
fileio.close(fd, function (err) {// do something
});fileio.closeSync
closeSync(fd: number): void
以同步方法关闭文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待关闭文件的文件描述符。
示例
let fd fileio.openSync(path);
fileio.closeSync(fd);fileio.copyFile
copyFile(src:string | number, dest:string | number, mode?:number):Promise
复制文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明srcstringnumber是deststringnumber是modenumber否mode提供覆盖文件的选项当前仅支持0且默认为0。 0完全覆盖目标文件未覆盖部分将被裁切掉。
返回值
类型说明PromisePromise对象。无返回值。
示例
let src path;
let dest src tgt;
fileio.copyFile(src, dest).then(function(){console.info(copyFile succeed);
}).catch(function(err){console.info(copyFile failed with error: err);
});fileio.copyFile
copyFile(src: string | number, dest: string | number, mode: number, callback: AsyncCallback): void
复制文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明srcstringnumber是deststringnumber是modenumber否mode提供覆盖文件的选项当前仅支持0且默认为0。 0完全覆盖目标文件未覆盖部分将被裁切掉。callbackAsyncCallback是异步复制文件之后的回调。
示例
let src path;
let dest src tgt;
fileio.copyFile(src, dest, function (err) {// do something
});fileio.copyFileSync
copyFileSync(src: string | number, dest: string | number, mode?: number): void
以同步方法复制文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明srcstringnumber是deststringnumber是modenumber否mode提供覆盖文件的选项当前仅支持0且默认为0。 0完全覆盖目标文件未覆盖部分将被裁切掉。
示例
let src path;
let dest src tgt;
fileio.copyFileSync(src, dest);fileio.mkdir
mkdir(path:string, mode?: number): Promise
创建目录使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待创建目录的应用沙箱路径。modenumber否创建目录的权限可给定如下权限以按位或的方式追加权限默认给定0o775。 - 0o775所有者具有读、写及可执行权限其余用户具有读及可执行权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
返回值
类型说明PromisePromise对象。无返回值。
示例
fileio.mkdir(path).then(function() {console.info(mkdir succeed);
}).catch(function (error){console.info(mkdir failed with error: error);
});fileio.mkdir
mkdir(path: string, mode: number, callback: AsyncCallback): void
创建目录使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待创建目录的应用沙箱路径。modenumber否创建目录的权限可给定如下权限以按位或的方式追加权限默认给定0o775。 - 0o775所有者具有读、写及可执行权限其余用户具有读及可执行权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。callbackAsyncCallback是异步创建目录操作完成之后的回调。
示例
fileio.mkdir(path, function(err) {console.info(mkdir succeed);
});fileio.mkdirSync
mkdirSync(path: string, mode?: number): void
以同步方法创建目录。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待创建目录的应用沙箱路径。modenumber否创建目录的权限可给定如下权限以按位或的方式追加权限默认给定0o775。 - 0o775所有者具有读、写及可执行权限其余用户具有读及可执行权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
示例
fileio.mkdirSync(path);fileio.open7
open(path: string, flags?: number, mode?: number): Promise
打开文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。flagsnumber否打开文件的选项必须指定如下选项中的一个默认以只读方式打开 - 0o0只读打开。 - 0o1只写打开。 - 0o2读写打开。 同时也可给定如下选项以按位或的方式追加默认不给定任何额外选项 - 0o100若文件不存在则创建文件。使用该选项时必须指定第三个参数 mode。 - 0o200如果追加了0o100选项且文件已经存在则出错。 - 0o1000如果文件存在且以只写或读写的方式打开文件则将其长度裁剪为零。 - 0o2000以追加方式打开后续写将追加到文件末尾。 - 0o4000如果path指向FIFO、块特殊文件或字符特殊文件则本次打开及后续 IO 进行非阻塞操作。 - 0o200000如果path不指向目录则出错。 - 0o400000如果path指向符号链接则出错。 - 0o4010000以同步IO的方式打开文件。modenumber否若创建文件则指定文件的权限可给定如下权限以按位或的方式追加权限默认给定0o666。 - 0o666所有者具有读、写权限所有用户组具有读、写权限其余用户具有读、写权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
返回值
类型说明PromisePromise对象。返回打开文件的文件描述符。
示例
fileio.open(path, 0o1, 0o0200).then(function(number){console.info(open file succeed);
}).catch(function(err){console.info(open file failed with error: err);
});fileio.open7
open(path: string, flags: number, mode: number, callback: AsyncCallback): void
打开文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。flagsnumber是打开文件的选项必须指定如下选项中的一个默认以只读方式打开 - 0o0只读打开。 - 0o1只写打开。 - 0o2读写打开。 同时也可给定如下选项以按位或的方式追加默认不给定任何额外选项 - 0o100若文件不存在则创建文件。使用该选项时必须指定第三个参数 mode。 - 0o200如果追加了0o100选项且文件已经存在则出错。 - 0o1000如果文件存在且以只写或读写的方式打开文件则将其长度裁剪为零。 - 0o2000以追加方式打开后续写将追加到文件末尾。 - 0o4000如果path指向FIFO、块特殊文件或字符特殊文件则本次打开及后续 IO 进行非阻塞操作。 - 0o200000如果path不指向目录则出错。 - 0o400000如果path指向符号链接则出错。 - 0o4010000以同步IO的方式打开文件。modenumber是若创建文件则指定文件的权限可给定如下权限以按位或的方式追加权限默认给定0o666。 - 0o666所有者具有读、写权限所有用户组具有读、写权限其余用户具有读、写权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。callbackAsyncCallback 是异步打开文件之后的回调。
示例
fileio.open(path, 0, function(err, fd) {// do something
});fileio.openSync
openSync(path:string, flags?:number, mode?:number): number
以同步方法打开文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。flagsnumber否打开文件的选项必须指定如下选项中的一个默认以只读方式打开 - 0o0只读打开。 - 0o1只写打开。 - 0o2读写打开。 同时也可给定如下选项以按位或的方式追加默认不给定任何额外选项 - 0o100若文件不存在则创建文件。使用该选项时必须指定第三个参数 mode。 - 0o200如果追加了0o100选项且文件已经存在则出错。 - 0o1000如果文件存在且以只写或读写的方式打开文件则将其长度裁剪为零。 - 0o2000以追加方式打开后续写将追加到文件末尾。 - 0o4000如果path指向FIFO、块特殊文件或字符特殊文件则本次打开及后续 IO 进行非阻塞操作。 - 0o200000如果path不指向目录则出错。 - 0o400000如果path指向符号链接则出错。 - 0o4010000以同步IO的方式打开文件。modenumber否若创建文件则指定文件的权限可给定如下权限以按位或的方式追加权限默认给定0o666。 - 0o666所有者具有读、写权限所有用户组具有读、写权限其余用户具有读、写权限。 - 0o640所有者具有读、写权限所有用户组具有读权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。 创建出的文件权限受umask影响umask随进程启动确定其修改当前不开放。
返回值
类型说明number打开文件的文件描述符。
示例
let fd fileio.openSync(path, 0o102, 0o640);let fd fileio.openSync(path, 0o102, 0o666);
fileio.writeSync(fd, hello world);
let fd1 fileio.openSync(path, 0o2002);
fileio.writeSync(fd1, hello world);
let num fileio.readSync(fd1, new ArrayBuffer(4096), {position: 0});
console.info(num num);fileio.read
read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; position?: number; }): Promise
从文件读取数据使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待读取文件的文件描述符。bufferArrayBuffer是用于保存读取到的文件数据的缓冲区。optionsObject否支持如下选项 - offsetnumber类型表示将数据读取到缓冲区的位置即相对于缓冲区首地址的偏移。可选默认为0。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读。 约束offsetlengthbuffer.size。
返回值
类型说明Promise[ReadOut]Promise对象。返回读取的结果。
示例
let fd fileio.openSync(path, 0o2);
let buf new ArrayBuffer(4096);
fileio.read(fd, buf).then(function(readOut){console.info(read file data succeed);console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
}).catch(function(err){console.info(read file data failed with error: err);
});fileio.read
read(fd: number, buffer: ArrayBuffer, options: { offset?: number; length?: number; position?: number; }, callback: AsyncCallback): void
从文件读取数据使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待读取文件的文件描述符。bufferArrayBuffer是用于保存读取到的文件数据的缓冲区。optionsObject否支持如下选项 - offsetnumber类型表示将数据读取到缓冲区的位置即相对于缓冲区首地址的偏移。可选默认为0。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读。 约束offsetlengthbuffer.size。callbackAsyncCallback[ReadOut]是异步读取数据之后的回调。
示例
let fd fileio.openSync(path, 0o2);
let buf new ArrayBuffer(4096);
fileio.read(fd, buf, function (err, readOut) {if (readOut) {console.info(read file data succeed);console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));}
});fileio.readSync
readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; position?: number; }): number
以同步方法从文件读取数据。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待读取文件的文件描述符。bufferArrayBuffer是用于保存读取到的文件数据的缓冲区。optionsObject否支持如下选项 - offsetnumber类型表示将数据读取到缓冲区的位置即相对于缓冲区首地址的偏移。可选默认为0。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读。 约束offsetlengthbuffer.size。
返回值
类型说明number实际读取的长度。
示例
let fd fileio.openSync(path, 0o2);
let buf new ArrayBuffer(4096);
let num fileio.readSync(fd, buf);fileio.rmdir7
rmdir(path: string): Promise
删除目录使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待删除目录的应用沙箱路径。
返回值
类型说明PromisePromise对象。无返回值。
示例
fileio.rmdir(path).then(function() {console.info(rmdir succeed);
}).catch(function(err){console.info(rmdir failed with error: err);
});fileio.rmdir7
rmdir(path: string, callback:AsyncCallback): void
删除目录使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待删除目录的应用沙箱路径。callbackAsyncCallback是异步删除目录之后的回调。
示例
fileio.rmdir(path, function(err){// do somethingconsole.info(rmdir succeed);
});fileio.rmdirSync7
rmdirSync(path: string): void
以同步方法删除目录。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待删除目录的应用沙箱路径。
示例
fileio.rmdirSync(path);fileio.unlink
unlink(path:string): Promise
删除文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待删除文件的应用沙箱路径。
返回值
类型说明PromisePromise对象。无返回值。
示例
fileio.unlink(path).then(function(){console.info(remove file succeed);
}).catch(function(error){console.info(remove file failed with error: error);
});fileio.unlink
unlink(path:string, callback:AsyncCallback): void
删除文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待删除文件的应用沙箱路径。callbackAsyncCallback是异步删除文件之后的回调。
示例
fileio.unlink(path, function(err) {console.info(remove file succeed);
});fileio.unlinkSync
unlinkSync(path: string): void
以同步方法删除文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待删除文件的应用沙箱路径。
示例
fileio.unlinkSync(path);fileio.write
write(fd: number, buffer: ArrayBuffer | string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): Promise
将数据写入文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待写入文件的文件描述符。bufferArrayBufferstring是optionsObject否支持如下选项 - offsetnumber类型表示期望写入数据的位置相对于数据首地址的偏移。可选默认为0。 - lengthnumber类型表示期望写入数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望写入文件的位置。可选默认从当前位置开始写。 - encodingstring类型当数据是string类型时有效表示数据的编码方式默认 ‘utf-8’。仅支持 ‘utf-8’。 约束offsetlengthbuffer.size。
返回值
类型说明PromisePromise对象。返回实际写入的长度。
示例
let fd fileio.openSync(path, 0o100 | 0o2, 0o666);
fileio.write(fd, hello, world).then(function(number){console.info(write data to file succeed and size is: number);
}).catch(function(err){console.info(write data to file failed with error: err);
});fileio.write
write(fd: number, buffer: ArrayBuffer | string, options: { offset?: number; length?: number; position?: number; encoding?: string; }, callback: AsyncCallback): void
将数据写入文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待写入文件的文件描述符。bufferArrayBufferstring是optionsObject否支持如下选项 - offsetnumber类型表示期望写入数据的位置相对于数据首地址的偏移。可选默认为0。 - lengthnumber类型表示期望写入数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望写入文件的位置。可选默认从当前位置开始写。 - encodingstring类型当数据是string类型时有效表示数据的编码方式默认 ‘utf-8’。仅支持 ‘utf-8’。 约束offsetlengthbuffer.size。callbackAsyncCallback是异步将数据写入完成后执行的回调函数。
示例
let fd fileio.openSync(path, 0o100 | 0o2, 0o666);
fileio.write(fd, hello, world, function (err, bytesWritten) {if (bytesWritten) {console.info(write data to file succeed and size is: bytesWritten);}
});fileio.writeSync
writeSync(fd: number, buffer: ArrayBuffer | string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): number
以同步方法将数据写入文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待写入文件的文件描述符。bufferArrayBufferstring是optionsObject否支持如下选项 - offsetnumber类型表示期望写入数据的位置相对于数据首地址的偏移。可选默认为0。 - lengthnumber类型表示期望写入数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望写入文件的位置。可选默认从当前位置开始写。 - encodingstring类型当数据是string类型时有效表示数据的编码方式默认 ‘utf-8’。仅支持 ‘utf-8’。 约束offsetlengthbuffer.size。
返回值
类型说明number实际写入的长度。
示例
let fd fileio.openSync(path, 0o100 | 0o2, 0o666);
let num fileio.writeSync(fd, hello, world);fileio.hash
hash(path: string, algorithm: string): Promise
计算文件的哈希值使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待计算哈希值文件的应用沙箱路径。algorithmstring是哈希计算采用的算法。可选 “md5”、“sha1” 或 “sha256”。建议采用安全强度更高的 “sha256”。
返回值
类型说明PromisePromise对象。返回文件的哈希值。表示为十六进制数字串所有字母均大写。
示例
fileio.hash(path, sha256).then(function(str){console.info(calculate file hash succeed: str);
}).catch(function(err){console.info(calculate file hash failed with error: err);
});fileio.hash
hash(path: string, algorithm: string, callback: AsyncCallback): void
计算文件的哈希值使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待计算哈希值文件的应用沙箱路径。algorithmstring是哈希计算采用的算法。可选 “md5”、“sha1” 或 “sha256”。建议采用安全强度更高的 “sha256”。callbackAsyncCallback是异步计算文件哈希操作之后的回调函数其中给定文件哈希值表示为十六进制数字串所有字母均大写。
示例
fileio.hash(path, sha256, function(err, hashStr) {if (hashStr) {console.info(calculate file hash succeed: hashStr);}
});fileio.chmod7
chmod(path: string, mode: number):Promise
改变文件权限使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是所需变更权限的文件的应用沙箱路径。modenumber是改变文件权限可给定如下权限以按位或的方式追加权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
返回值
类型说明PromisePromise对象。无返回值。
示例
fileio.chmod(path, 0o700).then(function() {console.info(chmod succeed);
}).catch(function(err){console.info(chmod failed with error: err);
});fileio.chmod7
chmod(path: string, mode: number, callback: AsyncCallback): void
改变文件权限使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是所需变更权限的文件的应用沙箱路径。modenumber是改变文件权限可给定如下权限以按位或的方式追加权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。callbackAsyncCallback是异步改变文件权限之后的回调。
示例
fileio.chmod(path, 0o700, function (err) {// do something
});fileio.chmodSync7
chmodSync(path: string, mode: number): void
以同步方法改变文件权限。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是所需变更权限的文件的应用沙箱路径。modenumber是改变文件权限可给定如下权限以按位或的方式追加权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
示例
fileio.chmodSync(path, 0o700);fileio.fstat7
fstat(fd: number): Promise
基于文件描述符获取文件状态信息使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待获取文件状态的文件描述符。
返回值
类型说明Promise[Stat]Promise对象。返回表示文件状态的具体信息。
示例
let fd fileio.openSync(path);
fileio.fstat(fd).then(function(stat){console.info(fstat succeed: JSON.stringify(stat));
}).catch(function(err){console.info(fstat failed with error: err);
});fileio.fstat7
fstat(fd: number, callback: AsyncCallback): void
基于文件描述符获取文件状态信息使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待获取文件状态的文件描述符。callbackAsyncCallback[Stat]是异步获取文件状态信息之后的回调。
示例
let fd fileio.openSync(path);
fileio.fstat(fd, function (err) {// do something
});fileio.fstatSync7
fstatSync(fd: number): Stat
以同步方法基于文件描述符获取文件状态信息。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待获取文件状态的文件描述符。
返回值
类型说明[Stat]表示文件状态的具体信息。
示例
let fd fileio.openSync(path);
let stat fileio.fstatSync(fd);fileio.ftruncate7
ftruncate(fd: number, len?: number): Promise
基于文件描述符截断文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待截断文件的文件描述符。lennumber否文件截断后的长度以字节为单位。
返回值
类型说明PromisePromise对象。无返回值。
示例
let fd fileio.openSync(path);
fileio.ftruncate(fd, 5).then(function(err) { console.info(truncate file succeed);
}).catch(function(err){console.info(truncate file failed with error: err);
});fileio.ftruncate7
ftruncate(fd: number, len: number, callback:AsyncCallback): void
基于文件描述符截断文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待截断文件的文件描述符。lennumber是文件截断后的长度以字节为单位。callbackAsyncCallback是回调函数本调用无返回值。
示例
let fd fileio.openSync(path);
let len 5;
fileio.ftruncate(fd, 5, function(err){// do something
});fileio.ftruncateSync7
ftruncateSync(fd: number, len?: number): void
以同步方法基于文件描述符截断文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待截断文件的文件描述符。lennumber否文件截断后的长度以字节为单位。
示例
let fd fileio.openSync(path);
let len 5;
fileio.ftruncateSync(fd, len);fileio.truncate7
truncate(path: string, len?: number): Promise
基于文件路径截断文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待截断文件的应用沙箱路径。lennumber否文件截断后的长度以字节为单位。
返回值
类型说明PromisePromise对象。无返回值。
示例
let len 5;
fileio.truncate(path, len).then(function(){console.info(truncate file succeed);
}).catch(function(err){console.info(truncate file failed with error: err);
});fileio.truncate7
truncate(path: string, len: number, callback:AsyncCallback): void
基于文件路径截断文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待截断文件的应用沙箱路径。lennumber是文件截断后的长度以字节为单位。callbackAsyncCallback是回调函数本调用无返回值。
示例
let len 5;
fileio.truncate(path, len, function(err){// do something
});fileio.truncateSync7
truncateSync(path: string, len?: number): void
以同步方法基于文件路径截断文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待截断文件的应用沙箱路径。lennumber否文件截断后的长度以字节为单位。
示例
let len 5;
fileio.truncateSync(path, len);fileio.readText7
readText(filePath: string, options?: { position?: number; length?: number; encoding?: string; }): Promise
基于文本方式读取文件即直接读取文件的文本内容使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明filePathstring是待读取文件的应用沙箱路径。optionsObject否支持如下选项 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读取。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - encodingstring类型当数据是 string 类型时有效表示数据的编码方式默认 ‘utf-8’仅支持 ‘utf-8’。
返回值
类型说明PromisePromise对象。返回读取文件的内容。
示例
fileio.readText(path).then(function(str) {console.info(readText succeed: str);
}).catch(function(err){console.info(readText failed with error: err);
});fileio.readText7
readText(filePath: string, options: { position?: number; length?: number; encoding?: string; }, callback: AsyncCallback): void
基于文本方式读取文件即直接读取文件的文本内容使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明filePathstring是待读取文件的应用沙箱路径。optionsObject是支持如下选项 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读取。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - encodingstring类型表示数据的编码方式默认 ‘utf-8’仅支持 ‘utf-8’。callbackAsyncCallback是回调函数返回读取文件的内容。
示例
fileio.readText(path, { position: 1, encoding: UTF-8 }, function(err, str){// do something
});fileio.readTextSync7
readTextSync(filePath: string, options?: { position?: number; length?: number; encoding?: string; }): string
以同步方法基于文本方式读取文件即直接读取文件的文本内容。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明filePathstring是待读取文件的应用沙箱路径。optionsObject否支持如下选项 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读取。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - encodingstring类型当数据是 string 类型时有效表示数据的编码方式默认 ‘utf-8’仅支持 ‘utf-8’。
返回值
类型说明string返回读取文件的内容。
示例
let str fileio.readTextSync(path, {position: 1, length: 3});fileio.lstat7
lstat(path: string): Promise
获取链接信息使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是目标文件的应用沙箱路径。
返回值
类型说明Promise[Stat]promise对象返回文件对象表示文件的具体信息详情见stat。
示例
fileio.lstat(path).then(function(stat){console.info(get link status succeed: JSON.stringify(stat));
}).catch(function(err){console.info(get link status failed with error: err);
});fileio.lstat7
lstat(path:string, callback:AsyncCallback): void
获取链接信息使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是目标文件的应用沙箱路径。callbackAsyncCallback[Stat]是回调函数返回文件的具体信息。
示例
fileio.lstat(path, function (err, stat) {// do something
});fileio.lstatSync7
lstatSync(path:string): Stat
以同步方法获取链接信息。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是目标文件的应用沙箱路径。
返回值
类型说明[Stat]表示文件的具体信息。
示例
let stat fileio.lstatSync(path);fileio.rename7
rename(oldPath: string, newPath: string): Promise
重命名文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明oldPathstring是目标文件的当前应用沙箱路径。newPathString是目标文件的新应用沙箱路径。
返回值
类型说明PromisePromise对象。无返回值。
示例
let oldPath path;
let newPath oldPath 123;
fileio.rename(oldPath, newPath).then(function() {console.info(rename succeed);
}).catch(function(err){console.info(rename failed with error: err);
});fileio.rename7
rename(oldPath: string, newPath: string, callback: AsyncCallback): void
重命名文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明oldPathstring是目标文件的当前应用沙箱路径。newPathString是目标文件的新应用沙箱路径。CallbackAsyncCallback是异步重命名文件之后的回调。
示例
let oldPath path;
let newPath oldPath 123;
fileio.rename(oldPath, newPath, function(err){
});fileio.renameSync7
renameSync(oldPath: string, newPath: string): void
以同步方法重命名文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明oldPathstring是目标文件的当前应用沙箱路径。newPathString是目标文件的新应用沙箱路径。
示例
let oldPath path;
let newPath oldPath 123;
fileio.renameSync(oldPath, newPath);fileio.fsync7
fsync(fd: number): Promise
同步文件数据使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待同步文件的文件描述符。
返回值
类型说明PromisePromise对象。无返回值。
示例
let fd fileio.openSync(path);
fileio.fsync(fd).then(function(){console.info(sync data succeed);
}).catch(function(err){console.info(sync data failed with error: err);
});fileio.fsync7
fsync(fd: number, callback: AsyncCallback): void
同步文件数据使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待同步文件的文件描述符。CallbackAsyncCallback是异步将文件数据同步之后的回调。
示例
let fd fileio.openSync(path);
fileio.fsync(fd, function(err){// do something
});fileio.fsyncSync7
fsyncSync(fd: number): void
以同步方法同步文件数据。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待同步文件的文件描述符。
示例
let fd fileio.openSync(path);
fileio.fsyncSync(fd);fileio.fdatasync7
fdatasync(fd: number): Promise
实现文件内容数据同步使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待同步文件的文件描述符。
返回值
类型说明PromisePromise对象。无返回值。
示例
let fd fileio.openSync(path);
fileio.fdatasync(fd).then(function(err) {console.info(sync data succeed);
}).catch(function(err){console.info(sync data failed with error: err);
});fileio.fdatasync7
fdatasync(fd: number, callback:AsyncCallback): void
实现文件内容数据同步使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待同步文件的文件描述符。callbackAsyncCallback 是异步将文件内容数据同步之后的回调。
示例
let fd fileio.openSync(path);
fileio.fdatasync (fd, function (err) {// do something
});fileio.fdatasyncSync7
fdatasyncSync(fd: number): void
以同步方法实现文件内容数据同步。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待同步文件的文件描述符。
示例
let fd fileio.openSync(path);
let stat fileio.fdatasyncSync(fd);fileio.symlink7
symlink(target: string, srcPath: string): Promise
基于文件路径创建符号链接使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明targetstring是目标文件的应用沙箱路径。srcPathstring是符号链接文件的应用沙箱路径。
返回值
类型说明PromisePromise对象。无返回值。
示例
let target path;
let srcPath target aaa;
fileio.symlink(target, srcPath).then(function() {console.info(symlink succeed);
}).catch(function(err){console.info(symlink failed with error: err);
});fileio.symlink7
symlink(target: string, srcPath: string, callback: AsyncCallback): void
基于文件路径创建符号链接使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明targetstring是目标文件的应用沙箱路径。srcPathstring是符号链接文件的应用沙箱路径。callbackAsyncCallback是异步创建符号链接信息之后的回调。
示例
let target path;
let srcPath target aaa;
fileio.symlink(target, srcPath, function (err) {// do something
});fileio.symlinkSync7
symlinkSync(target: string, srcPath: string): void
以同步的方法基于文件路径创建符号链接。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明targetstring是目标文件的应用沙箱路径。srcPathstring是符号链接文件的应用沙箱路径。
示例
let target path;
let srcPath target aaa;
fileio.symlinkSync(target, srcPath);fileio.chown7
chown(path: string, uid: number, gid: number): Promise
基于文件路径改变文件所有者使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待改变文件的应用沙箱路径。uidnumber是新的UIDUserID。gidnumber是新的GIDGroupID。
返回值
类型说明PromisePromise对象。无返回值。
示例
let stat fileio.statSync(path);
fileio.chown(path, stat.uid, stat.gid).then(function(){console.info(chown succeed);
}).catch(function(err){console.info(chown failed with error: err);
});fileio.chown7
chown(path: string, uid: number, gid: number, callback: AsyncCallback): void
基于文件路径改变文件所有者使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待改变文件的应用沙箱路径。uidnumber是新的UID。gidnumber是新的GID。callbackAsyncCallback是异步改变文件所有者之后的回调。
示例
let stat fileio.statSync(path)
fileio.chown(path, stat.uid, stat.gid, function (err){// do something
});fileio.chownSync7
chownSync(path: string, uid: number, gid: number): void
以同步的方法基于文件路径改变文件所有者。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待改变文件的应用沙箱路径。uidnumber是新的UID。gidnumber是新的GID。
示例
let stat fileio.statSync(path)
fileio.chownSync(path, stat.uid, stat.gid);fileio.mkdtemp7
mkdtemp(prefix: string): Promise
创建临时目录使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明prefixstring是用随机产生的字符串替换以“XXXXXX”结尾目录路径。
返回值
类型说明PromisePromise对象。返回生成的唯一目录路径。
示例
fileio.mkdtemp(path XXXX).then(function(path){console.info(mkdtemp succeed: path);
}).catch(function(err){console.info(mkdtemp failed with error: err);
});fileio.mkdtemp7
mkdtemp(prefix: string, callback: AsyncCallback): void
创建临时目录使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明prefixstring是用随机产生的字符串替换以“XXXXXX”结尾目录路径。callbackAsyncCallback是异步创建临时目录之后的回调。
示例
fileio.mkdtemp(path XXXX, function (err, res) {// do something
});fileio.mkdtempSync7
mkdtempSync(prefix: string): string
以同步的方法创建临时目录。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明prefixstring是用随机产生的字符串替换以“XXXXXX”结尾目录路径。
返回值
类型说明string产生的唯一目录路径。
示例
let res fileio.mkdtempSync(path XXXX);fileio.fchmod7
fchmod(fd: number, mode: number): Promise
基于文件描述符改变文件权限使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待改变文件的文件描述符。modenumber是若创建文件则指定文件的权限可给定如下权限以按位或的方式追加权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
返回值
类型说明PromisePromise对象。无返回值。
示例
let fd fileio.openSync(path);
let mode 0o700;
fileio.fchmod(fd, mode).then(function() {console.info(chmod succeed);
}).catch(function(err){console.info(chmod failed with error: err);
});fileio.fchmod7
fchmod(fd: number, mode: number, callback: AsyncCallback): void
基于文件描述符改变文件权限使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待改变文件的文件描述符。modenumber是若创建文件则指定文件的权限可给定如下权限以按位或的方式追加权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。callbackAsyncCallback 是异步改变文件权限之后的回调。
示例
let fd fileio.openSync(path);
let mode 0o700;
fileio.fchmod(fd, mode, function (err) {// do something
});fileio.fchmodSync7
fchmodSync(fd: number, mode: number): void
以同步方法基于文件描述符改变文件权限。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待改变文件的文件描述符。modenumber是若创建文件则指定文件的权限可给定如下权限以按位或的方式追加权限。 - 0o700所有者具有读、写及可执行权限。 - 0o400所有者具有读权限。 - 0o200所有者具有写权限。 - 0o100所有者具有可执行权限。 - 0o070所有用户组具有读、写及可执行权限。 - 0o040所有用户组具有读权限。 - 0o020所有用户组具有写权限。 - 0o010所有用户组具有可执行权限。 - 0o007其余用户具有读、写及可执行权限。 - 0o004其余用户具有读权限。 - 0o002其余用户具有写权限。 - 0o001其余用户具有可执行权限。
示例
let fd fileio.openSync(path);
let mode 0o700;fileio.fchmodSync(fd, mode);fileio.createStream7
createStream(path: string, mode: string): Promise
基于文件路径打开文件流使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。modestring是- r打开只读文件该文件必须存在。 - r打开可读写的文件该文件必须存在。 - w打开只写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - w打开可读写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - a以附加的方式打开只写文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾即文件原先的内容会被保留。 - a以附加方式打开可读写的文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾后即文件原先的内容会被保留。
返回值
类型说明Promise[Stream]Promise对象。返回文件流的结果。
示例
fileio.createStream(path, r).then(function(stream){console.info(createStream succeed);
}).catch(function(err){console.info(createStream failed with error: err);
});fileio.createStream7
createStream(path: string, mode: string, callback: AsyncCallback): void
基于文件路径打开文件流使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。modestring是- r打开只读文件该文件必须存在。 - r打开可读写的文件该文件必须存在。 - w打开只写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - w打开可读写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - a以附加的方式打开只写文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾即文件原先的内容会被保留。 - a以附加方式打开可读写的文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾后即文件原先的内容会被保留。callbackAsyncCallback[Stream]是异步打开文件流之后的回调。
示例
fileio.createStream(path, r, function(err, stream){// do something
});fileio.createStreamSync7
createStreamSync(path: string, mode: string): Stream
以同步方法基于文件路径打开文件流。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。modestring是- r打开只读文件该文件必须存在。 - r打开可读写的文件该文件必须存在。 - w打开只写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - w打开可读写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - a以附加的方式打开只写文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾即文件原先的内容会被保留。 - a以附加方式打开可读写的文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾后即文件原先的内容会被保留。
返回值
类型说明[Stream]返回文件流的结果。
示例
let ss fileio.createStreamSync(path, r);fileio.fdopenStream7
fdopenStream(fd: number, mode: string): Promise
基于文件描述符打开文件流使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待打开文件的文件描述符。modestring是- r打开只读文件该文件必须存在。 - r打开可读写的文件该文件必须存在。 - w打开只写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - w打开可读写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - a以附加的方式打开只写文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾即文件原先的内容会被保留。 - a以附加方式打开可读写的文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾后即文件原先的内容会被保留。
返回值
类型说明Promise[Stream]Promise对象。返回文件流的结果。
示例
let fd fileio.openSync(path);
fileio.fdopenStream(fd, r).then(function(stream){console.info(openStream succeed);
}).catch(function(err){console.info(openStream failed with error: err);
});fileio.fdopenStream7
fdopenStream(fd: number, mode: string, callback: AsyncCallback): void
基于文件描述符打开文件流使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待打开文件的文件描述符。modestring是- r打开只读文件该文件必须存在。 - r打开可读写的文件该文件必须存在。 - w打开只写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - w打开可读写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - a以附加的方式打开只写文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾即文件原先的内容会被保留。 - a以附加方式打开可读写的文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾后即文件原先的内容会被保留。callbackAsyncCallback [Stream]是异步打开文件流之后的回调。
示例
let fd fileio.openSync(path);
fileio.fdopenStream(fd, r, function (err, stream) {// do something
});fileio.fdopenStreamSync7
fdopenStreamSync(fd: number, mode: string): Stream
以同步方法基于文件描述符打开文件流。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待打开文件的文件描述符。modestring是- r打开只读文件该文件必须存在。 - r打开可读写的文件该文件必须存在。 - w打开只写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - w打开可读写文件若文件存在则文件长度清0即该文件内容会消失。若文件不存在则建立该文件。 - a以附加的方式打开只写文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾即文件原先的内容会被保留。 - a以附加方式打开可读写的文件。若文件不存在则会建立该文件如果文件存在写入的数据会被加到文件尾后即文件原先的内容会被保留。
返回值
类型说明[Stream]返回文件流的结果。
示例
let fd fileio.openSync(path);
let ss fileio.fdopenStreamSync(fd, r);fileio.fchown7
fchown(fd: number, uid: number, gid: number): Promise
基于文件描述符改变文件所有者使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待改变文件的文件描述符。uidnumber是文件所有者的UID。gidnumber是文件所有组的GID。
返回值
类型说明PromisePromise对象。无返回值。
示例
let fd fileio.openSync(path);
let stat fileio.statSync(path);
fileio.fchown(fd, stat.uid, stat.gid).then(function() {console.info(chown succeed);
}).catch(function(err){console.info(chown failed with error: err);
});fileio.fchown7
fchown(fd: number, uid: number, gid: number, callback: AsyncCallback): void
基于文件描述符改变文件所有者使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待改变文件的文件描述符。uidnumber是文件所有者的UID。gidnumber是文件所有组的GID。callbackAsyncCallback是异步改变文件所有者之后的回调。
示例
let fd fileio.openSync(path);
let stat fileio.statSync(path);
fileio.fchown(fd, stat.uid, stat.gid, function (err){// do something
});fileio.fchownSync7
fchownSync(fd: number, uid: number, gid: number): void
以同步方法基于文件描述符改变文件所有者。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明fdnumber是待改变文件的文件描述符。uidnumber是文件所有者的UID。gidnumber是文件所有组的GID。
示例
let fd fileio.openSync(path);
let stat fileio.statSync(path);
fileio.fchownSync(fd, stat.uid, stat.gid);fileio.lchown7
lchown(path: string, uid: number, gid: number): Promise
基于文件路径改变文件所有者更改符号链接本身的所有者而不是符号链接所指向的实际文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。uidnumber是新的UID。gidnumber是新的GID。
返回值
类型说明PromisePromise对象。无返回值。
示例
let stat fileio.statSync(path);
fileio.lchown(path, stat.uid, stat.gid).then(function() {console.info(chown succeed);
}).catch(function(err){console.info(chown failed with error: err);
});fileio.lchown7
lchown(path: string, uid: number, gid: number, callback: AsyncCallback): void
基于文件路径改变文件所有者更改符号链接本身的所有者而不是更改符号链接所指向的实际文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。uidnumber是新的UID。gidnumber是新的GID。callbackAsyncCallback是异步改变文件所有者之后的回调。
示例
let stat fileio.statSync(path);
fileio.lchown(path, stat.uid, stat.gid, function (err){// do something
});fileio.lchownSync7
lchownSync(path: string, uid: number, gid: number): void
以同步方法基于文件路径改变文件所有者更改符号链接本身的所有者而不是更改符号链接所指向的实际文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明pathstring是待打开文件的应用沙箱路径。uidnumber是新的UID。gidnumber是新的GID。
示例
let stat fileio.statSync(path);
fileio.lchownSync(path, stat.uid, stat.gid);fileio.createWatcher7
createWatcher(filename: string, events: number, callback: AsyncCallback): Watcher
监听文件或者目录的变化使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明filenamestring是待监视文件的应用沙箱路径。eventsNumber是- 1: 监听文件或者目录是否发生重命名。 - 2监听文件或者目录内容的是否修改。 - 3两者都有。callbackAsyncCallback是每发生变化一次调用一次此函数。
返回值
类型说明[Watcher]Promise对象。返回文件变化监听的实例。
示例
let filename path /test.txt;
fileio.createWatcher(filename, 1, function(number){console.info(Monitoring times: number);
});Readout
仅用于read方法获取文件的读取结果。
系统能力以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
名称参数类型可读可写说明bytesReadnumber是是实际读取长度。offsetnumber是是读取数据相对于缓冲区首地址的偏移。bufferArrayBufer是是保存读取数据的缓冲区。
Stat
文件具体信息在调用Stat的方法前需要先通过[stat()]方法同步或异步来构建一个Stat实例。
系统能力以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
属性
名称参数类型可读可写说明devnumber是否标识包含该文件的主设备号。inonumber是否标识该文件。通常同设备上的不同文件的INO不同。modenumber是否表示文件类型及权限其首 4 位表示文件类型后 12 位表示权限。各特征位的含义如下 - 0o170000可用于获取文件类型的掩码。 - 0o140000文件是套接字。 - 0o120000文件是符号链接。 - 0o100000文件是一般文件。 - 0o060000文件属于块设备。 - 0o040000文件是目录。 - 0o020000文件是字符设备。 - 0o010000文件是具名管道即FIFO。 - 0o0700可用于获取用户权限的掩码。 - 0o0400用户读对于普通文件所有者可读取文件对于目录所有者可读取目录项。 - 0o0200用户写对于普通文件所有者可写入文件对于目录所有者可创建/删除目录项。 - 0o0100用户执行对于普通文件所有者可执行文件对于目录所有者可在目录中搜索给定路径名。 - 0o0070可用于获取用户组权限的掩码。 - 0o0040用户组读对于普通文件所有用户组可读取文件对于目录所有用户组可读取目录项。 - 0o0020用户组写对于普通文件所有用户组可写入文件对于目录所有用户组可创建/删除目录项。 - 0o0010用户组执行对于普通文件所有用户组可执行文件对于目录所有用户组是否可在目录中搜索给定路径名。 - 0o0007可用于获取其他用户权限的掩码。 - 0o0004其他读对于普通文件其余用户可读取文件对于目录其他用户组可读取目录项。 - 0o0002其他写对于普通文件其余用户可写入文件对于目录其他用户组可创建/删除目录项。 - 0o0001其他执行对于普通文件其余用户可执行文件对于目录其他用户组可在目录中搜索给定路径名。nlinknumber是否文件的硬链接数。uidnumber是否文件所有者的ID。gidnumber是否文件所有组的ID。rdevnumber是否标识包含该文件的从设备号。sizenumber是否文件的大小以字节为单位。仅对普通文件有效。blocksnumber是否文件占用的块数计算时块大小按512B计算。atimenumber是否上次访问该文件的时间表示距1970年1月1日0时0分0秒的秒数。mtimenumber是否上次修改该文件的时间表示距1970年1月1日0时0分0秒的秒数。ctimenumber是否最近改变文件状态的时间表示距1970年1月1日0时0分0秒的秒数。
isBlockDevice
isBlockDevice(): boolean
用于判断文件是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问且访问的时候带缓存。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是块特殊设备。
示例
let isBLockDevice fileio.statSync(path).isBlockDevice();isCharacterDevice
isCharacterDevice(): boolean
用于判断文件是否是字符特殊文件。一个字符特殊设备可进行随机访问且访问的时候不带缓存。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是字符特殊设备。
示例
let isCharacterDevice fileio.statSync(path).isCharacterDevice();isDirectory
isDirectory(): boolean
用于判断文件是否是目录。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是目录。
示例
let isDirectory fileio.statSync(path).isDirectory(); isFIFO
isFIFO(): boolean
用于判断文件是否是命名管道有时也称为FIFO。命名管道通常用于进程间通信。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是 FIFO。
示例
let isFIFO fileio.statSync(path).isFIFO(); isFile
isFile(): boolean
用于判断文件是否是普通文件。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是普通文件。
示例
let isFile fileio.statSync(path).isFile();isSocket
isSocket(): boolean
用于判断文件是否是套接字。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是套接字。
示例
let isSocket fileio.statSync(path).isSocket(); isSymbolicLink
isSymbolicLink(): boolean
用于判断文件是否是符号链接。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示文件是否是符号链接。
示例
let isSymbolicLink fileio.statSync(path).isSymbolicLink(); Watcher7
Watcher是文件变化监听的实例调用Watcher.stop()方法同步或异步来停止文件监听。
stop7
stop(): Promise
关闭watcher监听使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
示例
let filename path /test.txt;
let watcher fileio.createWatcher(filename, 1, function(number){console.info(Monitoring times: number);
});
watcher.stop().then(function(){console.info(close watcher succeed);
});stop7
stop(callback: AsyncCallback): void
关闭watcher监听使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明callbackAsyncCallback是以异步方法关闭watcher监听之后的回调。
示例
let filename path /test.txt;
let watcher fileio.createWatcher(filename, 1, function(number){console.info(Monitoring times: number);
});
watcher.stop(function(){console.info(close watcher succeed);
})Stream
文件流在调用Stream的方法前需要先通过createStream()方法同步或异步来构建一个Stream实例。
close7
close(): Promise
关闭文件流使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明PromisePromise对象。返回表示异步关闭文件流的结果。
示例
let ss fileio.createStreamSync(path, r);
ss.close().then(function(){console.info(close fileStream succeed);
}).catch(function(err){console.info(close fileStream failed with error: err);
});close7
close(callback: AsyncCallback): void
异步关闭文件流使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明callbackAsyncCallback是异步关闭文件流之后的回调。
示例
let ss fileio.createStreamSync(path, r);
ss.close(function (err) {// do something
});closeSync
closeSync(): void
同步关闭文件流。
系统能力SystemCapability.FileManagement.File.FileIO
示例
let ss fileio.createStreamSync(path, r);
ss.closeSync();flush7
flush(): Promise
刷新文件流使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明PromisePromise对象。返回表示异步刷新文件流的结果。
示例
let ss fileio.createStreamSync(path, r);
ss.flush().then(function (){console.info(flush succeed);
}).catch(function(err){console.info(flush failed with error: err);
});flush7
flush(callback: AsyncCallback): void
异步刷新文件流使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明callbackAsyncCallback是异步刷新文件流后的回调函数。
示例
let ss fileio.createStreamSync(path, r);
ss.flush(function (err) {// do something
});flushSync7
flushSync(): void
同步刷新文件流。
系统能力SystemCapability.FileManagement.File.FileIO
示例
let ss fileio.createStreamSync(path, r);
ss.flushSync();write7
write(buffer: ArrayBuffer | string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): Promise
将数据写入流文件使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明bufferArrayBufferstring是optionsObject否支持如下选项 - offsetnumber类型表示期望写入数据的位置相对于数据首地址的偏移。可选默认为0。 - lengthnumber类型表示期望写入数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望写入文件的位置。可选默认从当前位置开始写。 - encodingstring类型当数据是string类型时有效表示数据的编码方式默认 ‘utf-8’。仅支持 ‘utf-8’。 约束offsetlengthbuffer.size。
返回值
类型说明PromisePromise对象。返回实际写入的长度。
示例
let ss fileio.createStreamSync(path, r);
ss.write(hello, world,{offset: 1,length: 5,position: 5,encoding :utf-8}).then(function (number){console.info(write succeed and size is: number);
}).catch(function(err){console.info(write failed with error: err);
});write7
write(buffer: ArrayBuffer | string, options: { offset?: number; length?: number; position?: number; encoding?: string; }, callback: AsyncCallback): void
将数据写入流文件使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明bufferArrayBufferstring是optionsObject否支持如下选项 - offsetnumber类型表示期望写入数据的位置相对于数据首地址的偏移。可选默认为0。 - lengthnumber类型表示期望写入数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望写入文件的位置。可选默认从当前位置开始写。 - encodingstring类型当数据是string类型时有效表示数据的编码方式默认 ‘utf-8’。仅支持 ‘utf-8’。 约束offsetlengthbuffer.size。callbackAsyncCallback是异步写入完成后执行的回调函数。
示例
let ss fileio.createStreamSync(path, r);
ss.write(hello, world, {offset: 1, length: 5, position: 5, encoding :utf-8}, function (err, bytesWritten) {if (bytesWritten) {// do somethingconsole.info(write succeed and size is: bytesWritten);}
});writeSync7
writeSync(buffer: ArrayBuffer | string, options?: { offset?: number; length?: number; position?: number; encoding?: string; }): number
以同步方法将数据写入流文件。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明bufferArrayBufferstring是optionsObject否支持如下选项 - offsetnumber类型表示期望写入数据的位置相对于数据首地址的偏移。可选默认为0。 - lengthnumber类型表示期望写入数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望写入文件的位置。可选默认从当前位置开始写。 - encodingstring类型当数据是string类型时有效表示数据的编码方式默认 ‘utf-8’。仅支持 ‘utf-8’。 约束offsetlengthbuffer.size。
返回值
类型说明number实际写入的长度。
示例
let ss fileio.createStreamSync(path,r);
let num ss.writeSync(hello, world, {offset: 1, length: 5, position: 5, encoding :utf-8});read7
read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }): Promise
从流文件读取数据使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明bufferArrayBuffer是用于读取文件的缓冲区。optionsObject否支持如下选项 - offsetnumber类型表示将数据读取到缓冲区的位置即相对于缓冲区首地址的偏移。可选默认为0。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读。 约束offsetlengthbuffer.size。
返回值
类型说明Promise[ReadOut]Promise对象。返回读取的结果。
示例
let ss fileio.createStreamSync(path, r);
ss.read(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5}).then(function (readOut){console.info(read data succeed);console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
}).catch(function(err){console.info(read data failed with error: err);
});read7
read(buffer: ArrayBuffer, options: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback): void
从流文件读取数据使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明bufferArrayBuffer是用于读取文件的缓冲区。optionsObject否支持如下选项 - offsetnumber类型表示将数据读取到缓冲区的位置即相对于缓冲区首地址的偏移。可选默认为0。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读。 约束offsetlengthbuffer.size。callbackAsyncCallback[ReadOut]是异步从流文件读取数据之后的回调。
示例
let ss fileio.createStreamSync(path, r);
ss.read(new ArrayBuffer(4096),{offset: 1, length: 5, position: 5},function (err, readOut) {if (readOut) {console.info(read data succeed);console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));}
});readSync7
readSync(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }): number
以同步方法从流文件读取数据。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明bufferArrayBuffer是用于读取文件的缓冲区。optionsObject否支持如下选项 - offsetnumber类型表示将数据读取到缓冲区的位置即相对于缓冲区首地址的偏移。可选默认为0。 - lengthnumber类型表示期望读取数据的长度。可选默认缓冲区长度减去偏移长度。 - positionnumber类型表示期望读取文件的位置。可选默认从当前位置开始读。 约束offsetlengthbuffer.size。
返回值
类型说明number实际读取的长度。
示例
let ss fileio.createStreamSync(path, r);
let num ss.readSync(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5});Dir
管理目录在调用Dir的方法前需要先通过opendir方法同步或异步来构建一个Dir实例。
read
read(): Promise
读取下一个目录项使用Promise异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明Promise[Dirent]Promise对象。返回表示异步读取目录项的结果。
示例
dir.read().then(function (dirent){console.log(read succeed:JSON.stringify(dirent));
}).catch(function(err){console.info(read failed with error: err);
});read
read(callback: AsyncCallback): void
读取下一个目录项使用callback异步回调。
系统能力SystemCapability.FileManagement.File.FileIO
参数
参数名类型必填说明callbackAsyncCallback[Dirent]是异步读取下一个目录项之后的回调。
示例
dir.read(function (err, dirent) {if (dirent) {// do somethingconsole.log(read succeed:JSON.stringify(dirent));}
});readSync
readSync(): Dirent
同步读取下一个目录项。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明[Dirent]表示一个目录项。
示例
let dirent dir.readSync();close7
close(): Promise
异步关闭目录使用promise形式返回结果。目录被关闭后Dir中持有的文件描述将被释放后续将无法从Dir中读取目录项。
系统能力SystemCapability.FileManagement.File.FileIO
示例
dir.close().then(function(err){console.info(close dir successfully);
});close7
close(callback: AsyncCallback): void
异步关闭目录使用callback形式返回结果。目录被关闭后Dir中持有的文件描述将被释放后续将无法从Dir中读取目录项。
系统能力SystemCapability.FileManagement.File.FileIO
示例
dir.close(function(err){console.info(close dir successfully);
});closeSync
closeSync(): void
用于关闭目录。目录被关闭后Dir中持有的文件描述将被释放后续将无法从Dir中读取目录项。
系统能力SystemCapability.FileManagement.File.FileIO
示例
dir.closeSync();Dirent
在调用Dirent的方法前需要先通过[dir.read()]方法同步或异步来构建一个Dirent实例。
系统能力以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
属性
名称参数类型可读可写说明namestring是否目录项的名称。
isBlockDevice
isBlockDevice(): boolean
用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问且访问的时候带缓存。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是块特殊设备。
示例
let dir fileio.opendirSync(path);
let isBLockDevice dir.readSync().isBlockDevice();isCharacterDevice
isCharacterDevice(): boolean
用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问且访问的时候不带缓存。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是字符特殊设备。
示例
let dir fileio.opendirSync(path);
let isCharacterDevice dir.readSync().isCharacterDevice(); isDirectory
isDirectory(): boolean
用于判断当前目录项是否是目录。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是目录。
示例
let dir fileio.opendirSync(path);
let isDirectory dir.readSync().isDirectory(); isFIFO
isFIFO(): boolean
用于判断当前目录项是否是命名管道有时也称为FIFO。命名管道通常用于进程间通信。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是FIFO。
示例
let dir fileio.opendirSync(path);
let isFIFO dir.readSync().isFIFO(); isFile
isFile(): boolean
用于判断当前目录项是否是普通文件。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是普通文件。
示例
let dir fileio.opendirSync(path);
let isFile dir.readSync().isFile(); isSocket
isSocket(): boolean
用于判断当前目录项是否是套接字。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是套接字。
示例
let dir fileio.opendirSync(path);
let isSocket dir.readSync().isSocket(); isSymbolicLink
isSymbolicLink(): boolean
用于判断当前目录项是否是符号链接。
系统能力SystemCapability.FileManagement.File.FileIO
返回值
类型说明boolean表示当前目录项是否是符号链接。
示例
let dir fileio.opendirSync(path);
let isSymbolicLink dir.readSync().isSymbolicLink();
文章转载自： http://www.morning.zwppm.cn.gov.cn.zwppm.cn http://www.morning.fzlk.cn.gov.cn.fzlk.cn http://www.morning.c-ae.cn.gov.cn.c-ae.cn http://www.morning.kqgqy.cn.gov.cn.kqgqy.cn http://www.morning.lgnbr.cn.gov.cn.lgnbr.cn http://www.morning.bmbnc.cn.gov.cn.bmbnc.cn http://www.morning.nfpkx.cn.gov.cn.nfpkx.cn http://www.morning.qqrqb.cn.gov.cn.qqrqb.cn http://www.morning.zrmxp.cn.gov.cn.zrmxp.cn http://www.morning.yzdth.cn.gov.cn.yzdth.cn http://www.morning.gydth.cn.gov.cn.gydth.cn http://www.morning.llqch.cn.gov.cn.llqch.cn http://www.morning.fhxrb.cn.gov.cn.fhxrb.cn http://www.morning.wgbmj.cn.gov.cn.wgbmj.cn http://www.morning.csnch.cn.gov.cn.csnch.cn http://www.morning.khyqt.cn.gov.cn.khyqt.cn http://www.morning.nbdtdjk.cn.gov.cn.nbdtdjk.cn http://www.morning.qggxt.cn.gov.cn.qggxt.cn http://www.morning.bgpch.cn.gov.cn.bgpch.cn http://www.morning.mjgxl.cn.gov.cn.mjgxl.cn http://www.morning.mlwpr.cn.gov.cn.mlwpr.cn http://www.morning.yxlhz.cn.gov.cn.yxlhz.cn http://www.morning.wgdnd.cn.gov.cn.wgdnd.cn http://www.morning.rwqj.cn.gov.cn.rwqj.cn http://www.morning.xxhc.cn.gov.cn.xxhc.cn http://www.morning.ldwxj.cn.gov.cn.ldwxj.cn http://www.morning.dfkby.cn.gov.cn.dfkby.cn http://www.morning.mqwnz.cn.gov.cn.mqwnz.cn http://www.morning.fdlyh.cn.gov.cn.fdlyh.cn http://www.morning.cqyhdy.cn.gov.cn.cqyhdy.cn http://www.morning.sgfpn.cn.gov.cn.sgfpn.cn http://www.morning.bzwxr.cn.gov.cn.bzwxr.cn http://www.morning.mplld.cn.gov.cn.mplld.cn http://www.morning.slwfy.cn.gov.cn.slwfy.cn http://www.morning.pbdnj.cn.gov.cn.pbdnj.cn http://www.morning.bwttp.cn.gov.cn.bwttp.cn http://www.morning.gidmag.com.gov.cn.gidmag.com http://www.morning.lrskd.cn.gov.cn.lrskd.cn http://www.morning.dmtbs.cn.gov.cn.dmtbs.cn http://www.morning.slqzb.cn.gov.cn.slqzb.cn http://www.morning.zxqyd.cn.gov.cn.zxqyd.cn http://www.morning.tsflw.cn.gov.cn.tsflw.cn http://www.morning.xkbdx.cn.gov.cn.xkbdx.cn http://www.morning.yltyz.cn.gov.cn.yltyz.cn http://www.morning.wqpsf.cn.gov.cn.wqpsf.cn http://www.morning.mbfkt.cn.gov.cn.mbfkt.cn http://www.morning.zrqs.cn.gov.cn.zrqs.cn http://www.morning.mlycx.cn.gov.cn.mlycx.cn http://www.morning.rxkq.cn.gov.cn.rxkq.cn http://www.morning.nspbj.cn.gov.cn.nspbj.cn http://www.morning.tbjtm.cn.gov.cn.tbjtm.cn http://www.morning.rnqnp.cn.gov.cn.rnqnp.cn http://www.morning.ljzqb.cn.gov.cn.ljzqb.cn http://www.morning.zzbwjy.cn.gov.cn.zzbwjy.cn http://www.morning.jkcnq.cn.gov.cn.jkcnq.cn http://www.morning.leeong.com.gov.cn.leeong.com http://www.morning.bxnrx.cn.gov.cn.bxnrx.cn http://www.morning.dxqwm.cn.gov.cn.dxqwm.cn http://www.morning.fbxlj.cn.gov.cn.fbxlj.cn http://www.morning.pndw.cn.gov.cn.pndw.cn http://www.morning.ydtdn.cn.gov.cn.ydtdn.cn http://www.morning.zcqgf.cn.gov.cn.zcqgf.cn http://www.morning.rgxll.cn.gov.cn.rgxll.cn http://www.morning.xxknq.cn.gov.cn.xxknq.cn http://www.morning.djbhz.cn.gov.cn.djbhz.cn http://www.morning.hmdn.cn.gov.cn.hmdn.cn http://www.morning.jqcrf.cn.gov.cn.jqcrf.cn http://www.morning.qwmpn.cn.gov.cn.qwmpn.cn http://www.morning.mrbmc.cn.gov.cn.mrbmc.cn http://www.morning.pnmgr.cn.gov.cn.pnmgr.cn http://www.morning.ghfmd.cn.gov.cn.ghfmd.cn http://www.morning.mknxd.cn.gov.cn.mknxd.cn http://www.morning.nqmwk.cn.gov.cn.nqmwk.cn http://www.morning.xsszn.cn.gov.cn.xsszn.cn http://www.morning.tqxtx.cn.gov.cn.tqxtx.cn http://www.morning.ntqqm.cn.gov.cn.ntqqm.cn http://www.morning.zxznh.cn.gov.cn.zxznh.cn http://www.morning.swbhq.cn.gov.cn.swbhq.cn http://www.morning.wftrs.cn.gov.cn.wftrs.cn http://www.morning.bpmdn.cn.gov.cn.bpmdn.cn
