lzfse

README

lzfse-cgo

Go bindings for lzfse compression.

---

Install

go get github.com/blacktop/lzfse-cgo

Getting Started

import (
    "log"
    "os"

    "github.com/blacktop/lzfse-cgo"
)

func main() {

    dat, err := os.ReadFile("encoded.file")
    if err != nil {
        log.Fatal(fmt.Errorf("failed to read compressed file: %v", err))
    }

    decompressed = lzfse.DecodeBuffer(dat)

    err = os.WriteFile("decoded.file", decompressed, 0644)
    if err != nil {
        log.Fatal(fmt.Errorf("failed to decompress file: %v", err))
    }
}

Credit

• https://github.com/zchee/go-lzfse
• https://github.com/eafer/libzbitmap

License

MIT Copyright (c) 2019-2024 blacktop

Documentation

Overview

Package lzfse provides Go bindings for lzfse.

Index

• func DecodeBuffer(srcBuffer []byte) []byte
• func DecodeLZVNBuffer(encBuf, decBuf []byte) uint
• func DecodeScratchSize() uint
• func EncodeBuffer(srcBuffer []byte) []byte
• func EncodeLZVNBuffer(srcBuf, dstBuf []byte) uint
• func EncodeScratchSize() uint
• func LzBitMapDecompress(src, dst []byte) int

Functions

func DecodeBuffer

func DecodeBuffer(srcBuffer []byte) []byte

DecodeBuffer function as declared in lzfse.h:126

func DecodeLZVNBuffer

func DecodeLZVNBuffer(encBuf, decBuf []byte) uint

DecodeLZVNBuffer function as declared in lzfse_internal.h:413

func DecodeScratchSize

func DecodeScratchSize() uint

DecodeScratchSize function as declared in lzfse.h:94

func EncodeBuffer

func EncodeBuffer(srcBuffer []byte) []byte

EncodeBuffer function as declared in lzfse.h:87

func EncodeLZVNBuffer

func EncodeLZVNBuffer(srcBuf, dstBuf []byte) uint

EncodeLZVNBuffer function as declared in lzvn_encode_base.c:383

func EncodeScratchSize

func EncodeScratchSize() uint

EncodeScratchSize function as declared in lzfse.h:56

func LzBitMapDecompress

func LzBitMapDecompress(src, dst []byte) int