https://github.com/itchio/go-brotli

Go bindings for the Brotli compression library (fork of kothar/brotli-go)
https://github.com/itchio/go-brotli

Last synced: about 2 months ago
JSON representation

Go bindings for the Brotli compression library (fork of kothar/brotli-go)

• Host: GitHub
• URL: https://github.com/itchio/go-brotli
• Owner: itchio
• License: mit
• Created: 2018-01-09T13:01:05.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-07-02T11:43:32.000Z (over 5 years ago)
• Last Synced: 2024-06-18T21:44:12.281Z (7 months ago)
• Language: C
• Size: 7.64 MB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Go bindings for the Brotli compression library

[![GoDoc](https://godoc.org/github.com/itchio/go-brotli?status.svg)](https://godoc.org/github.com/itchio/go-brotli)

[![Build Status](https://travis-ci.org/itchio/go-brotli.svg)](https://travis-ci.org/itchio/go-brotli)

This is a fork of Mike Houston's  with

the following changes:

  * Bumped to a more recent upstream (post-1.0.0)

  * Removed custom dictionary support (which was removed from upstream)

See  for the upstream C/C++ source, and

the `VERSION.md` file to find out the currently vendored version.

### Usage

Instead of including potentially-outdated examples in the README, 

please refer to the `Examples` tests on the following godoc pages:

  * Decompression: 

  * Compression: 

### Bindings

This is a very basic Cgo wrapper for the enc and dec directories from the Brotli sources.

A few minor changes have been made to get things working with Go:

1. The default dictionary has been extracted to a separate 'common' package to allow linking the enc and dec cgo modules if you use both. Otherwise there are duplicate symbols, as described in the dictionary.h header files.

2. The dictionary variable name for the dec package has been modified for the same reason, to avoid linker collisions.

### Links

  * original bindings: 

  * upstream cgo bindings (requires separate library compilation): 

  * brotli streaming decompression written in pure go: 

### License

Brotli and these bindings are open-sourced under the MIT License - see the LICENSE file.