Module lz4

Data Types

option() = high

Compressor option.

high

Compresses with high ratio.

pack() = binary()

Binary included compressed data and original size stored at first 4 bytes in little endian.

compress/1	Equals `compress(Binary, [])`.
compress/2	Returns an compressed binary.
pack/1	Equals `pack(Binary, [])`.
pack/2	Returns a binary included compressed data and original size.
uncompress/2	Returns an uncompressed binary.
unpack/1	Return a uncompressed binary compressed with `pack/2`.

compress(Binary::binary()) -> {ok, binary()} | {error, term()}

Equals compress(Binary, []).

See also: compress/2.

compress(Binary::binary(), Options::[option()]) -> {ok, binary()} | {error, term()}

Returns an compressed binary. Note that the compressed binary does not include original size to be needed at uncompressing.

See also: pack/2, uncompress/2.

pack(Binary::binary()) -> {ok, pack()} | {error, term()}

Equals pack(Binary, []).

See also: pack/2.

pack(Binary::binary(), Options::[option()]) -> {ok, pack()} | {error, term()}

Returns a binary included compressed data and original size. Use unpack/1 to uncompress the returned binary.

See also: compress/2, unpack/1.

uncompress(Binary::binary(), OrigSize::integer()) -> {ok, binary()} | {error, term()}

Returns an uncompressed binary. You need to specify original size as OrigSize.

See also: compress/2.

unpack(Binary::pack()) -> {ok, binary()} | {error, term()}

Return a uncompressed binary compressed with pack/2.

See also: pack/2.

Generated by EDoc