Categorygithub.com/segmentio/kafka-gocompresssnappygo-xerial-snappy
package
0.4.47
Repository: https://github.com/segmentio/kafka-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
4
Dependents
0
Files
110 SLOC

# README

go-xerial-snappy

Build Status

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).

# Functions

Decode decodes snappy data whether it is traditional unframed or includes the xerial framing format.
DecodeInto decodes snappy data whether it is traditional unframed or includes the xerial framing format into the specified `dst`.
Encode encodes data as snappy with no framing header.
EncodeStream *appends* to the specified 'dst' the compressed 'src' in xerial framing format.

# Variables

ErrMalformed is returned by the decoder when the xerial framing is malformed.