flat_db 0.6.0

Flat file database
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
114
115
116
117
118
119
120
121
122
123
124

use miette::Diagnostic;
use serde::de::Error as DeError;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::fmt;
use std::fmt::{Debug, Display, Formatter, Write};
use std::num::ParseIntError;
use thiserror::Error;

const HEXADECIMAL_RADIX: u32 = 16;

/// Fixed-size byte array hash.
///
/// Serializes to and from hexadecimal strings.
#[derive(Clone, Copy, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Hash<const N: usize> {
    bytes: [u8; N],
}

impl<const N: usize> Hash<N> {
    /// Create a new hash from a byte array
    #[must_use]
    pub fn new(bytes: [u8; N]) -> Self {
        Self { bytes }
    }

    /// Create a `Hash<N>` from a hexadecimal string.
    pub fn from_string(hex: &str) -> Result<Self, HashError> {
        let bytes = to_bytes(hex)?;
        Ok(Hash::new(bytes))
    }

    /// Hexadecimal string representation.
    #[must_use]
    pub fn to_hex(&self) -> String {
        self.bytes.iter().fold(String::new(), |mut acc, &b| {
            let _ = write!(acc, "{b:02x}");
            acc
        })
    }

    /// Underlying byte array.
    #[must_use]
    pub fn as_bytes(&self) -> &[u8; N] {
        &self.bytes
    }

    /// Truncated hash with `M` bytes.
    ///
    /// Returns `None` if `M > N`.
    #[must_use]
    pub fn truncate<const M: usize>(&self) -> Option<Hash<M>> {
        let bytes: [u8; M] = self.bytes[..M].try_into().ok()?;
        Some(Hash::new(bytes))
    }
}

impl<const N: usize> Debug for Hash<N> {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        write!(formatter, "{}", self.to_hex())
    }
}

impl<const N: usize> Default for Hash<N> {
    fn default() -> Self {
        Self::new([0; N])
    }
}

impl<const N: usize> Display for Hash<N> {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        write!(formatter, "{}", self.to_hex())
    }
}

impl<const N: usize> Serialize for Hash<N> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&self.to_hex())
    }
}

impl<'de, const N: usize> Deserialize<'de> for Hash<N> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let hex_str = String::deserialize(deserializer)?;
        Hash::from_string(&hex_str).map_err(DeError::custom)
    }
}

/// Convert a hexadecimal string to a 20-byte array.
fn to_bytes<const N: usize>(hex: &str) -> Result<[u8; N], HashError> {
    let length = hex.len();
    if length != N * 2 {
        return Err(HashError::InvalidLength {
            expected: N * 2,
            actual: length,
        });
    }
    let mut bytes = [0_u8; N];
    for (i, byte) in bytes.iter_mut().enumerate() {
        let start = i * 2;
        let byte_str = &hex[start..start + 2];
        *byte = to_byte(byte_str).map_err(|_| HashError::InvalidCharacter { position: start })?;
    }
    Ok(bytes)
}

/// Convert a 2-character hexadecimal string to a byte.
fn to_byte(hex: &str) -> Result<u8, ParseIntError> {
    u8::from_str_radix(hex, HEXADECIMAL_RADIX)
}

/// Errors when parsing a `Hash` from a hexadecimal string.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Error, Diagnostic)]
pub enum HashError {
    #[error("Invalid hex length\nExpected: {expected}\nActual: {actual}")]
    InvalidLength { expected: usize, actual: usize },
    #[error("Invalid hex character at position {position}")]
    InvalidCharacter { position: usize },
}