Struct Compare

pub struct Compare<'a> { /* private fields */ }

Compare images

Example

let image_1 = "images/baseline.jpeg".to_string();

let image_2 = "images/modfied.jpeg".to_string();

let images_match = imeq::Compare::new(image_1, image_2)
    .enable_check_images_have_same_path()
    .enable_check_image_hashes_match()
    .enable_check_images_dimensions_match()
    .enable_check_images_pixels_match()
    .are_match();

if images_match {
    println!("Images are a match");
} else {
    println!("Images are not a match");
}

Implementations

impl Compare<'_>

Compare images

pub fn new(image_1: String, image_2: String) -> Self

Create a new Image comparson

pub fn enable_check(&mut self, check: &'static str) -> &mut Self

Enable or disable a check

pub fn enable_check_images_have_same_path(&mut self) -> &mut Self

Enable check for images having the same path

pub fn enable_check_image_hashes_match(&mut self) -> &mut Self

Enable check for image hashes matching

pub fn enable_check_images_dimensions_match(&mut self) -> &mut Self

Enable check for image dimensions matching

pub fn enable_check_images_pixels_match(&mut self) -> &mut Self

Enable check for image pixels matching

pub fn are_match(&self) -> bool

Compare images and return if they are a match

pub fn arent_match(&self) -> bool

Compare images and return if they are not a match