gossamer/compression_stream

Types

CompressionStream

An API for compressing a stream of data.

Examples

let compressor = compression_stream.new(compression_format.Gzip)

stdin.readable()
|> readable_stream.pipe_through(
  #(
    compression_stream.readable(compressor),
    compression_stream.writable(compressor),
  ),
  [],
)
|> readable_stream.pipe_to(stdout.writable(), [])

pub type CompressionStream

Values

new

</>

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

Creates a new CompressionStream object which compresses a stream of data.

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

readable

</>

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

writable

</>

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