kotlin-web/web.transport/WebTransportReceiveStream

WebTransportReceiveStream

open class WebTransportReceiveStream : ReadableStream<Uint8Array<*>> (source)

The WebTransportReceiveStream interface of the WebTransport API is a ReadableStream that can be used to read from an incoming unidirectional or bidirectional WebTransport stream. Available only in secure contexts.

MDN Reference

Properties

locked

val locked: Boolean

The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.

Functions

cancel

inline suspend fun <R : ERROR CLASS: Symbol not found for JsAny??> ReadableStream<R>.cancel()

inline suspend fun <R : ERROR CLASS: Symbol not found for JsAny??> ReadableStream<R>.cancel(reason: JsError?)

The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

cancelAsync

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

The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

getReader

fun getReader(): ReadableStreamDefaultReader<Uint8Array<*>>

The getReader() method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

fun getReader(options: ReadableStreamGetReaderOptions = definedExternally): ReadableStreamReader

getStats

inline suspend fun WebTransportReceiveStream.getStats(): WebTransportReceiveStreamStats

The getStats() method of the WebTransportReceiveStream interface asynchronously returns an object containing statistics for the current stream.

getStatsAsync

fun getStatsAsync(): Promise<WebTransportReceiveStreamStats>

The getStats() method of the WebTransportReceiveStream interface asynchronously returns an object containing statistics for the current stream.

pipeThrough

fun <T : ERROR CLASS: Symbol not found for JsAny??> pipeThrough(transform: ReadableWritablePair<T, Uint8Array<*>>, options: StreamPipeOptions = definedExternally): ReadableStream<T>

The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

pipeTo

suspend fun <R : ERROR CLASS: Symbol not found for JsAny??> ReadableStream<R>.pipeTo(destination: WritableStream<R>)

suspend fun <R : ERROR CLASS: Symbol not found for JsAny??> ReadableStream<R>.pipeTo(destination: WritableStream<R>, options: StreamPipeOptions)

The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

pipeToAsync

fun pipeToAsync(destination: WritableStream<Uint8Array<*>>, options: StreamPipeOptions = definedExternally): Promise<Void>

tee

fun tee(): Tuple2<ReadableStream<Uint8Array<*>>, ReadableStream<Uint8Array<*>>>

The tee() method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.

values

fun values(options: ReadableStreamIteratorOptions = definedExternally): AsyncIterator<Uint8Array<*>>