Skip to content

DuplexStream ​

DuplexStream<TRead, TWrite> groups one readable side and one writable side without granting either capability extra permissions. A TCP connection becomes one through TcpStream.stream(), and a binary WebSocket connection through WebSocket.stream(), both as DuplexStream<u8[], u8[]>. TCP chunks are transport bytes; every WebSocket chunk is one complete binary message.

SignatureDuplexStream<TRead, TWrite>

Members ​

MemberSignaturePurpose
readableReadableStream<TRead>Receives values.
writableWritableStream<TWrite>Sends values.
close() => Promise<void>Closes both sides together.

Usage ​

tyrus
async function relay(stream: DuplexStream<u8[], u8[]>, bytes: u8[]): Promise<void> {
    await stream.writable.write(bytes);
    const received: u8[]? = await stream.readable.read();
    await stream.close();
}

error

tyrus
async function invalid(stream: DuplexStream<u8[], string>): Promise<void> {
await stream.writable.write([1, 2, 3]); 
}

Errors ​

close() rejects with StreamError if either side cannot complete its lifecycle. Read and write failures remain isolated to their corresponding capability.