smaz

README

smaz

SMAZ Compression Algorithm in Pure Go, Python, and PHP

Documentation

Overview

Package smaz implements the Smaz compression algorithm for small strings. Based on the original smaz library by antirez.

Index

• func Compress(input []byte) ([]byte, error)
• func CompressString(s string) ([]byte, error)
• func Decompress(input []byte) ([]byte, error)
• func DecompressString(data []byte) (string, error)
• func MustCompress(input []byte) []byte
• func MustDecompress(input []byte) []byte
• type SmazError
  • func (e *SmazError) Error() string

Functions

func Compress

func Compress(input []byte) ([]byte, error)

Compress compresses a byte slice using the Smaz algorithm

func CompressString

func CompressString(s string) ([]byte, error)

CompressString compresses a string to bytes

func Decompress

func Decompress(input []byte) ([]byte, error)

Decompress decompresses Smaz-compressed data

func DecompressString

func DecompressString(data []byte) (string, error)

DecompressString decompresses bytes to a string

func MustCompress

func MustCompress(input []byte) []byte

MustCompress compresses data and panics on error

func MustDecompress

func MustDecompress(input []byte) []byte

MustDecompress decompresses data and panics on error

Types

type SmazError

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

SmazError represents an error during compression/decompression

func (*SmazError) Error

func (e *SmazError) Error() string