ffuzzy 0.3.16

Library to generate / parse / compare ssdeep Context Triggered Piecewise Hashes (CTPH)
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

// SPDX-License-Identifier: MIT
// SPDX-FileCopyrightText: Copyright (C) 2023–2025 Tsukasa OI <floss_ssdeep@irq.a4lg.com>.

//! Easy generator functions.

#![cfg(feature = "easy-functions")]

use crate::internals::generate::{Generator, GeneratorError};
use crate::internals::hash::RawFuzzyHash;

/// Generates a fuzzy hash from a given buffer.
///
/// # Example
///
/// ```
/// // Requires either the "alloc" feature or std environment
/// // on your crate to use `to_string()` method (default enabled).
/// assert_eq!(
///     ssdeep::hash_buf(b"Hello, World!\n").unwrap().to_string(),
///     "3:aaX8v:aV"
/// );
/// ```
pub fn hash_buf(buffer: &[u8]) -> Result<RawFuzzyHash, GeneratorError> {
    let mut generator = Generator::new();
    generator.set_fixed_input_size_in_usize(buffer.len())?;
    generator.update(buffer);
    Ok(generator.finalize().unwrap()) // grcov-excl-br-line:UNREACHABLE ERROR
}

mod tests;