1# jpeg-decoder
2
3[![Rust CI](https://github.com/image-rs/jpeg-decoder/workflows/Rust%20CI/badge.svg)](https://github.com/image-rs/jpeg-decoder/actions)
4[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/k65rrkd0f8yb4o9w/branch/master?svg=true)](https://ci.appveyor.com/project/kaksmet/jpeg-decoder/branch/master)
5[![Crates.io](https://img.shields.io/crates/v/jpeg-decoder.svg)](https://crates.io/crates/jpeg-decoder)
6
7A Rust library for decoding JPEGs.
8
9[Documentation](https://docs.rs/jpeg-decoder)
10
11## Example
12
13Cargo.toml:
14```toml
15[dependencies]
16jpeg-decoder = "0.1"
17```
18
19main.rs:
20```rust
21extern crate jpeg_decoder as jpeg;
22
23use std::fs::File;
24use std::io::BufReader;
25
26fn main() {
27    let file = File::open("hello_world.jpg").expect("failed to open file");
28    let mut decoder = jpeg::Decoder::new(BufReader::new(file));
29    let pixels = decoder.decode().expect("failed to decode image");
30    let metadata = decoder.info().unwrap();
31}
32```
33
34## Requirements
35This crate compiles only with rust >= 1.34.
36