brotli

README

Brotli Decoder for Go

Introduction

This package is a brotli decompressor implemented in pure Go.

This package is a brotli compressor and decompressor implemented in Go.

It was translated from the reference implementation (https://github.com/google/brotli) with the `c2go** tool at https://github.com/andybalholm/c2go.

Upstream

This package is a fork of the upstream project to create a more minimal package with just the decoder and not the encoder.

This is a significantly lighter package in terms of binary size.

It was created by deleting the writer types and then repeatedly removing all unused symbols (detected with the gounused linter).

If you need the brotli compressor, see the upstream project.

Documentation

Index

• type Reader
  • func NewReader(src io.Reader) *Reader
  • func (r *Reader) Read(p []byte) (n int, err error)
  • func (r *Reader) Reset(src io.Reader) error

Types

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

func NewReader

func NewReader(src io.Reader) *Reader

NewReader creates a new Reader reading the given reader.

func (*Reader) Read

func (r *Reader) Read(p []byte) (n int, err error)

func (*Reader) Reset

func (r *Reader) Reset(src io.Reader) error

Reset discards the Reader's state and makes it equivalent to the result of its original state from NewReader, but reading from src instead. This permits reusing a Reader rather than allocating a new one. Error is always nil