zune-bmp

Crates.iozune-bmp
lib.rszune-bmp
version0.5.0-rc4
sourcesrc
created_at2023-11-16 20:32:53.317102
updated_at2024-05-12 09:33:45.64645
descriptionA fast BMP decoder
homepage
repositoryhttps://github.com/etemesi254/zune-image/tree/dev/crates/zune-bmp
max_upload_size
id1037908
size76,719
Caleb Etemesi (etemesi254)

documentation

README

zune-bmp

A lean, mean and green BMP decoder.

This crate contains a fast implemtnation of a BMP decoder with battery included support for the esoteric parts of the spec

Features

  • RLE support
  • 1-bit,4-bit,8-bit,16-bit,24-bit and 32-bit support
  • Performant

Usage

First add the project to your library/binary

zune-bmp = "0.4" # Or use cargo add zune-bmp

Then you can toy with the other configs

use zune_bmp::BmpDecoder;
use zune_bmp::BmpDecoderErrors;

fn main()->Result<(),BmpDecodeErrors>{
    let decoder:Vec<u8> = BmpDecoder::new(b"BMP").decode()?;

}

Security

The decoder is continuously fuzz tested in CI to ensure it does not crash on malicious input in case a sample causes it to crash, an issue would be welcome.

Commit count: 1834

cargo fmt