文件管理

支持设备

导入模块

import fileio from '@ohos.fileio'

权限列表

无

openSync(path:string, flags?:number, mode?:number): number

同步地打开文件。

• 参数：

• 返回值：

• 示例：

  let fd = fileio.openSync(path);
  

accessSync(path: string, mode?: number): void

同步地检查当前进程是否可访问某文件。

• 参数：

• 返回值：

  无

• 示例：

  fileio.accessSync(path);
  

chmodSync(path:string, mode:number):void

同步地修改文件权限。

• 参数：

• 返回值：

  无

• 示例：

  fileio.chmodSync(path, 0o660);
  

chownSync(path:string, owner:number, group:number):void

同步地修改文件的所有者和组。

• 参数：

• 返回值：

  无

• 示例：

  fileio.chownSync(path, UID, UID);
  

closeSync(fd: number): void

关闭文件描述符。

• 参数：

• 返回值：

  无

• 示例：

  fileio.closeSync(fd);
  

copyFileSync(src:string, dest:string, mode?:number): void

同步地复制文件。

• 参数：

• 返回值：

  无

• 示例：

  fileio.copyFileSync(src, dest);
  

fchmodSync(fd:number, mode:number):void

同步地更改文件描述符所指文件的权限。

• 参数：

• 返回值：

  无

• 示例：

  let fd = fileio.openSync(path, 0o2);
  fileio.fchmodSync(fd, 0o660);
  

fchownSync(fd:number, owner:number, group:number):void

同步地更改已打开文件的所有者和组。

• 参数：

• 返回值：

  无

• 示例：

  let fd = fileio.openSync(path, 0o2);
  fileio.fchownSync(fd, UID, UID);
  

fstatSync(fd:number):Stat

同步地获取已打开文件的信息。

• 参数：

• 返回值：

• 示例：

  let fd = fileio.openSync(path, 0o2);
  let stat = fileio.fstatSync(fd);
  

ftruncateSync(fd:number, len?:number):void

同步地修改已打开文件的大小。

• 参数：

• 返回值：

  无

• 示例：

  let fd = fileio.openSync(path, 0o2);
  fileio.ftruncateSync(fd);
  

mkdirSync(path: string, mode?: number): void

同步地创建目录。

• 参数：

• 返回值：

  无

• 示例：

  fileio.mkdirSync(path);
  

readSync(fd: number, buffer: ArrayBuffer, options?: Object): number

同步地从文件读取数据。

• 参数：

• 返回值：

• 示例：

  let fd = fileio.openSync(path, 0o2);
  let buf = new ArrayBuffer(4096);
  fileio.readSync(fd, buf);
  console.log(String.fromCharCode.apply(null, new Uint8Array(buf)));
  

renameSync(path:string, pathTarget:string):void

同步地重命名文件。

• 参数：

• 返回值：

  无

• 示例：

  fileio.renameSync(path, pathTarget);
  

rmdirSync(path:string):void

同步地删除目录。

• 参数：

• 返回值：

  无

• 示例：

  fileio.rmdirSync(path);
  

unlinkSync(path: string): void

同步地删除文件。

• 参数：

• 返回值：

  无

• 示例：

  fileio.unlinkSync(path);
  

fsyncSync(fd:number):void

同步地将缓冲区数据写回磁盘进行数据同步。

• 参数：

• 返回值：

  无

• 示例：

  let fd = fileio.openSync(path, 0o2);
  fileio.fsyncSync(fd);
  

truncateSync(path:string, len?:number):void

同步地修改文件大小。

• 参数：

• 返回值：

  无

• 示例：

  fileio.truncateSync(path);
  

writeSync(fd: number, buffer: ArrayBuffer | string, options?:Object): number

同步地将数据写入文件。

• 参数：

• 返回值：

• 示例：

  let fd = fileio.openSync(path, 0o102, 0o666);
  let writeLen = fileio.writeSync(fd, 'hello, world');
  

Stat

文件具体信息，在调用Stat的方法前，需要先通过statSync(path:string)方法来构建一个Stat实例。

属性

statSync(path:string): Stat

同步地获取文件的信息。

• 参数：

• 返回值：

• 示例：

  let stat = fileio.statSync(path);
  

isBlockDevice(): boolean

用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

• 参数：

  无

• 返回值：

• 示例：

  let isBLockDevice = fileio.statSync(fpath).isBlockDevice();
  

isCharacterDevice(): boolean

用于判断当前目录项是否是字符特殊文件。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

• 参数：

  无

• 返回值：

• 示例：

  let isCharacterDevice = fileio.statSync(fpath).isCharacterDevice();
  

isDirectory(): boolean

