Crate upkr 

Compression and decompression of the upkr format and variants.

Upkr is a compression format initially designed for the MicroW8 fantasy console, with design goals being a competitive compression ratio, reasonable fast decompression, low memory overhead and very small decompression code when handoptimized in assembler. (An optimized DOS execuable decompressor is <140 bytes.)

Structs

Config

A configuration of which compression format variation to use.

Heatmap

Heatmap information about a compressed block of data.

Enums

UnpackError

The error type for the uncompressing related functions

Functions

calculate_margin

Calculates the minimum margin when overlapping buffers.

compressed_size

Estimate the exact (fractional) size of upkr compressed data.

create_heatmap

Calculates a Heatmap from compressed data.

pack

Compresses the given data.

unpack

Uncompress a piece of compressed data

Type Aliases

ProgressCallback

The type of a callback function to be given to the pack function.