ReadableStreamBYOBReader

A interface ReadableStreamBYOBReader do Azion Runtime: o construtor, a propriedade closed e os métodos que leem um stream de bytes para o seu buffer.

Última atualização

Ver como Markdown Configurar agente

A interface ReadableStreamBYOBReader faz parte da Streams API do Azion Runtime. Ela lê um stream de bytes para um buffer que você fornece, sem copiar os dados. Use-a para transferir dados de fontes que os entregam como uma série de bytes anônimos, como arquivos. BYOB significa “Bring Your Own Buffer” (traga o seu próprio buffer). Para mais informações, consulte ReadableStreamBYOBReader na MDN Web Docs.

Construtor

O construtor ReadableStreamBYOBReader() cria e retorna um reader para o stream que você passa para ele:

new ReadableStreamBYOBReader(stream)

Você também pode criar o reader a partir do stream: chame getReader() em um ReadableStream e defina mode: 'byob' nas opções. Os exemplos desta página criam o stream como um stream de bytes, com type: 'bytes' nos handlers.

Propriedades

PropriedadeTipoDescrição
closedPromiseÉ cumprida quando o stream é encerrado. É rejeitada quando o stream lança um erro ou quando o reader libera o bloqueio. Use-a para executar código quando o stream termina.

Métodos

MétodoDescrição
reader.cancel(reason)Retorna uma promise que resolve quando o stream é cancelado. Uma chamada sinaliza que o consumidor perdeu o interesse no stream. A fonte subjacente recebe reason e pode usá-lo ou ignorá-lo.
reader.read(view)Recebe uma view na qual o stream escreve os dados, como um Uint8Array. Retorna uma promise que resolve com o próximo chunk do stream, ou que é rejeitada quando o stream está encerrado ou tem um erro.
reader.releaseLock()Libera o bloqueio do reader sobre o stream.

Exemplos

Este handler constrói um stream de bytes que contém 5 bytes, cria um BYOB reader com getReader() e lê o stream para um buffer de 8 bytes. Ele retorna o nome da classe do reader e o resultado de read():

JavaScript
01export default {
02 async fetch(request, env, ctx) {
03 const stream = new ReadableStream({
04 type: 'bytes',
05 start(controller) {
06 controller.enqueue(new Uint8Array([1, 2, 3, 4, 5]));
07 controller.close();
08 },
09 });
10 const reader = stream.getReader({ mode: 'byob' });
11 const { value, done } = await reader.read(new Uint8Array(new ArrayBuffer(8)));
12 return Response.json({
13 ctor: reader.constructor.name,
14 done,
15 bytes: Array.from(value),
16 byteLength: value.byteLength,
17 });
18 },
19};

A function retorna estes valores. A view retornada contém os 5 bytes que o stream escreveu, e não os 8 bytes completos do buffer:

JSON
01{
02 "ctor": "ReadableStreamBYOBReader",
03 "done": false,
04 "bytes": [
05 1,
06 2,
07 3,
08 4,
09 5
10 ],
11 "byteLength": 5
12}

Para ler um stream chunk por chunk para um único buffer, chame read() de novo a partir do resultado de cada leitura, com uma view da parte do buffer que ainda está vazia. Neste exemplo, stream é um stream de bytes de 10 bytes e buffer comporta 4.000 bytes:

JavaScript
01const stream = new ReadableStream({ type: 'bytes', start(c) { c.enqueue(new Uint8Array(10).fill(7)); c.close(); } });
02const reader = stream.getReader({ mode: "byob" });
03let buffer = new ArrayBuffer(4000);
04
05readStream(reader);
06
07function readStream(reader) {
08 let bytesReceived = 0;
09 let offset = 0;
10
11 while (offset < buffer.byteLength) {
12 // read() returns a promise that resolves when a value has been received
13 reader.read(new Uint8Array(buffer, offset, buffer.byteLength - offset))
14 .then(function processBytes({ done, value }) {
15 // Result objects contain two properties:
16 // done - true if the stream has already given all its data.
17 // value - some data. Always undefined when done is true.
18
19 if (done) {
20 // There is no more data in the stream
21 return;
22 }
23
24 buffer = value.buffer;
25 offset += value.byteLength;
26 bytesReceived += value.byteLength;
27
28 // Read some more, and call this function again
29 return reader.read(new Uint8Array(buffer, offset, buffer.byteLength - offset)).then(processBytes);
30 });
31 }
32}

Recursos relacionados

ReadableStream

O stream que um BYOB reader lê, e como construir um stream de bytes.

ReadableStreamDefaultReader

O reader que getReader() retorna quando você não passa um modo.

Response

Uma resposta cujo stream body um reader pode consumir.

Web APIs

As outras Web APIs que o Azion Runtime suporta.