← Cloudflare Workers / workers / runtime-apis / streams

ReadableStream BYOBReader

BYOB является сокращением от bring your own buffer (используйте собственный буфер). ReadableStreamBYOBReader позволяет читать данные напрямую в буфер, предоставленный разработчиком, что сводит копирование к минимуму.

Экземпляр ReadableStreamBYOBReader функционально идентичен ReadableStreamDefaultReader за исключением read метод.

A ReadableStreamBYOBReader не создается через свой конструктор. Вместо этого он получается из ReadableStream:

const { readable, writable } = new TransformStream();
const reader = readable.getReader({ mode: 'byob' });

• read(bufferArrayBufferView) : Promise<ReadableStreamBYOBReadResult>

  • Возвращает Promise со следующим доступным фрагментом данных, считанным в переданный буфер.

• readAtLeast(minElements, bufferArrayBufferView) : Promise<ReadableStreamBYOBReadResult>

  • Возвращает Promise со следующим доступным фрагментом данных, считанным в переданный буфер. Promise не будет разрешён, пока не наберётся хотя бы minElements элементов было прочитано. Размер элемента определяется bufferArrayBufferView, например 4 байта на элемент для Uint32Array. Однако менее minElements элементов может быть возвращено меньше, если достигнут конец потока или базовый поток закрыт. А именно:

    • Если minElements или более элементов, промис разрешается с { value: <buffer view sized to bytes read>, done: false }.
    • Если поток завершается после того, как было прочитано некоторое количество данных, но меньше, чем minElements элементов, промис разрешается с частичными данными: { value: <buffer view sized to bytes actually read>, done: false }. Следующий вызов read или readAtLeast затем вернёт { value: undefined, done: true }.
    • Если поток завершается с нулевым количеством доступных байтов (то есть поток уже достиг EOF), промис разрешается со значением { value: <zero-length view>, done: true }.
    • Если в потоке возникает ошибка, промис отклоняется.
    • minElements должен быть не менее 1, и minElements * elementSize не должен превышать длину в байтах bufferArrayBufferView, либо promise отклоняется с TypeError. Для Uint8Array, размер элемента равен 1, поэтому minElements фактически представляет собой количество байт.

• Streams
• Справочная информация о BYOB-ридерах в спецификации Streams API WHATWG ↗