How to use rust-brotli in a no-std Rust project?

Set up custom allocators using the provided macros like declare_stack_allocator_struct and define_allocator_memory_pool, then manage BrotliState manually, as shown in the README's no-stdlib example. This avoids syscalls but requires understanding of memory pools and decompression loops.

rust-brotli vs zstd in Rust for compression?

rust-brotli is best for Brotli-specific compatibility and no-std environments, offering bitwise-identical output to the C version. zstd libraries in Rust might provide better speed or simplicity for general compression, but rust-brotli excels in scenarios requiring Brotli standard adherence or embedded use.

How to compress a file with rust-brotli from command line?

Use the built-in C interface by running 'cd c && make' to build the CLI tool, then use commands like 'brotli -c input.txt > output.br'. Alternatively, integrate the Rust API with io::Read or io::Write abstractions for programmatic compression.

Is rust-brotli faster than the original C brotli?

Performance is designed to match the C implementation closely, with multithreaded compression for speed improvements. However, benchmarks may vary based on setup; the focus is on safety and compatibility rather than outright speed gains.

How to concatenate streams with rust-brotli?

Use appendable and catable stream parameters: for simple concatenation, apply -bare -appendable to the first file and -bare -catable to others, then append a final 0x03 byte. For size optimization, use the catbrotli tool with -appendable and -catable flags, as detailed in the stream concatenation section.

Can I replace libbrotli.so with rust-brotli in C projects?

Yes, build the FFI library from the c directory to produce libbrotli.so, which is a drop-in replacement. However, ensure no ODR conflicts by managing the ffi-api flag, and note that custom allocators and parameters might require adjustment.

rust-brotli — Pure Rust Brotli Compression

What is rust-brotli?

rust-brotli is a Rust library that implements the Brotli compression and decompression algorithm. It provides a safe, efficient way to compress and decompress data in Rust applications, with optional support for environments without the standard library. The library is designed to be bitwise-identical to the original C implementation, ensuring compatibility with existing Brotli tools and formats.

Target Audience

Rust developers working on performance-sensitive applications, embedded systems, kernels, or projects requiring Brotli compression without C dependencies. It's also suitable for C/C++ developers looking for a drop-in replacement via its FFI interface.

Value Proposition

Developers choose rust-brotli for its no-stdlib capability, making it ideal for constrained environments, and its full compatibility with the Brotli standard. The Rust implementation offers memory safety and modern tooling while matching the performance and output of the canonical C version.

Brotli compressor and decompressor written in rust that optionally avoids the stdlib

Use Cases

Best For

Compressing data in embedded Rust projects without stdlib access
Replacing the C Brotli library in existing projects via FFI
Building streaming compression pipelines with concatenatable streams
Implementing Brotli compression in Rust kernels or OS development
Benchmarking compression algorithms in Rust vs C implementations
Applications requiring fine-grained memory management with custom allocators

Not Ideal For

Projects using languages without Rust or C bindings, where native compression libraries might be simpler
Teams prioritizing quick setup over advanced features, as manual memory management and FFI configuration add complexity
Applications requiring real-time compression with minimal overhead, since multithreaded modes may introduce latency
Environments where Brotli isn't a requirement, and lighter algorithms like LZ4 or Snappy would suffice

Pros & Cons

Pros

No-Stdlib Support

Operates without the Rust standard library, enabling use in embedded systems and kernels, as demonstrated by the manual memory management example with custom allocators.

FFI Compatibility

Provides a drop-in C API replacement for Google's Brotli library, allowing seamless integration into existing C/C++ projects, with build instructions in the c subdirectory.

Stream Concatenation Features

Supports appendable and catable streams for efficient data concatenation in streaming scenarios, with detailed parameter interactions and tooling like catbrotli.

Custom Allocator Control

Allows fine-grained memory management with custom allocators, essential for performance-critical or resource-constrained environments, as shown in the no-stdlib setup.

Cons

Complex Manual Setup

Manual memory management requires verbose boilerplate code for allocators and state handling, making it less accessible for simple use cases compared to higher-level APIs.

Breaking Changes Risk

Frequent major version updates (e.g., 8.0.0, 7.0.0) with fixes like memory leaks indicate potential instability and migration effort for long-term projects.

FFI Integration Overhead

FFI is not enabled by default to avoid ODR issues, and past memory leaks (fixed in 8.0.2) require careful configuration, adding integration complexity.

Frequently Asked Questions

What is rust-brotli?

Target Audience

Value Proposition

Use Cases

Best For

Compressing data in embedded Rust projects without stdlib access
Replacing the C Brotli library in existing projects via FFI
Building streaming compression pipelines with concatenatable streams
Implementing Brotli compression in Rust kernels or OS development
Benchmarking compression algorithms in Rust vs C implementations
Applications requiring fine-grained memory management with custom allocators

Not Ideal For

Projects using languages without Rust or C bindings, where native compression libraries might be simpler
Teams prioritizing quick setup over advanced features, as manual memory management and FFI configuration add complexity
Applications requiring real-time compression with minimal overhead, since multithreaded modes may introduce latency
Environments where Brotli isn't a requirement, and lighter algorithms like LZ4 or Snappy would suffice

Pros & Cons

Pros

No-Stdlib Support

Operates without the Rust standard library, enabling use in embedded systems and kernels, as demonstrated by the manual memory management example with custom allocators.

FFI Compatibility

Provides a drop-in C API replacement for Google's Brotli library, allowing seamless integration into existing C/C++ projects, with build instructions in the c subdirectory.

Stream Concatenation Features

Supports appendable and catable streams for efficient data concatenation in streaming scenarios, with detailed parameter interactions and tooling like catbrotli.

Custom Allocator Control

Allows fine-grained memory management with custom allocators, essential for performance-critical or resource-constrained environments, as shown in the no-stdlib setup.

Cons

Complex Manual Setup

Manual memory management requires verbose boilerplate code for allocators and state handling, making it less accessible for simple use cases compared to higher-level APIs.

Breaking Changes Risk

Frequent major version updates (e.g., 8.0.0, 7.0.0) with fixes like memory leaks indicate potential instability and migration effort for long-term projects.

FFI Integration Overhead

FFI is not enabled by default to avoid ODR issues, and past memory leaks (fixed in 8.0.2) require careful configuration, adding integration complexity.

Frequently Asked Questions

rust-brotli

What is rust-brotli?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

rust-brotli

What is rust-brotli?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?