kotlin-web/web.streams/ReadableStreamBYOBReader

ReadableStreamBYOBReader

open class ReadableStreamBYOBReader(stream: ReadableStream<Uint8Array<ArrayBuffer>>) : ReadableStreamGenericReader(source)

The ReadableStreamBYOBReader interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source.

MDN Reference

Constructors

constructor(stream: ReadableStream<Uint8Array<ArrayBuffer>>)

Properties

closed

open val closed: Promise<Void?>

MDN Reference

Functions

cancel

inline suspend fun ReadableStreamGenericReader.cancel()

inline suspend fun ReadableStreamGenericReader.cancel(reason: JsError?)

MDN Reference

cancelAsync

open fun cancelAsync(reason: JsError? = definedExternally): Promise<Void?>

MDN Reference

read

inline suspend fun <T : ArrayBufferView<*>> ReadableStreamBYOBReader.read(view: T): ReadableStreamReadResult<T>

inline suspend fun <T : ArrayBufferView<*>> ReadableStreamBYOBReader.read(view: T, options: ReadableStreamBYOBReaderReadOptions): ReadableStreamReadResult<T>

The read() method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream.

readAsync

fun <T : ArrayBufferView<*>> readAsync(view: T, options: ReadableStreamBYOBReaderReadOptions = definedExternally): Promise<ReadableStreamReadResult<T>>

The read() method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream.

releaseLock

fun releaseLock()

The releaseLock() method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream.