semdiff-differ-image 0.4.2

Image diff calculator and reporters for semdiff.
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

use crate::{ImageDiff, ImageDiffReporter, image_format};
use image::ImageError;
use semdiff_core::fs::FileLeaf;
use semdiff_core::{DetailReporter, MayUnsupported};
use semdiff_output::json::JsonReport;
use serde::Serialize;
use thiserror::Error;

const COMPARES_NAME: &str = "image";

#[derive(Debug, Error)]
pub enum ImageJsonReportError {
    #[error("image decode error: {0}")]
    ImageDecode(#[from] ImageError),
}

impl<W> DetailReporter<ImageDiff, FileLeaf, JsonReport<W>> for ImageDiffReporter {
    type Error = ImageJsonReportError;

    fn report_unchanged(
        &self,
        name: &str,
        _diff: &ImageDiff,
        reporter: &JsonReport<W>,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        reporter.record_unchanged(name, COMPARES_NAME, ());
        Ok(MayUnsupported::Ok(()))
    }

    fn report_modified(
        &self,
        name: &str,
        diff: &ImageDiff,
        reporter: &JsonReport<W>,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        let report = ModifiedReport {
            expected_width: diff.expected().width,
            expected_height: diff.expected().height,
            actual_width: diff.actual().width,
            actual_height: diff.actual().height,
            diff_pixels: diff.diff_stat().diff_pixels,
        };
        reporter.record_modified(name, COMPARES_NAME, report);
        Ok(MayUnsupported::Ok(()))
    }

    fn report_added(
        &self,
        name: &str,
        data: &FileLeaf,
        reporter: &JsonReport<W>,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        let Some(format) = image_format(&data.kind) else {
            return Ok(MayUnsupported::Unsupported);
        };
        let image = image::load_from_memory_with_format(&data.content, format)?;
        let report = SingleReport {
            width: image.width(),
            height: image.height(),
        };
        reporter.record_added(name, COMPARES_NAME, report);
        Ok(MayUnsupported::Ok(()))
    }

    fn report_deleted(
        &self,
        name: &str,
        data: &FileLeaf,
        reporter: &JsonReport<W>,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        let Some(format) = image_format(&data.kind) else {
            return Ok(MayUnsupported::Unsupported);
        };
        let image = image::load_from_memory_with_format(&data.content, format)?;
        let report = SingleReport {
            width: image.width(),
            height: image.height(),
        };
        reporter.record_deleted(name, COMPARES_NAME, report);
        Ok(MayUnsupported::Ok(()))
    }
}

#[derive(Serialize)]
struct ModifiedReport {
    expected_width: u32,
    expected_height: u32,
    actual_width: u32,
    actual_height: u32,
    diff_pixels: u64,
}

#[derive(Serialize)]
struct SingleReport {
    width: u32,
    height: u32,
}