decompression_stream

A transform stream that decompresses its input. Pipe compressed bytes through to recover the original byte stream. Pair with gossamer/compression/compression_stream for the inverse.

Types

DecompressionStream

</>

A transform stream that decompresses its input. Write compressed bytes to writable(stream); read uncompressed bytes from readable(stream).

See DecompressionStream on MDN.

Examples

let decompressor = decompression_stream.new(compression.Gzip)

pub type DecompressionStream

Values

new

</>

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

Creates a DecompressionStream for the given format.

read_write_pair

</>

pub fn read_write_pair(
  stream: DecompressionStream,
) -> #(
  readable_stream.ReadableStream(BitArray),
  writable_stream.WritableStream(BitArray),
)

Returns the readable and writable sides of the stream as a tuple. Convenient for passing directly to readable_stream.pipe_through.

readable

</>

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

The readable side of the stream — produces uncompressed bytes.

writable

</>

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

The writable side of the stream — accepts compressed byte chunks.