Skip to main content

MultiHashFingerprint

Struct MultiHashFingerprint 

Source
pub struct MultiHashFingerprint { /* private fields */ }
Expand description

A multi-algorithm fingerprint containing hashes from multiple perceptual algorithms.

Provides enhanced similarity detection by combining results from multiple hash algorithms with weighted combination for improved accuracy.

§Binary layout

#[repr(C)] with no padding bytes (536 bytes total: 32 + 3 × 168). Implements bytemuck::Pod / bytemuck::Zeroable for zero-copy cast to &[u8]. See ImageFingerprint for an example.

Stable layout is enforced at compile time via a const _ size assertion; any accidental layout drift fails the build.

Copy is derived for bytemuck::Pod compatibility; move-by-value silently memcpys 536 bytes. Prefer borrowing (&MultiHashFingerprint) in hot loops.

Implementations§

Source§

impl MultiHashFingerprint

Source

pub fn exact_hash(&self) -> &[u8; 32]

Returns the BLAKE3 hash of the original image bytes.

Source

pub const fn format_version() -> u32

Returns the on-disk format version this fingerprint was computed under.

Equal to crate::FORMAT_VERSION. Persist alongside fingerprint bytes (or in a sidecar manifest) and refuse comparison across mismatched versions to guard against algorithm-version drift.

Source

pub fn ahash(&self) -> &ImageFingerprint

Returns the AHash-based fingerprint.

Source

pub fn phash(&self) -> &ImageFingerprint

Returns the PHash-based fingerprint.

Source

pub fn dhash(&self) -> &ImageFingerprint

Returns the DHash-based fingerprint.

Source

pub fn get(&self, algorithm: HashAlgorithm) -> &ImageFingerprint

Returns the fingerprint for a specific algorithm.

Source

pub fn compare(&self, other: &MultiHashFingerprint) -> Similarity

Compares two multi-hash fingerprints using the default weighted combination.

Equivalent to compare_with_config called with MultiHashConfig::default():

  • 10% AHash / 60% PHash / 30% DHash per-algorithm blend
  • Within each algorithm, 40% global hash + 60% block-level hashes
  • Block distance threshold of 32 (Hamming, out of 64)

Use compare_with_config to tune any of these.

Source

pub fn compare_with_threshold( &self, other: &MultiHashFingerprint, block_threshold: u32, ) -> Similarity

Compares two multi-hash fingerprints with a custom block distance threshold.

§Arguments
  • other - The fingerprint to compare against
  • block_threshold - Maximum Hamming distance for a block to count as a match (0-64). Lower = stricter (fewer blocks qualify), higher = looser. Default is 32.
Source

pub fn compare_with_config( &self, other: &MultiHashFingerprint, config: &MultiHashConfig, ) -> Similarity

Compares two multi-hash fingerprints using a fully configurable weight and threshold set.

All knobs from MultiHashConfig are honored; defaults reproduce compare. See MultiHashConfig for examples.

Source

pub fn is_similar(&self, other: &MultiHashFingerprint, threshold: f32) -> bool

Checks if this fingerprint is similar to another within a threshold.

Uses the weighted combination score from compare().

§Panics

Panics in debug mode if threshold is not in [0.0, 1.0]. In release mode, out-of-range or NaN thresholds return false.

Trait Implementations§

Source§

impl Clone for MultiHashFingerprint

Source§

fn clone(&self) -> MultiHashFingerprint

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MultiHashFingerprint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MultiHashFingerprint

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for MultiHashFingerprint

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for MultiHashFingerprint

Source§

fn eq(&self, other: &MultiHashFingerprint) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MultiHashFingerprint

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Zeroable for MultiHashFingerprint

Source§

fn zeroed() -> Self

Source§

impl Copy for MultiHashFingerprint

Source§

impl Eq for MultiHashFingerprint

Source§

impl Pod for MultiHashFingerprint

Source§

impl StructuralPartialEq for MultiHashFingerprint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

Source§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
Source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AnyBitPattern for T
where T: Pod,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> NoUninit for T
where T: Pod,