brotli

Documentation

Index

• Constants
• func BroccoliConcat(files ...[]byte) ([]byte, error)
• func BroccoliConcatWithWindowSize(windowSize uint8, files ...[]byte) ([]byte, error)
• func BrotliDecoderVersion() uint32
• func BrotliEncoderVersion() uint32
• func BrotliParseHeader(data []byte) (returnedVersion byte, returnedSize uint64, err error)
• type BroccoliConcatReader
  • func NewBroccoliConcatReader(upstreams ...io.Reader) *BroccoliConcatReader
  • func NewBroccoliConcatReaderWithWindowSize(windowSize byte, upstreams ...io.Reader) *BroccoliConcatReader
  • func (mself *BroccoliConcatReader) Read(data []byte) (int, error)
• type CompressionOptions
• type CompressionReader
  • func NewCompressionReader(upstream io.Reader, options CompressionOptions) *CompressionReader
  • func (mself *CompressionReader) Close() error
  • func (mself *CompressionReader) Read(data []byte) (int, error)
• type CompressionWriter
  • func NewCompressionWriter(downstream io.Writer, options CompressionOptions) *CompressionWriter
  • func (mself *CompressionWriter) Close() error
  • func (mself *CompressionWriter) Flush() error
  • func (mself *CompressionWriter) Write(data []byte) (int, error)
• type DecompressionReader
  • func NewDecompressionReader(upstream io.Reader) *DecompressionReader
  • func (mself *DecompressionReader) Close() error
  • func (mself *DecompressionReader) Read(data []byte) (int, error)
• type DecompressionWriter
  • func NewDecompressionWriter(downstream io.Writer) *DecompressionWriter
  • func (mself *DecompressionWriter) Close() error
  • func (mself *DecompressionWriter) Write(data []byte) (int, error)
• type MultiCompressionReader
  • func NewMultiCompressionReader(upstream io.Reader, options CompressionOptions) *MultiCompressionReader
  • func (mself *MultiCompressionReader) Close() error
  • func (mself *MultiCompressionReader) Read(data []byte) (int, error)
• type MultiCompressionWriter
  • func NewMultiCompressionWriter(downstream io.Writer, options CompressionOptions) *MultiCompressionWriter
  • func (mself *MultiCompressionWriter) Close() error
  • func (mself *MultiCompressionWriter) Write(data []byte) (int, error)

Constants

const BROTLI_OPERATION_FINISH = 2

const BROTLI_OPERATION_FLUSH = 1

const BROTLI_OPERATION_PROCESS = 0

const BufferSize = 16384

Functions

func BroccoliConcat

func BroccoliConcat(files ...[]byte) ([]byte, error)

func BroccoliConcatWithWindowSize

func BroccoliConcatWithWindowSize(windowSize uint8, files ...[]byte) ([]byte, error)

func BrotliDecoderVersion

func BrotliDecoderVersion() uint32

func BrotliEncoderVersion

func BrotliEncoderVersion() uint32

func BrotliParseHeader

func BrotliParseHeader(data []byte) (returnedVersion byte, returnedSize uint64, err error)

Types

type BroccoliConcatReader

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

func NewBroccoliConcatReader

func NewBroccoliConcatReader(upstreams ...io.Reader) *BroccoliConcatReader

func NewBroccoliConcatReaderWithWindowSize

func NewBroccoliConcatReaderWithWindowSize(windowSize byte, upstreams ...io.Reader) *BroccoliConcatReader

func (*BroccoliConcatReader) Read

func (mself *BroccoliConcatReader) Read(data []byte) (int, error)

type CompressionOptions

type CompressionOptions struct {
	NumThreads                    int
	Quality                       float32
	Catable                       bool
	Appendable                    bool
	Magic                         bool
	Mode                          int
	LgWin                         byte
	LgBlock                       byte
	DisableLiteralContextModeling bool
	SizeHint                      uint32
	NumDirect                     uint32
	NumPostfix                    uint32
	LiteralByteScore              uint32
	AvoidDistancePrefixSearch     bool
	MaxBytesBeforeFlush           int
}

type CompressionReader

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

func NewCompressionReader

func NewCompressionReader(upstream io.Reader, options CompressionOptions) *CompressionReader

*

• Make a Reader that incrementally compresses data as it receives that
• data from the upstream

func (*CompressionReader) Close

func (mself *CompressionReader) Close() error

func (*CompressionReader) Read

func (mself *CompressionReader) Read(data []byte) (int, error)

type CompressionWriter

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

func NewCompressionWriter

func NewCompressionWriter(downstream io.Writer, options CompressionOptions) *CompressionWriter

*

• Make a Writer that incrementally compresses incoming data as it is received.
• Can call Flush to force data to be written out

func (*CompressionWriter) Close

func (mself *CompressionWriter) Close() error

func (*CompressionWriter) Flush

func (mself *CompressionWriter) Flush() error

func (*CompressionWriter) Write

func (mself *CompressionWriter) Write(data []byte) (int, error)

type DecompressionReader

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

func NewDecompressionReader

func NewDecompressionReader(upstream io.Reader) *DecompressionReader

func (*DecompressionReader) Close

func (mself *DecompressionReader) Close() error

func (*DecompressionReader) Read

func (mself *DecompressionReader) Read(data []byte) (int, error)

type DecompressionWriter

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

func NewDecompressionWriter

func NewDecompressionWriter(downstream io.Writer) *DecompressionWriter

func (*DecompressionWriter) Close

func (mself *DecompressionWriter) Close() error

func (*DecompressionWriter) Write

func (mself *DecompressionWriter) Write(data []byte) (int, error)

type MultiCompressionReader

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

func NewMultiCompressionReader

func NewMultiCompressionReader(
	upstream io.Reader,
	options CompressionOptions,
) *MultiCompressionReader

*

• Make a Reader that absorbs the whole upstream reader and then
• compresses the entire file at once using as many threads as specified.

func (*MultiCompressionReader) Close

func (mself *MultiCompressionReader) Close() error

func (*MultiCompressionReader) Read

func (mself *MultiCompressionReader) Read(data []byte) (int, error)

type MultiCompressionWriter

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

func NewMultiCompressionWriter

func NewMultiCompressionWriter(
	downstream io.Writer,
	options CompressionOptions,
) *MultiCompressionWriter

*

• Absorb all the data and when close is called, compress that data
• on a number of threads equal to options.NumThreads

func (*MultiCompressionWriter) Close

func (mself *MultiCompressionWriter) Close() error

func (*MultiCompressionWriter) Write

func (mself *MultiCompressionWriter) Write(data []byte) (int, error)