ReadableStreamBYOBReader: read() Methode

view

Die Ansicht, in die Daten gelesen werden sollen.

Ein Promise, das erfüllt/abgelehnt wird, abhängig vom Status des Streams.

Folgende Möglichkeiten bestehen:

• Wenn ein Datenblock verfügbar ist und der Stream noch aktiv ist, wird das Promise mit einem Objekt der Form erfüllt:

  js

  { value: theChunk, done: false }
  

  theChunk ist eine Ansicht, die die neuen Daten enthält. Dies ist eine Ansicht des gleichen Typs und über denselben Speicherbereich wie die view, die an die read()-Methode übergeben wurde. Die ursprüngliche view wird getrennt und ist nicht mehr verwendbar.

• Wenn der Stream geschlossen ist, wird das Promise mit einem Objekt der folgenden Form erfüllt (wobei theChunk die gleichen Eigenschaften wie oben hat):

  js

  { value: theChunk, done: true }
  

• Wenn der Stream abgebrochen wird, wird das Promise mit einem Objekt der Form erfüllt:

  js

  { value: undefined, done: true }
  

  In diesem Fall wird der Speicherbereich verworfen.

• Wenn der Stream einen Fehler wirft, wird das Promise mit dem entsprechenden Fehler abgelehnt.

TypeError

Das Quellobjekt ist kein ReadableStreamBYOBReader, der Stream hat keinen Eigentümer, die Ansicht ist kein Objekt oder wurde getrennt, die Länge der Ansicht ist 0, oder ReadableStreamBYOBReader.releaseLock() wird aufgerufen (wenn eine ausstehende Leseanforderung besteht).

Der im Folgenden gezeigte Beispielcode stammt aus den Live-Beispielen in Using readable byte streams.

Zuerst erstellen wir den Leser mithilfe von ReadableStream.getReader() für den Stream, wobei mode: "byob" im Optionsparameter angegeben wird. Wir müssen auch einen ArrayBuffer erstellen, der das "Back-End" der Ansichten darstellt, die wir beschreiben werden.

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

Eine Funktion, die den Leser verwendet, wird unten gezeigt. Diese ruft rekursiv die read()-Methode auf, um Daten in den Puffer zu lesen. Die Methode nimmt ein Uint8Array typed array, welches eine Ansicht über den Teil des ursprünglichen Array-Buffers ist, der noch nicht beschrieben wurde. Die Parameter der Ansicht werden anhand der in vorherigen Aufrufen empfangenen Daten berechnet, die einen Offset in den ursprünglichen Array-Buffer definieren.

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);
      });
  }
}

Wenn keine weiteren Daten im Stream vorhanden sind, wird die read()-Methode mit einem Objekt mit der Eigenschaft done, die auf true gesetzt ist, erfüllt, und die Funktion gibt zurück.

• ReadableStreamBYOBReader() Konstruktor
• Using readable byte stream