用于判断当前目录项是否是目录。

• 参数：

  无

• 返回值：

• 示例：

  let isDirectory = fileio.statSync(fpath).isDirectory(); 
  

isFIFO(): boolean

用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

• 参数：

  无

• 返回值：

• 示例：

  let isFIFO = fileio.statSync(fpath).isFIFO(); 
  

isFile(): boolean

用于判断当前目录项是否是普通文件。

• 参数：

  无

• 返回值：

• 示例：

  let isFile = fileio.statSync(fpath).isFile();
  

isSocket(): boolean

用于判断当前目录项是否是套接字。

• 参数：

  无

• 返回值：

• 示例：

  let isSocket = fileio.statSync(fpath).isSocket(); 
  

isSymbolicLink(): boolean

用于判断当前目录项是否是符号链接。

• 参数：

  无

• 返回值：

• 示例：

  let isSymbolicLink = fileio.statSync(fpath).isSymbolicLink(); 
  

Dir

管理目录，在调用Dir的方法前，需要先通过opendirSync(path: string)方法来构建一个Dir实例。

opendirSync(path: string): Dir

同步地打开文件目录。

• 参数：

• 返回值：

• 示例：

  let dir = fileio.opendirSync(path);
  

readSync(): Dirent

同步读取下一个目录项。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let dirent = dir.readSync();
  console.log(dirent.name);
  

closeSync(): void

用于关闭目录。目录被关闭后，Dir中持有的文件描述将被释放，后续将无法从Dir中读取目录项。

• 参数：

  无

• 返回值：

  无

• 示例：

  let dir = fileio.opendirSync(dpath);
  dir.closeSync();
  

Dirent

在调用Dirent的方法前，需要先通过dir.readSync()方法来构建一个Dirent实例。

属性

isBlockDevice(): boolean

用于判断当前目录项是否是块特殊文件。一个块特殊文件只能以块为粒度进行访问，且访问的时候带缓存。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isBLockDevice = dir.readSync().isBlockDevice();
  

isCharacterDevice(): boolean

用于判断当前目录项是否是字符特殊设备。一个字符特殊设备可进行随机访问，且访问的时候不带缓存。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isCharacterDevice = dir.readSync().isCharacterDevice(); 
  

isDirectory(): boolean

用于判断当前目录项是否是目录。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isDirectory = dir.readSync().isDirectory(); 
  

isFIFO(): boolean

用于判断当前目录项是否是命名管道（有时也称为FIFO）。命名管道通常用于进程间通信。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isFIFO = dir.readSync().isFIFO(); 
  

isFile(): boolean

用于判断当前目录项是否是普通文件。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isFile = dir.readSync().isFile(); 
  

isSocket(): boolean

用于判断当前目录项是否是套接字。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isSocket = dir.readSync().isSocket(); 
  

isSymbolicLink(): boolean

用于判断当前目录项是否是符号链接。

• 参数：

  无

• 返回值：

• 示例：

  let dir = fileio.opendirSync(dpath);
  let isSymbolicLink = dir.readSync().isSymbolicLink();
  

Stream

createStreamSync(path:string, mode:string): Stream

同步地获取文件流。

• 参数：

• 返回值：

• 示例：

  let ss = fileio.createStreamSync(path, "r+");
  

fdopenStreamSync(fd:number, mode:string):Stream

同步地将文件描述符转为文件流。

• 参数：

• 返回值：

• 示例：

  let fd = fileio.openSync(path, 0o2);
  let ss = fileio.fdopenStreamSync(fd, "r+");
  

writeSync(buffer: ArrayBuffer | string, options?:Object):number

同步地向文件流写入数据。

• 参数：

• 返回值：

• 示例：

  let ss = fileio.createStreamSync(path, "r+");
  let writeLen = ss.writeSync('hello, world');
  

flushSync():void

同步地刷新文件流的输出缓冲区。

• 参数：

  无

• 返回值：

  无

• 示例：

  let ss = fileio.createStreamSync(path, "r+");
  let writeLen = ss.writeSync('hello, world');
  ss.flushSync();
  

readSync(buffer: ArrayBuffer, options?:Object):number

同步地从文件流读取数据。

• 参数：

• 返回值：

• 示例：

  let ss = fileio.createStreamSync(path, "r+");
  let buf = new ArrayBuffer(4096);
  let readLen = fileio.readSync(buf);
  console.log(String.fromCharCode.apply(null, new Uint8Array(buf)));
  

closeSync():void

同步地关闭文件流。

• 参数：

  无

• 返回值：

  无

• 示例：

  let ss = fileio.createStreamSync(path, "r+");
  ss.closeSync();