exif/
lib.rs

1//
2// Copyright (c) 2016 KAMADA Ken'ichi.
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions
7// are met:
8// 1. Redistributions of source code must retain the above copyright
9//    notice, this list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright
11//    notice, this list of conditions and the following disclaimer in the
12//    documentation and/or other materials provided with the distribution.
13//
14// THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17// ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20// OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24// SUCH DAMAGE.
25//
26
27//! This is a pure-Rust library to parse Exif data.
28//!
29//! This library parses Exif attributes in a raw Exif data block.
30//! It can also read Exif data directly from some image formats
31//! including TIFF, JPEG, HEIF, PNG, and WebP.
32//!
33//! # Examples
34//!
35//! To parse Exif attributes in an image file,
36//! use `Reader::read_from_container`.
37//! To convert a field value to a string, use `Field::display_value`.
38//!
39//! ```
40//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
41//! for path in &["tests/exif.jpg", "tests/exif.tif"] {
42//!     let file = std::fs::File::open(path)?;
43//!     let mut bufreader = std::io::BufReader::new(&file);
44//!     let exifreader = exif::Reader::new();
45//!     let exif = exifreader.read_from_container(&mut bufreader)?;
46//!     for f in exif.fields() {
47//!         println!("{} {} {}",
48//!                  f.tag, f.ifd_num, f.display_value().with_unit(&exif));
49//!     }
50//! }
51//! # Ok(()) }
52//! ```
53//!
54//! To process a field value programmatically in your application,
55//! use the value itself (associated value of enum `Value`)
56//! rather than a stringified one.
57//!
58//! ```
59//! # use exif::{In, Reader, Tag, Value};
60//! # let file = std::fs::File::open("tests/exif.tif").unwrap();
61//! # let exif = Reader::new().read_from_container(
62//! #     &mut std::io::BufReader::new(&file)).unwrap();
63//! # macro_rules! eprintln { ($($tt:tt)*) => (panic!($($tt)*)) }
64//! // Orientation is stored as a SHORT.  You could match `orientation.value`
65//! // against `Value::Short`, but the standard recommends that readers
66//! // should accept BYTE, SHORT, or LONG values for any unsigned integer
67//! // field.  `Value::get_uint` is provided for that purpose.
68//! match exif.get_field(Tag::Orientation, In::PRIMARY) {
69//!     Some(orientation) =>
70//!         match orientation.value.get_uint(0) {
71//!             Some(v @ 1..=8) => println!("Orientation {}", v),
72//!             _ => eprintln!("Orientation value is broken"),
73//!         },
74//!     None => eprintln!("Orientation tag is missing"),
75//! }
76//! // XResolution is stored as a RATIONAL.
77//! match exif.get_field(Tag::XResolution, In::PRIMARY) {
78//!     Some(xres) =>
79//!         match xres.value {
80//!             Value::Rational(ref v) if !v.is_empty() =>
81//!                 println!("XResolution {}", v[0]),
82//!             _ => eprintln!("XResolution value is broken"),
83//!         },
84//!     None => eprintln!("XResolution tag is missing"),
85//! }
86//! ```
87//!
88//! # Upgrade Guide
89//!
90//! See the [upgrade guide](doc::upgrade) for API incompatibilities.
91
92pub use error::{Error, PartialResult};
93pub use jpeg::get_exif_attr as get_exif_attr_from_jpeg;
94pub use reader::{Exif, Reader};
95pub use tag::{Context, Tag};
96pub use tiff::{DateTime, Field, In};
97pub use tiff::parse_exif;
98pub use value::Value;
99pub use value::{Rational, SRational};
100
101/// The interfaces in this module are experimental and unstable.
102pub mod experimental {
103    pub use crate::writer::Writer;
104}
105
106#[cfg(test)]
107#[macro_use]
108mod tmacro;
109
110pub mod doc;
111mod endian;
112mod error;
113mod isobmff;
114mod jpeg;
115mod png;
116mod reader;
117mod tag;
118mod tiff;
119mod util;
120mod value;
121mod webp;
122mod writer;
exif/lib.rs

exif/
lib.rs
