lzx

Documentation

Overview

Package lzx implements a decompressor for the the WIM variant of the LZX compression algorithm.

The LZX algorithm is an earlier variant of LZX DELTA, which is documented at https://msdn.microsoft.com/en-us/library/cc483133(v=exchg.80).aspx.

Index

• func NewReader(r io.Reader, uncompressedSize int) (io.ReadCloser, error)
• type Reader

Functions

func NewReader

func NewReader(r io.Reader, uncompressedSize int) (io.ReadCloser, error)

NewReader returns a new io.ReadCloser that decompresses a WIM LZX stream until uncompressedSize bytes have been returned.

Types

type Reader

type Reader interface {
	io.Reader
	io.ByteReader
}

Reader is an interface used by the decompressor to access the input stream. If the provided io.Reader does not implement Reader, then a bufio.Reader is used.