FileSystemSyncAccessHandle: read() 方法

Baseline 已广泛支持

此功能已成熟,并可在许多设备和浏览器版本上运行。自 2023 年 3 月以来,它已在各种浏览器中可用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

注意:此功能仅在 专用 Web Worker 中可用。

read() 方法是 FileSystemSyncAccessHandle 接口的一个方法,它将与句柄关联的文件的内容读取到指定的缓冲区中,可以选择性地在给定偏移量处读取。

语法

js
read(buffer, options)

参数

buffer

一个 ArrayBufferArrayBufferView(例如 DataView),它表示文件内容将被读取到的缓冲区。请注意,您不能直接操作 ArrayBuffer 的内容。而是创建一个类型化数组对象,如 Int8ArrayDataView 对象,该对象以特定格式表示缓冲区,并使用它来读取和写入缓冲区的内��。

options 可选

一个包含以下属性的选项对象

at

一个数字,表示应从中读取文件的字节偏移量。

返回值

一个数字,表示从文件中读取的字节数。

异常

InvalidStateError DOMException

如果关联的访问句柄已关闭,则会抛出此错误。

TypeError

如果底层文件系统不支持从指定文件偏移量读取文件,则会抛出此错误。

示例

以下异步事件处理函数包含在 Web Worker 中。在接收到主线程的消息后,它会:

  • 创建一个同步文件访问句柄。
  • 获取文件大小并创建一个 ArrayBuffer 来存储它。
  • 将文件内容读入缓冲区。
  • 对消息进行编码并将其写入文件末尾。
  • 将更改持久化到磁盘并关闭访问句柄。
js
onmessage = async (e) => {
  // Retrieve message sent to work from main script
  const message = e.data;

  // Get handle to draft file
  const root = await navigator.storage.getDirectory();
  const draftHandle = await root.getFileHandle("draft.txt", { create: true });
  // Get sync access handle
  const accessHandle = await draftHandle.createSyncAccessHandle();

  // Get size of the file.
  const fileSize = accessHandle.getSize();
  // Read file content to a buffer.
  const buffer = new DataView(new ArrayBuffer(fileSize));
  const readBuffer = accessHandle.read(buffer, { at: 0 });

  // Write the message to the end of the file.
  const encoder = new TextEncoder();
  const encodedMessage = encoder.encode(message);
  const writeBuffer = accessHandle.write(encodedMessage, { at: readBuffer });

  // Persist changes to disk.
  accessHandle.flush();

  // Always close FileSystemSyncAccessHandle if done.
  accessHandle.close();
};

注意: 在规范的早期版本中,close()flush()getSize()truncate() 被错误地指定为异步方法,并且一些旧版本的浏览器以这种方式实现它们。然而,所有支持这些方法的当前浏览器都将其实现为同步方法。

规范

规范
文件系统
# api-filesystemsyncaccesshandle-read

浏览器兼容性

另见