Skip to content

writeFileStream ​

writeFileStream creates or truncates a file and returns a bounded Result<WritableStream<u8[]>, FsError>. Backpressure keeps producers from buffering the complete output in memory.

Signature ​

tyrus
function writeFileStream(path: string): Result<WritableStream<u8[]>, FsError>

The queue holds at most 256 KiB. await stream.close() and await source.pipeTo(stream) resolve only after all accepted chunks have been written and the file buffer has been flushed.

Example ​

tyrus
import { FsError, writeFileStream } from "tyrus:fs";
import { WritableStream } from "tyrus:stream";

match (writeFileStream("archive.bin")) {
    Ok(stream) => { print("output stream opened"); } // output stream opened
    Err(error) => { printError(error.code); } // ERR_FS_WRITE_FAILED
}

Opening failures return Err(FsError). Write or flush failures reject stream operations with StreamError.