ps-hash-core 0.1.0-25

Core hashing primitives for ps-hash.
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
93
94
95
96
97
98
99
100
101

use std::fmt::{Debug, Display};

use super::super::Hash;

impl Display for Hash {
    /// Writes the canonical Crockford Base32 representation.
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        ps_crockford32::encode_into(&self.inner, f)
    }
}

impl Debug for Hash {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Display::fmt(self, f)
    }
}

#[cfg(test)]
#[allow(clippy::expect_used)]
mod tests {
    use crate::{Hash, HASH_SIZE_CROCKFORD};

    #[test]
    fn display_correct_length() {
        let h = Hash::hash(b"test").expect("hashing should succeed");
        let s = format!("{h}");
        assert_eq!(s.len(), HASH_SIZE_CROCKFORD);
    }

    #[test]
    fn display_matches_to_crockford() {
        let h = Hash::hash(b"matches").expect("hashing should succeed");

        assert_eq!(format!("{h}"), h.to_crockford());
    }

    #[test]
    fn display_matches_to_string() {
        let h = Hash::hash(b"matches").expect("hashing should succeed");
        let displayed = format!("{h}");
        let to_string = h.to_string();
        assert_eq!(displayed, to_string);
    }

    #[test]
    fn display_is_deterministic() {
        let h = Hash::hash(b"deterministic").expect("hashing should succeed");
        let s1 = format!("{h}");
        let s2 = format!("{h}");
        assert_eq!(s1, s2);
    }

    #[test]
    fn display_different_for_different_data() {
        let h1 = Hash::hash(b"data1").expect("hashing should succeed");
        let h2 = Hash::hash(b"data2").expect("hashing should succeed");
        let s1 = format!("{h1}");
        let s2 = format!("{h2}");
        assert_ne!(s1, s2);
    }

    #[test]
    fn debug_correct_length() {
        let h = Hash::hash(b"debug").expect("hashing should succeed");
        let s = format!("{h:?}");
        assert_eq!(s.len(), HASH_SIZE_CROCKFORD);
    }

    #[test]
    fn debug_matches_display() {
        let h = Hash::hash(b"debug display").expect("hashing should succeed");
        let debug = format!("{h:?}");
        let display = format!("{h}");
        assert_eq!(debug, display);
    }

    #[test]
    fn debug_matches_to_string() {
        let h = Hash::hash(b"debug to_string").expect("hashing should succeed");
        let debug = format!("{h:?}");
        let to_string = h.to_string();
        assert_eq!(debug, to_string);
    }

    #[test]
    fn debug_is_deterministic() {
        let h = Hash::hash(b"debug deterministic").expect("hashing should succeed");
        let s1 = format!("{h:?}");
        let s2 = format!("{h:?}");
        assert_eq!(s1, s2);
    }

    #[test]
    fn display_round_trips() {
        let original = Hash::hash(b"round trip").expect("hashing should succeed");
        let displayed = format!("{original}");
        let recovered =
            Hash::validate(&displayed).expect("round trip through validate should succeed");
        assert_eq!(original, recovered);
    }
}