← Cloudflare Workers / workers / runtime-apis / streams

ReadableStream BYOBReader

BYOB je zkratka pro bring your own buffer (vlastní buffer). ReadableStreamBYOBReader umožňuje čtení do bufferu poskytnutého vývojářem, čímž minimalizuje kopírování.

Instance ReadableStreamBYOBReader je funkčně totožné s ReadableStreamDefaultReader s výjimkou read metoda.

A ReadableStreamBYOBReader se nevytváří pomocí svého konstruktoru. Místo toho se získává z ReadableStream:

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

• read(bufferArrayBufferView) : Promise<ReadableStreamBYOBReadResult>

  • Vrátí Promise s dalším dostupným blokem dat načteným do předaného bufferu.

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

  • Vrátí Promise s dalším dostupným blokem dat načteným do předaného bufferu. Promise se nevyřeší, dokud nebude k dispozici alespoň minElements elementů bylo přečteno. Velikost elementu určuje bufferArrayBufferView, například 4 bajty na prvek u Uint32Array. Avšak méně než minElements elementů může být vráceno, pokud bylo dosaženo konce datového proudu nebo byl podkladový proud uzavřen. Konkrétně:

    • Pokud minElements nebo více prvků je k dispozici, promise se vyřeší s { value: <buffer view sized to bytes read>, done: false }.
    • Pokud stream skončí poté, co bylo přečteno nějaké množství dat, ale méně než minElements elementů se příslib vyřeší s částečnými daty: { value: <buffer view sized to bytes actually read>, done: false }. Další volání read nebo readAtLeast poté vrátí { value: undefined, done: true }.
    • Pokud stream skončí s nula dostupnými bajty (tedy stream je již na EOF), promise se vyřeší s hodnotou { value: <zero-length view>, done: true }.
    • Pokud ve streamu dojde k chybě, promise skončí odmítnutím.
    • minElements musí být alespoň 1 a minElements * elementSize nesmí přesáhnout délku v bajtech bufferArrayBufferView, nebo se promise zamítne s TypeError. Pro Uint8Array, velikost prvku je 1, takže minElements je fakticky počet bajtů.

• Streams
• Základní informace o čtečkách BYOB ve specifikaci WHATWG Streams API ↗