gossamer/decompression_stream

Types

DecompressionStream

An API for decompressing a stream of data.

Examples

let assert Ok(input) = deno.open_sync("./file.txt.gz", [open.Read])
let assert Ok(output) = deno.create_sync("./file.txt")
let decompressor = decompression_stream.new(compression_format.Gzip)

fs_file.readable(input)
|> readable_stream.pipe_through(
  #(
    decompression_stream.readable(decompressor),
    decompression_stream.writable(decompressor),
  ),
  [],
)
|> readable_stream.pipe_to(fs_file.writable(output), [])

pub type DecompressionStream

Values

new

</>

pub fn new(
  format: compression_format.CompressionFormat,
) -> DecompressionStream

Creates a new DecompressionStream object which decompresses a stream of data.

Throws a TypeError if the format passed to the constructor is not supported.

readable

</>

pub fn readable(
  stream: DecompressionStream,
) -> readable_stream.ReadableStream(uint8_array.Uint8Array)

writable

</>

pub fn writable(
  stream: DecompressionStream,
) -> writable_stream.WritableStream(uint8_array.Uint8Array)