lzma

README

outside-lzma: liblzma API definitions for the Go language (PRERELEASE)

Fire off quick questions to @tHinqa on Twitter

Covered by the same licence conditions as Go is

For use with outside

Documentation

Overview

Package lzma provides API definitions for accessing the liblzma dll.

Index

• Variables
• type Action
• type Allocator
• type Block
• type Bool
• type Check
• type Enum
• type Filter
• type Index
• type IndexHash
• type IndexIter
• type IndexIterMode
• type Internal
• type MatchFinder
• type Mode
• type OptionsLzma
• type Ret
• type Stream
• type StreamFlags
• type Vli
• type Void

Variables

var (
	Code func(strm *Stream, action Action) Ret

	End func(strm *Stream)

	Memusage func(strm *Stream) uint64

	MemlimitGet func(strm *Stream) uint64

	MemlimitSet func(strm *Stream, memlimit uint64) Ret

	VliEncode func(vli Vli, vliPos *uint,
		out *uint8, outPos *uint, outSize uint) Ret

	VliDecode func(vli *Vli, vliPos *uint,
		in *uint8, inPos *uint, inSize uint) Ret

	VliSize func(vli Vli) uint32

	CheckIsSupported func(check Check) Bool

	CheckSize func(check Check) uint32

	Crc32 func(buf *uint8, size uint, crc uint32) uint32

	Crc64 func(buf *uint8, size uint, crc uint64) uint64

	GetCheck func(strm *Stream) Check

	FilterEncoderIsSupported func(id Vli) Bool

	FilterDecoderIsSupported func(id Vli) Bool

	FiltersCopy func(src, dest *Filter, allocator *Allocator) Ret

	RawEncoderMemusage func(filters *Filter) uint64

	RawDecoderMemusage func(filters *Filter) uint64

	RawEncoder func(strm *Stream, filters *Filter) Ret

	RawDecoder func(strm *Stream, filters *Filter) Ret

	FiltersUpdate func(strm *Stream, filters *Filter) Ret

	RawBufferEncode func(filters *Filter, allocator *Allocator,
		in *uint8, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	RawBufferDecode func(filters *Filter, allocator *Allocator,
		in *uint8, inPos *uint, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	PropertiesSize func(size *uint32, filter *Filter) Ret

	PropertiesEncode func(filter *Filter, props *uint8) Ret

	PropertiesDecode func(filter *Filter, allocator *Allocator,
		props *uint8, propsSize uint) Ret

	FilterFlagsSize func(size *uint32, filter *Filter) Ret

	FilterFlagsEncode func(filter *Filter,
		out *uint8, outPos *uint, outSize uint) Ret

	FilterFlagsDecode func(filter *Filter, allocator *Allocator,
		in *uint8, inPos *uint, inSize uint) Ret

	MfIsSupported func(matchFinder MatchFinder) Bool

	ModeIsSupported func(mode Mode) Bool

	LzmaPreset func(options *OptionsLzma, preset uint32) Bool

	EasyEncoderMemusage func(preset uint32) uint64

	EasyDecoderMemusage func(preset uint32) uint64

	EasyEncoder func(strm *Stream, preset uint32, check Check) Ret

	EasyBufferEncode func(preset uint32, check Check,
		allocator *Allocator, in *uint8, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	StreamEncoder func(
		strm *Stream, filters *Filter, check Check) Ret

	AloneEncoder func(strm *Stream, options *OptionsLzma) Ret

	StreamBufferBound func(uncompressedSize uint) uint

	StreamBufferEncode func(filters *Filter, check Check,
		allocator *Allocator, in *uint8, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	StreamDecoder func(
		strm *Stream, memlimit uint64, flags uint32) Ret

	AutoDecoder func(
		strm *Stream, memlimit uint64, flags uint32) Ret

	AloneDecoder func(strm *Stream, memlimit uint64) Ret

	StreamBufferDecode func(memlimit *uint64, flags uint32,
		allocator *Allocator, in *uint8, inPos *uint, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	StreamHeaderEncode func(options *StreamFlags, out *uint8) Ret

	StreamFooterEncode func(options *StreamFlags, out *uint8) Ret

	StreamHeaderDecode func(options *StreamFlags, in *uint8) Ret

	StreamFooterDecode func(options *StreamFlags, in *uint8) Ret

	StreamFlagsCompare func(a, b *StreamFlags) Ret

	BlockHeaderSize func(block *Block) Ret

	BlockHeaderEncode func(block *Block, out *uint8) Ret

	BlockHeaderDecode func(
		block *Block, allocator *Allocator, in *uint8) Ret

	BlockCompressedSize func(block *Block, unpaddedSize Vli) Ret

	BlockUnpaddedSize func(block *Block) Vli

	BlockTotalSize func(block *Block) Vli

	BlockEncoder func(strm *Stream, block *Block) Ret

	BlockDecoder func(strm *Stream, block *Block) Ret

	BlockBufferBound func(uncompressedSize uint) uint

	BlockBufferEncode func(block *Block, allocator *Allocator,
		in *uint8, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	BlockBufferDecode func(block *Block, allocator *Allocator,
		in *uint8, inPos *uint, inSize uint,
		out *uint8, outPos *uint, outSize uint) Ret

	IndexMemusage func(streams Vli, blocks Vli) uint64

	IndexMemused func(i *Index) uint64

	IndexInit func(allocator *Allocator) *Index

	IndexEnd func(i *Index, allocator *Allocator)

	IndexAppend func(i *Index, allocator *Allocator,
		unpaddedSize, uncompressedSize Vli) Ret

	IndexStreamFlags func(i *Index, streamFlags *StreamFlags) Ret

	IndexChecks func(i *Index) uint32

	IndexStreamPadding func(i *Index, streamPadding Vli) Ret

	IndexStreamCount func(i *Index) Vli

	IndexBlockCount func(i *Index) Vli

	IndexSize func(i *Index) Vli

	IndexStreamSize func(i *Index) Vli

	IndexTotalSize func(i *Index) Vli

	IndexFileSize func(i *Index) Vli

	IndexUncompressedSize func(i *Index) Vli

	IndexIterInit func(iter *IndexIter, i *Index)

	IndexIterRewind func(iter *IndexIter)

	IndexIterNext func(iter *IndexIter, mode IndexIterMode) Bool

	IndexIterLocate func(iter *IndexIter, target Vli) Bool

	IndexCat func(dest, src *Index, allocator *Allocator) Ret

	IndexDup func(i *Index, allocator *Allocator) *Index

	IndexEncoder func(strm *Stream, i *Index) Ret

	IndexDecoder func(
		strm *Stream, i **Index, memlimit uint64) Ret

	IndexBufferEncode func(
		i *Index, out *uint8, outPos *uint, outSize uint) Ret

	IndexBufferDecode func(i **Index, memlimit *uint64,
		allocator *Allocator, in *uint8, inPos *uint,
		inSize uint) Ret

	IndexHashInit func(
		indexHash *IndexHash, allocator *Allocator) *IndexHash

	IndexHashEnd func(indexHash *IndexHash, allocator *Allocator)

	IndexHashAppend func(indexHash *IndexHash,
		unpaddedSize Vli, uncompressedSize Vli) Ret

	IndexHashDecode func(indexHash *IndexHash,
		in *uint8, inPos *uint, inSize uint) Ret

	IndexHashSize func(indexHash *IndexHash) Vli

	Physmem func() uint64

	VersionNumber func() uint32

	VersionString func() string
)

Types

type Action

type Action Enum

const (
	RUN Action = iota
	SYNC_FLUSH
	FULL_FLUSH
	FINISH
)

type Allocator

type Allocator struct {
	Alloc func(opaque *Void, nmemb uint, size uint) *Void
	Free  func(opaque *Void, ptr *Void)
	// contains filtered or unexported fields
}

type Block

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

type Bool

type Bool bool

type Check

type Check Enum

const (
	CHECK_NONE Check = iota
	CHECK_CRC32
	CHECK_CRC64  Check = 4
	CHECK_SHA256 Check = 10
)

type Enum

type Enum int

type Filter

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

type Index

type Index struct{}

type IndexHash

type IndexHash struct{}

type IndexIter

type IndexIter struct {
	Stream struct {
		// contains filtered or unexported fields
	}
	Block struct {
		// contains filtered or unexported fields
	}
	// contains filtered or unexported fields
}

type IndexIterMode

type IndexIterMode Enum

const (
	INDEX_ITER_ANY IndexIterMode = iota
	INDEX_ITER_STREAM
	INDEX_ITER_BLOCK
	INDEX_ITER_NONEMPTY_BLOCK
)

type Internal

type Internal struct{}

type MatchFinder

type MatchFinder Enum

const (
	MF_HC3 MatchFinder = iota + 0x03
	MF_HC4
)

const (
	MF_BT2 MatchFinder = iota + 0x12
	MF_BT3
	MF_BT4
)

type Mode

type Mode Enum

const (
	MODE_FAST Mode = iota + 1
	MODE_NORMAL
)

type OptionsLzma

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

type Ret

type Ret Enum

const (
	OK Ret = iota
	STREAM_END
	NO_CHECK
	UNSUPPORTED_CHECK
	GET_CHECK
	MEM_ERROR
	MEMLIMIT_ERROR
	FORMAT_ERROR
	OPTIONS_ERROR
	DATA_ERROR
	BUF_ERROR
	PROG_ERROR
)

type Stream

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

type StreamFlags

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

type Vli

type Vli uint64

type Void

type Void struct{}