Module lz4f

Data Types

block_mode()

block_mode() = linked | independent

block_size_id()

block_size_id() = default | max64KB | max256KB | max1MB | max4MB

cctx()

abstract datatype: cctx()

Resource.

dctx()

abstract datatype: dctx()

Resource.

frame_info()

frame_info() = #{block_size_id => block_size_id(), block_mode => block_mode(), content_checksum => boolean(), frame_type => frame_type(), content_size => non_neg_integer()}

frame_type()

frame_type() = frame | skippable_frame

opts()

opts() = #{frame_info => frame_info(), compression_level => integer(), auto_flush => boolean()}

Function Index

compress_begin/1
compress_begin/2
compress_end/1
compress_frame/1
compress_frame/2
compress_update/2
create_compression_context/0
create_decompression_context/0
decompress/1
decompress/2
flush/1
get_frame_info/2
support_available/0

Function Details

compress_begin/1

compress_begin(Cctx::cctx()) -> binary()

compress_begin/2

compress_begin(Cctx::cctx(), Opts::opts()) -> binary()

compress_end/1

compress_end(Cctx::cctx()) -> binary()

compress_frame/1

compress_frame(Data::binary()) -> binary()

compress_frame/2

compress_frame(Data::binary(), Opts::opts()) -> binary()

compress_update/2

compress_update(Cctx::cctx(), Data::binary() | [binary()]) -> iolist()

create_compression_context/0

create_compression_context() -> cctx()

create_decompression_context/0

create_decompression_context() -> dctx()

decompress/1

decompress(Data::binary()) -> iolist()

decompress/2

decompress(Dctx::dctx(), Data::binary()) -> iolist()

flush/1

flush(Cctx::cctx()) -> binary()

get_frame_info/2

get_frame_info(Dctx::dctx(), Data::binary()) -> {ok, frame_info(), non_neg_integer()}

support_available/0

support_available() -> boolean()


Generated by EDoc