Struct image_hasher::ImageHash

pub struct ImageHash<B = Box<[u8]>> { /* private fields */ }

A struct representing an image processed by a perceptual hash. For efficiency, does not retain a copy of the image data after hashing.

Get an instance with ImageHash::hash().

Implementations

impl<B: HashBytes> ImageHash<B>

pub fn as_bytes(&self) -> &[u8]

Get the bytes of this hash.

pub fn from_bytes(bytes: &[u8]) -> Result<ImageHash<B>, InvalidBytesError>

Create an ImageHash instance from the given bytes.

Errors:

Returns a InvalidBytesError::BytesWrongLength error if the slice passed can’t fit in B.

pub fn dist(&self, other: &Self) -> u32

Calculate the Hamming distance between this and other.

Equivalent to counting the 1-bits of the XOR of the two hashes.

Essential to determining the perceived difference between self and other.

Note

This return value is meaningless if these two hashes are from different hash sizes or algorithms.

pub fn from_base64( encoded_hash: &str ) -> Result<ImageHash<B>, InvalidBytesError>

Create an ImageHash instance from the given Base64-encoded string.

Errors:

Returns InvalidBytesError::Base64(DecodeError::InvalidLength) if the string wasn’t valid base64. Otherwise returns the same errors as from_bytes.

pub fn to_base64(&self) -> String

Get a Base64 string representing the bits of this hash.

Mostly for printing convenience.

Trait Implementations

impl<B: Clone> Clone for ImageHash<B>

fn clone(&self) -> ImageHash<B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: Debug> Debug for ImageHash<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: Hash> Hash for ImageHash<B>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<B: PartialEq> PartialEq<ImageHash<B>> for ImageHash<B>

fn eq(&self, other: &ImageHash<B>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: Eq> Eq for ImageHash<B>

impl<B> StructuralEq for ImageHash<B>

impl<B> StructuralPartialEq for ImageHash<B>