https://github.com/juliaio/codeczlib.jl

zlib codecs for TranscodingStreams.jl.
https://github.com/juliaio/codeczlib.jl

compression julia zlib

Last synced: about 1 month ago
JSON representation

zlib codecs for TranscodingStreams.jl.

• Host: GitHub
• URL: https://github.com/juliaio/codeczlib.jl
• Owner: JuliaIO
• License: other
• Created: 2017-05-08T19:59:44.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2025-02-11T19:36:05.000Z (3 months ago)
• Last Synced: 2025-04-13T00:45:57.839Z (about 1 month ago)
• Topics: compression, julia, zlib
• Language: Julia
• Homepage:
• Size: 107 KB
• Stars: 52
• Watchers: 5
• Forks: 23
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
CodecZlib.jl

============

[![CI](https://github.com/JuliaIO/CodecZlib.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaIO/CodecZlib.jl/actions/workflows/CI.yml)

[![codecov](https://codecov.io/gh/JuliaIO/CodecZlib.jl/graph/badge.svg?token=6V3Z847Ywr)](https://codecov.io/gh/JuliaIO/CodecZlib.jl)

## Installation

```julia

Pkg.add("CodecZlib")

```

## Usage

```julia

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](https://github.com/JuliaIO/TranscodingStreams.jl) for details.