nom-exif 3.3.0

Exif/metadata parsing library written in pure Rust, both image (jpeg/heif/heic/jpg/tiff etc.) and video/audio (mov/mp4/3gp/webm/mkv/mka, etc.) files are supported.
Documentation 
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Structured image-metadata view returned by
//! `MediaParser::parse_image_metadata` (lands in phase 4).
//!
//! See [`ImageMetadata`].
//!
//! # Example: lazy and eager forms compose
//!
//! ```rust
//! use nom_exif::{ImageMetadata, ImageFormatMetadata, ExifIter, Exif};
//!
//! // Default form (eager — type parameter defaults to Exif).
//! let _eager_default: ImageMetadata = ImageMetadata::default();
//!
//! // Explicit lazy form.
//! let lazy: ImageMetadata<ExifIter> = ImageMetadata {
//!     exif: None,
//!     format: None,
//! };
//!
//! // Lazy → eager conversion via From.
//! let _eager: ImageMetadata<Exif> = lazy.into();
//! ```

use crate::exif::png_text::PngTextChunks;

mod sealed {
    pub trait Sealed {}
}

/// Marker trait for the two valid "EXIF representations" held by
/// [`ImageMetadata`]: [`Exif`](crate::Exif) (eager) and [`ExifIter`](crate::ExifIter)
/// (lazy). Sealed — users cannot add their own implementations.
pub trait ExifRepr: sealed::Sealed {}

impl sealed::Sealed for crate::Exif {}
impl ExifRepr for crate::Exif {}

impl sealed::Sealed for crate::ExifIter {}
impl ExifRepr for crate::ExifIter {}

/// Structured image-metadata view: EXIF (if any) plus format-specific
/// metadata (if any).
///
/// Default `E = Exif` — eager EXIF representation. The
/// `MediaParser::parse_image_metadata` method returns
/// `ImageMetadata<ExifIter>` (lazy); convert to the default eager form
/// via `.into()` when desired.
///
/// **Forward-compat note**: this struct is shaped to be reused
/// unchanged by a future v4 redesign of the [`Metadata`](crate::Metadata)
/// enum (`Metadata::Image(ImageMetadata)`).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ImageMetadata<E: ExifRepr = crate::Exif> {
    /// EXIF tags found in the source image, if any. For PNG, this
    /// includes legacy `Raw profile type {exif,APP1}` hex-encoded
    /// EXIF transparently merged.
    pub exif: Option<E>,

    /// Format-specific metadata that does not fit the EXIF/IFD
    /// abstraction (e.g. PNG `tEXt` chunks).
    pub format: Option<ImageFormatMetadata>,
}

impl<E: ExifRepr> Default for ImageMetadata<E> {
    fn default() -> Self {
        ImageMetadata {
            exif: None,
            format: None,
        }
    }
}

impl From<ImageMetadata<crate::ExifIter>> for ImageMetadata<crate::Exif> {
    fn from(m: ImageMetadata<crate::ExifIter>) -> Self {
        ImageMetadata {
            exif: m.exif.map(Into::into),
            format: m.format,
        }
    }
}

/// Format-specific image metadata. One variant per format that has
/// metadata not expressible as EXIF tags.
///
/// Marked `#[non_exhaustive]` so future formats can be added
/// (`Gif(...)`, `Webp(...)` etc.) without breaking exhaustive `match`
/// statements in user code.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum ImageFormatMetadata {
    /// PNG `tEXt` chunks. Latin-1 key/value pairs in file order.
    Png(PngTextChunks),
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn default_is_empty() {
        let m: ImageMetadata = ImageMetadata::default();
        assert!(m.exif.is_none());
        assert!(m.format.is_none());
    }

    #[test]
    fn generic_explicit_lazy_form() {
        // ImageMetadata<ExifIter> compiles and is constructible.
        let m: ImageMetadata<crate::ExifIter> = ImageMetadata {
            exif: None,
            format: None,
        };
        assert!(m.exif.is_none());
    }

    #[test]
    fn from_lazy_to_eager_compiles() {
        // We can't easily construct an ExifIter here; just verify the
        // type-level conversion exists by going through Default.
        let lazy: ImageMetadata<crate::ExifIter> = ImageMetadata::default();
        let _eager: ImageMetadata<crate::Exif> = lazy.into();
    }

    #[test]
    fn format_metadata_png_variant() {
        let png_text = PngTextChunks::default();
        let fm = ImageFormatMetadata::Png(png_text);
        match fm {
            ImageFormatMetadata::Png(t) => assert!(t.is_empty()),
        }
    }
}