compress

Documentation

Index

• func EncodeFormat(data []byte, f Format) []byte
• type CompressorFunc
• type DecompressorFunc
• type Format
  • func DecodeFormat(data []byte) ([]byte, Format)
  • func (f Format) Valid() bool

Functions

func EncodeFormat

func EncodeFormat(data []byte, f Format) []byte

EncodeFormat adds the compression format to the compressed data.

Types

type CompressorFunc

type CompressorFunc func(data []byte) (compressed []byte, err error)

CompressorFunc is the function the prototype for compression.

var PassthroughCompressor CompressorFunc = func(data []byte) ([]byte, error) {
	return []byte(hex.EncodeToString(data)), nil
}

PassthroughCompressor is a dummy function for development and testing *ONLY*.

* WARNING: DO NOT USE IN PRODUCTION. * PassthroughCompressor is *NOT* compression and *DOES NOT* compress data.

type DecompressorFunc

type DecompressorFunc func(compressed []byte) (data []byte, err error)

DecompressorFunc is the function the prototype for decompression.

var PassthroughDecompressor DecompressorFunc = func(compressed []byte) ([]byte, error) {
	return hex.DecodeString(string(compressed))
}

PassthroughDecompressor is a dummy function for development and testing *ONLY*.

* WARNING: DO NOT USE IN PRODUCTION. * PassthroughDecompressor is *NOT* decompression and *DOES NOT* decompress data.

type Format

type Format string

Format is the supporter compression algorithm type.

const (
	// None no compression.
	None Format = ""

	// Custom a custom compression format is being used.
	Custom Format = "custom"

	// Zstd Zstandard compression https://facebook.github.io/zstd/.
	Zstd Format = "zstd"
)

TODO: support additional compression algorithms besides

Zstandard from https://github.com/klauspost/compress

func DecodeFormat

func DecodeFormat(data []byte) ([]byte, Format)

DecodeFormat removes and returns the compression format from the compressed data. If no compression format is found DecodeFormat returns the original the data.

func (Format) Valid

func (f Format) Valid() bool

Valid returns true if the Format is valid.