ReadableStreamBYOBReader: read() メソッド

構文

read(view)

引数

view

読み込み先のビュー。

返値

プロミス (Promise) で、ストリームの状態に応じた結果で履行または拒否されます。

取りうる値は次の通りです。

• チャンクが利用でき、ストリームがまだアクティブであれば、プロミスは次の形のオブジェクトで履行されます。

  js

  { value: theChunk, done: false }
  

  theChunk は新しいデータを格納するビューです。 これは read() メソッドに渡された view と同じ型で、同じバッキングメモリー上のビューです。 元の view は切り離されて使えなくなりました。

• ストリームが閉じられた場合、プロミスは（theChunk を上記と同じプロパティを持つ）形式のオブジェクトで履行されます。

  js

  { value: theChunk, done: true }
  

• If the stream is cancelled, the promise fulfills with an object of the form:

  js

  { value: undefined, done: true }
  

  In this case the backing memory is discarded.

• If the stream throws an error, the promise rejects with the relevant error.

例外

TypeError

元のオブジェクトが ReadableStreamBYOBReader ではないか、ストリームにオーナーがいないか、ビューがオブジェクトでないか、切り離されているか、ビューの長さが 0 であるか、（待機中の読み取りリクエストがある場合に） ReadableStreamBYOBReader.releaseLock() が呼び出された場合。

例

以下の例は、読み取り可能なバイトストリームの使用から取ったものです。

まず、ストリーム上で ReadableStream.getReader() を使用してリーダーを作成します。 options 引数に mode: "byob" を指定します。 ArrayBuffer も作成する必要があります。これはビューの「バッキングメモリー」で、ここに書き込むことになります。

const reader = stream.getReader({ mode: "byob" });
let buffer = new ArrayBuffer(4000);

リーダーを使用する関数を下記に示します。 これは read() メソッドを再帰的に呼び出して、データをバッファーに読み込みます。 このメソッドは Uint8Array 型付き配列を取ります。これは、元の配列バッファーでまだ書き込まれていない部分のビューです。 ビューの引数は、前回呼び出された際に受け取ったデータから計算され、元の配列バッファーへのオフセットを定義します。

readStream(reader);

function readStream(reader) {
  let bytesReceived = 0;
  let offset = 0;

  while (offset < buffer.byteLength) {
    // read() returns a promise that fulfills when a value has been received
    reader
      .read(new Uint8Array(buffer, offset, buffer.byteLength - offset))
      .then(function processBytes({ done, value }) {
        // Result objects contain two properties:
        // done - true if the stream has already given all its data.
        // value - some data. 'undefined' if the reader is canceled.

        if (done) {
          // There is no more data in the stream
          return;
        }

        buffer = value.buffer;
        offset += value.byteLength;
        bytesReceived += value.byteLength;

        // Read some more, and call this function again
        // Note that here we create a new view over the original buffer.
        return reader
          .read(new Uint8Array(buffer, offset, buffer.byteLength - offset))
          .then(processBytes);
      });
  }
}

ストリームにデータがなくなると、read() メソッドは done プロパティを true に設定したオブジェクトで履行され、関数を返します。

仕様書

ブラウザーの互換性

関連情報

• ReadableStreamBYOBReader() コンストラクター
• 読み取り可能なストリームの使用