Changelog

View Source

0.1.1

Fixed

  • Docstrings in src/lz4_nif.erl used markdown-style matching backticks (`text`) which edoc parses as an unterminated inline-code quote. The package itself published cleanly in 0.1.0, but the edoc_doclet_chunks step that emits binary -doc chunks for m:Module.help/1 lookups errored out. Rewritten to edoc-native syntax (`text' — backtick + apostrophe) so chunks generate cleanly. No source or API changes.

0.1.0

Initial release.

  • lz4_nif:compress/1, lz4_nif:compress/2, lz4_nif:uncompress/2 exposing the LZ4 block-format codec.
  • Vendors upstream lz4 v1.10.0 (lz4.c + lz4.h, BSD-2-Clause).
  • Raw NIF (no rustler, no enif wrapper crate). Dirty CPU scheduler dispatch for inputs above 20 KB. Inline path reports its cost to the scheduler via enif_consume_timeslice, proportional to bytes processed (cost model: ~100 bytes/reduction, 4000-reduction timeslice — calibrated for LZ4's throughput).
  • Build via c_src/build.sh with the correct OTP 27+ -eval/-s init stop option order.
  • CI matrix: OTP 25, 26, 27, 28 in erlang:${otp} containers.
  • Hex package published with rebar3_ex_doc documentation.