Module lz4

Data Types

option()

option() = high

Compressor option.

high
Compresses with high ratio.

pack()

pack() = binary()

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

Function Index

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

Function Details

compress/1

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

Equals compress(Binary, []).

See also: compress/2.

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/1

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

Equals pack(Binary, []).

See also: pack/2.

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/2

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/1

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

Return a uncompressed binary compressed with pack/2.

See also: pack/2.


Generated by EDoc, Sep 18 2023, 23:05:07.