snappy

README

go-xerial-snappy

Xerial-compatible Snappy framing support for golang.

Packages using Xerial for snappy encoding use a framing format incompatible with basically everything else in existence. This package wraps Go's built-in snappy package to support it.

Apps that use this format include Apache Kafka (see https://github.com/dpkp/kafka-python/issues/126#issuecomment-35478921 for details).

Documentation

Index

• Variables
• func Decode(src []byte) ([]byte, error)
• func Encode(src []byte) []byte
• func EncodeXerialFramingFormat(src []byte) []byte
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func NewWriterWithBlockSize(w io.Writer, blockSize int) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Flush() error
  • func (w *Writer) Reset(writer io.Writer)
  • func (w *Writer) Write(data []byte) (n int, err error)

Variables

var (
	HeaderSize = len(currentHeader)

	MinBlockSize = 1 * 1024

	DefaultBlockSize = 32 * 1024
)

Functions

func Decode

func Decode(src []byte) ([]byte, error)

Decode decodes snappy data whether it is traditional unframed or includes the xerial framing format.

func Encode

func Encode(src []byte) []byte

Encode encodes data as snappy with no framing header.

func EncodeXerialFramingFormat

func EncodeXerialFramingFormat(src []byte) []byte

Encode encodes data as snappy with xerial framing format

Types

type Writer

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

'copy' from org.xerial.snappy.SnappyOutputStream

func NewWriter

func NewWriter(w io.Writer) *Writer

func NewWriterWithBlockSize

func NewWriterWithBlockSize(w io.Writer, blockSize int) *Writer

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) Flush

func (w *Writer) Flush() error

func (*Writer) Reset

func (w *Writer) Reset(writer io.Writer)

func (*Writer) Write

func (w *Writer) Write(data []byte) (n int, err error)