README
¶
This is a pure Go implementation of antirez's SMAZ, a library for compressing short, English strings (it won't work well for other languages).
Installation
$ go get github.com/kjk/smaz
Usage
import (
"github.com/kjk/smaz"
)
func main() {
s := "Now is the time for all good men to come to the aid of the party."
compressed := smaz.Encode(nil, []byte(s))
decompressed, err := smaz.Decode(nil, compressed)
if err != nil {
fmt.Printf("decompressed: %s\n", string(decompressed))
...
}
Full API documentation.
Notes
This is not a direct port of the C version. It is not guaranteed that the output
of smaz.Encode will be precisely the same as the C library. However, the
output should be decompressible by the C library, and the output of the C
library should be decompressible by smaz.Decode.
Author
Salvatore Sanfilippo designed SMAZ and wrote [C implementation]](https://github.com/antirez/smaz).
Caleb Spare wrote initial Go port.
Krzysztof Kowalczyk improved speed of decompression (2.4x faster) and compression (1.3x faster).
Contributors
License
MIT Licensed.
Other implementations
Documentation
¶
Overview ¶
Package smaz is a pure Go implementation of the smaz algorithm (https://github.com/antirez/smaz) for compressing small strings.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrCorrupt = errors.New("smaz: corrupt input")
ErrCorrupt reports that the input is invalid.
Functions ¶
func Decode ¶
Decode returns the decoded form of src. The returned slice may be a sub-slice of dst if dst was large enough to hold the entire decoded block. Otherwise, a newly allocated slice will be returned. It is valid to pass a nil dst.
func Encode ¶
Encode returns the encoded form of src. The returned slice may be a sub-slice of dst if dst was large enough to hold the entire encoded block. Otherwise, a newly allocated slice will be returned. It is valid to pass a nil dst.
func LoadCustomTable ¶
func LoadCustomTable(table []string)
Types ¶
This section is empty.
Source Files
Directories