zlib codecs for TranscodingStreams.jl.
Clone or download
Latest commit 238f4c2 Aug 13, 2018

README.md

CodecZlib.jl

TravisCI Status AppVeyor Status codecov.io

Installation

Pkg.add("CodecZlib")

Usage

Note: GzipCompression, GzipDecompressionStream, etc. are deprecated. Use GzipCompressor, GzipDecompressorStream, etc. instead.

using CodecZlib

# Some text.
text = """
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sollicitudin
mauris non nisi consectetur, a dapibus urna pretium. Vestibulum non posuere
erat. Donec luctus a turpis eget aliquet. Cras tristique iaculis ex, eu
malesuada sem interdum sed. Vestibulum ante ipsum primis in faucibus orci luctus
et ultrices posuere cubilia Curae; Etiam volutpat, risus nec gravida ultricies,
erat ex bibendum ipsum, sed varius ipsum ipsum vitae dui.
"""

# Streaming API.
stream = GzipCompressorStream(IOBuffer(text))
for line in eachline(GzipDecompressorStream(stream))
    println(line)
end
close(stream)

# Array API.
compressed = transcode(GzipCompressor, text)
@assert sizeof(compressed) < sizeof(text)
@assert transcode(GzipDecompressor, compressed) == Vector{UInt8}(text)

This package exports following codecs and streams:

Codec Stream
GzipCompressor GzipCompressorStream
GzipDecompressor GzipDecompressorStream
ZlibCompressor ZlibCompressorStream
ZlibDecompressor ZlibDecompressorStream
DeflateCompressor DeflateCompressorStream
DeflateDecompressor DeflateDecompressorStream

See docstrings and TranscodingStreams.jl for details.