{"id":16657425,"url":"https://github.com/whatyouhide/nimble_lz4","last_synced_at":"2025-04-07T10:27:42.575Z","repository":{"id":36956994,"uuid":"494189426","full_name":"whatyouhide/nimble_lz4","owner":"whatyouhide","description":"LZ4 compression for Elixir using Rust NIFs. 🗜","archived":false,"fork":false,"pushed_at":"2024-12-17T07:22:27.000Z","size":52,"stargazers_count":29,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-31T09:05:11.941Z","etag":null,"topics":["compression","elixir","elixir-lang","elixir-library","low-level","lz4","rustler","rustler-precompiled"],"latest_commit_sha":null,"homepage":"https://github.com/lz4/lz4","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whatyouhide.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-19T18:37:20.000Z","updated_at":"2025-01-02T04:25:25.000Z","dependencies_parsed_at":"2024-10-12T10:00:40.419Z","dependency_job_id":"94c279fe-62b4-498e-ae99-901c1dfcf29f","html_url":"https://github.com/whatyouhide/nimble_lz4","commit_stats":{"total_commits":43,"total_committers":5,"mean_commits":8.6,"dds":"0.11627906976744184","last_synced_commit":"1df4da22f1bcdd4a422898a5740f85abbd5a2622"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whatyouhide%2Fnimble_lz4","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whatyouhide%2Fnimble_lz4/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whatyouhide%2Fnimble_lz4/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whatyouhide%2Fnimble_lz4/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whatyouhide","download_url":"https://codeload.github.com/whatyouhide/nimble_lz4/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247634688,"owners_count":20970584,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compression","elixir","elixir-lang","elixir-library","low-level","lz4","rustler","rustler-precompiled"],"created_at":"2024-10-12T10:00:31.114Z","updated_at":"2025-04-07T10:27:42.542Z","avatar_url":"https://github.com/whatyouhide.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NimbleLZ4 🗜️\n\n\u003e [LZ4] compression library for Elixir that uses Rust NIFs.\n\n## Installation\n\nAdd this to your dependencies in `mix.exs`.\n\n```elixir\ndefp deps do\n  [\n    # ...,\n    {:nimble_lz4, \"~\u003e 0.1.0\"}\n  ]\nend\n```\n\nNimbleLZ4 requires OTP 23+ and Elixir 1.11+.\n\n### Native Code\n\nNimbleLZ4 uses [RustlerPrecompiled] to build precompiled version of the\nnecessary Rust NIFs bindings for a variety of platforms, NIF versions, and\noperating systems. RustlerPrecompiled should automatically download the correct\nversion of the bindings when compiling NimbleLZ4 as a dependency of your\napplication.\n\nYou can **force compilation** of the native code by setting the\n`NIMBLELZ4_FORCE_BUILD` environment variable to `true`:\n\n```shell\nNIMBLELZ4_FORCE_BUILD=true mix deps.compile\n```\n\n## Usage\n\nYou can compress and decompress data.\n\n[Block format](https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md):\n\n```elixir\niex\u003e uncompressed = :crypto.strong_rand_bytes(10)\niex\u003e compressed = NimbleLZ4.compress(uncompressed)\niex\u003e {:ok, ^uncompressed} = NimbleLZ4.decompress(compressed, _uncompressed_size = 10)\ntrue\n```\n\n[Frame format](https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md) ([self-contained](https://android.googlesource.com/platform/external/lz4/+/HEAD/doc/lz4_Block_format.md#metadata)):\n\n```elixir\niex\u003e uncompressed = :crypto.strong_rand_bytes(10_000)\niex\u003e compressed = NimbleLZ4.compress_frame(uncompressed)\niex\u003e {:ok, ^uncompressed} = NimbleLZ4.decompress_frame(compressed)\ntrue\n```\n\n[LZ4]: https://github.com/lz4/lz4\n[RustlerPrecompiled]: https://github.com/philss/rustler_precompiled\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhatyouhide%2Fnimble_lz4","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhatyouhide%2Fnimble_lz4","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhatyouhide%2Fnimble_lz4/lists"}