     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45

    //! This crate contains a JPEG decoder.
    //!
    //! # Examples
    //!
    //! ```
    //! use jpeg_decoder::Decoder;
    //! use std::fs::File;
    //! use std::io::BufReader;
    //!
    //! let file = File::open("tests/reftest/images/extraneous-data.jpg").expect("failed to open file");
    //! let mut decoder = Decoder::new(BufReader::new(file));
    //! let pixels = decoder.decode().expect("failed to decode image");
    //! let metadata = decoder.info().unwrap();
    //! ```
    //!
    //! Get metadata from a file without decoding it:
    //!
    //! ```
    //! use jpeg_decoder::Decoder;
    //! use std::fs::File;
    //! use std::io::BufReader;
    //!
    //! let file = File::open("tests/reftest/images/extraneous-data.jpg").expect("failed to open file");
    //! let mut decoder = Decoder::new(BufReader::new(file));
    //! decoder.read_info().expect("failed to read metadata");
    //! let metadata = decoder.info().unwrap();
    //! ```

    #![deny(missing_docs)]

    extern crate byteorder;
    #[cfg(feature="rayon")]
    extern crate rayon;

    pub use decoder::{Decoder, ImageInfo, PixelFormat};
    pub use error::{Error, UnsupportedFeature};

    mod decoder;
    mod error;
    mod huffman;
    mod idct;
    mod marker;
    mod parser;
    mod upsampler;
    mod worker;

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)