https://github.com/SOF3/include-flate

A variant of include_bytes!/include_str! with compile-time deflation and runtime lazy inflation
https://github.com/SOF3/include-flate

assets compression include resource-management rust rust-macro

Last synced: about 2 months ago
JSON representation

A variant of include_bytes!/include_str! with compile-time deflation and runtime lazy inflation

• Host: GitHub
• URL: https://github.com/SOF3/include-flate
• Owner: SOF3
• License: apache-2.0
• Created: 2019-08-13T11:23:18.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-27T19:57:29.000Z (9 months ago)
• Last Synced: 2024-04-25T17:21:15.499Z (5 months ago)
• Topics: assets, compression, include, resource-management, rust, rust-macro
• Language: Rust
• Homepage: https://docs.rs/include-flate
• Size: 1.08 MB
• Stars: 125
• Watchers: 3
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# include-flate

[!![CI](https://github.com/SOF3/include-flate/workflows/CI/badge.svg)](https://github.com/SOF3/include-flate/actions)

[![crates.io](https://img.shields.io/crates/dv/include-flate.svg)](https://docs.rs/include-flate)

[![docs.rs](https://docs.rs/include-flate/badge.svg)](https://docs.rs/include-flate)

A variant of `include_bytes!`/`include_str!` with compile-time deflation and runtime lazy inflation.

## Why?

`include_bytes!`/`include_str!` are great for embedding resources into an executable/library

without involving the complex logistics of maintaining an assets manager.

However, they are copied as-is into the artifact, leading to unnecessarily large binary size.

This library automatically compresses the resources and lazily decompresses them at runtime,

allowing smaller binary sizes.

Nevertheless, this inevitably leads to wasting RAM to store both the compressed and decompressed data,

which might be undesirable if the data are too large.

An actual installer is still required if the binary involves too many resources that do not need to be kept in RAM all time.

## Warning

This library compresses included data independently.

It is usually more effective to compress the whole output binary together (e.g. distributing `.exe.gz` )

than to compress independently.

In addition, compression algorithms usually produce smaller artifacts by processing the raw input together

than by processing already-compressed output.

`#[cfg_attr]` might come handy for conditionally using compression or direct data inclusion.