ffuzzy 0.3.15

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
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

// SPDX-License-Identifier: CC0-1.0
// SPDX-FileCopyrightText: Authored by Tsukasa OI <floss_ssdeep@irq.a4lg.com> in 2023–2025

//! Internal macros (mainly to share safe/unsafe code).

/// "Optionally" unsafe block.
///
/// When this crate is built with the `unsafe` feature, this macro is
/// expanded to an `unsafe` block.
///
/// Inside this block, you may place statements that may change the behavior
/// depending on the feature `unsafe`.
#[doc(alias = "optionally_unsafe")]
macro_rules! optionally_unsafe_impl {
    {$($tokens: tt)*} => {
        cfg_if::cfg_if! {
            if #[cfg(feature = "unsafe")] {
                unsafe { $($tokens)* }
            } else {
                { $($tokens)* }
            }
        }
    };
}
pub(crate) use optionally_unsafe_impl as optionally_unsafe;

/// Declare an invariant for optimization.
///
/// When the feature `unsafe` is disabled, it only places [`debug_assert!()`].
/// If `unsafe` is enabled and Rust is new enough to have
/// [`core::hint::assert_unchecked()`], this hint is used.
/// If `unsafe` is enabled but Rust is older than the version 1.81,
/// [`core::hint::unreachable_unchecked()`] is used.
///
/// Optimization behaviors are disabled on tests.
///
/// # Example
///
/// ```ignore
/// # // Because this is an internal macro, we must ignore on the doctest
/// # // because each Rust doctest's scope is external to this crate.
/// // INTERNAL USE (INSIDE THIS CRATE) ONLY
/// // let index: usize = ... (but proven to be inside the array).
/// # let index = 3usize;
/// let array = [0, 1, 2, 3];
/// invariant!(index < array.len());
/// // Bound checking may be optimized out.
/// let result = array[index];
/// ```
#[doc(alias = "invariant")]
macro_rules! invariant_impl {
    ($expr: expr) => {
        cfg_if::cfg_if! {
            if #[cfg(all(feature = "unsafe", ffuzzy_assume = "stable", not(test)))] {
                #[allow(clippy::incompatible_msrv)]
                unsafe {
                    core::hint::assert_unchecked($expr);
                }
            } else if #[cfg(all(feature = "unsafe", not(test)))] {
                if !($expr) {
                    unsafe {
                        core::hint::unreachable_unchecked();
                    }
                }
            } else {
                debug_assert!($expr);
            }
        }
    };
}
pub(crate) use invariant_impl as invariant;

/// Implements [`Error`](std::error::Error) trait either in `std` or `core`.
///
/// This macro is used to implement appropriate [`Error`](std::error::Error)
/// trait, either in `core` or `std`, depending on the configuration.
macro_rules! impl_error_impl {
    ($type: ty { $($tokens: tt)* }) => {
        #[cfg(feature = "std")]
        #[cfg_attr(feature = "unstable", doc(cfg(all())))]
        impl std::error::Error for $type {
            $($tokens)*
        }
        #[cfg(all(not(feature = "std"), ffuzzy_error_in_core = "stable"))]
        impl core::error::Error for $type {
            $($tokens)*
        }
    }
}
pub(crate) use impl_error_impl as impl_error;

mod tests;