libipld-base 0.1.0

Base traits and definitions used by ipld codecs.
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
102
103
104
105
106
107
108
109
110
111
112
113

//! Hash types.
use crate::cid::Cid;
use crate::error::BlockError;
use core::hash::{BuildHasher, Hasher};
use multihash::Multihash;
use std::collections::{HashMap, HashSet};

/// Trait for hash type markers.
pub trait Hash {
    /// The multihash code.
    const CODE: multihash::Code;

    /// Computes the multihash of a byte slice.
    fn digest(bytes: &[u8]) -> Multihash;
}

macro_rules! hash {
    ($name:ident) => {
        /// $name
        #[derive(Clone, Debug, Hash, PartialEq, Eq)]
        pub struct $name;

        #[allow(clippy::derive_hash_xor_eq)]
        impl Hash for $name {
            const CODE: multihash::Code = multihash::Code::$name;

            fn digest(bytes: &[u8]) -> Multihash {
                multihash::$name::digest(bytes)
            }
        }
    };
}

hash!(Identity);
hash!(Sha1);
hash!(Sha2_256);
hash!(Sha2_512);
hash!(Sha3_224);
hash!(Sha3_256);
hash!(Sha3_384);
hash!(Sha3_512);
hash!(Keccak224);
hash!(Keccak256);
hash!(Keccak384);
hash!(Keccak512);
hash!(Blake2b256);
hash!(Blake2b512);
hash!(Blake2s128);
hash!(Blake2s256);
//hash!(Murmur3_32);
//hash!(Murmur3_128X64);

/// Compute digest of bytes.
pub fn digest(code: multihash::Code, bytes: &[u8]) -> Result<Multihash, BlockError> {
    Ok(match code {
        multihash::Code::Identity => multihash::Identity::digest(bytes),
        multihash::Code::Sha1 => multihash::Sha1::digest(bytes),
        multihash::Code::Sha2_256 => multihash::Sha2_256::digest(bytes),
        multihash::Code::Sha2_512 => multihash::Sha2_512::digest(bytes),
        multihash::Code::Sha3_224 => multihash::Sha3_224::digest(bytes),
        multihash::Code::Sha3_256 => multihash::Sha3_256::digest(bytes),
        multihash::Code::Sha3_384 => multihash::Sha3_384::digest(bytes),
        multihash::Code::Sha3_512 => multihash::Sha3_512::digest(bytes),
        multihash::Code::Keccak224 => multihash::Keccak224::digest(bytes),
        multihash::Code::Keccak256 => multihash::Keccak256::digest(bytes),
        multihash::Code::Keccak384 => multihash::Keccak384::digest(bytes),
        multihash::Code::Keccak512 => multihash::Keccak512::digest(bytes),
        multihash::Code::Blake2b256 => multihash::Blake2b256::digest(bytes),
        multihash::Code::Blake2b512 => multihash::Blake2b512::digest(bytes),
        multihash::Code::Blake2s128 => multihash::Blake2s128::digest(bytes),
        multihash::Code::Blake2s256 => multihash::Blake2s256::digest(bytes),
        //multihash::Code::Murmur3_32 => multihash::Murmur3_32::digest(bytes),
        //multihash::Code::Murmur3_128X64 => multihash::Murmur3_128X64::digest(bytes),
        code => return Err(BlockError::UnsupportedMultihash(code)),
    })
}

/// A hasher builder for cid hasher.
#[derive(Clone, Default)]
pub struct BuildCidHasher;

impl BuildHasher for BuildCidHasher {
    type Hasher = CidHasher;

    fn build_hasher(&self) -> Self::Hasher {
        CidHasher(None)
    }
}

/// A hasher that avoids rehashing cids by using the fact that they already
/// contain a hash.
pub struct CidHasher(Option<u64>);

impl Hasher for CidHasher {
    fn finish(&self) -> u64 {
        self.0.unwrap()
    }

    fn write(&mut self, bytes: &[u8]) {
        let mut b = [0u8; 8];
        b.clone_from_slice(&bytes[..8]);
        self.0 = Some(u64::from_be_bytes(b));
    }

    fn write_u64(&mut self, i: u64) {
        self.0 = Some(i);
    }
}

/// A HashMap for Cid's
pub type CidHashMap<V> = HashMap<Cid, V, BuildCidHasher>;
/// A HashSet for Cid's
pub type CidHashSet = HashSet<Cid, BuildCidHasher>;