stree 0.2.0

A directory hierarchy mapping format, similar to mtree
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
125
126
127
128

use rhash_rs as rhash;
use super::{Result, Error, error};
use std::str::FromStr;
use std::fmt::{self, Display};

#[cfg(feature = "serde")]
use serde::{Serialize, Deserialize};

/// Supported checksum hash algorithms for [`entries`](crate::Entry)
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Hash
{
    Sha256,
    Sha512,
    Sha3256,
    Sha3512,
    Blake2b,
    Blake2s,
    Blake3,
    Crc32,
    #[default]
    Crc32c
}

impl Display for Hash
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
    {
        write!(f, "{}", match self
        {
            Self::Sha256 => "sha256",
            Self::Sha512 => "sha512",
            Self::Sha3256 => "sha3-256",
            Self::Sha3512 => "sha3-512",
            Self::Blake2b => "blake2b",
            Self::Blake2s => "blake2s",
            Self::Blake3 => "blake3",
            Self::Crc32 => "crc32",
            Self::Crc32c => "crc32c"
        })
    }
}

impl FromStr for Hash
{
    type Err = Error;
    fn from_str(s: &str) -> Result<Self>
    {
        match s.to_ascii_lowercase().replace("_", "-").as_str()
        {
            "sha256"|"sha-256" => Ok(Self::Sha256),
            "sha512"|"sha-512" => Ok(Self::Sha512),
            "sha3256"|"sha3-256" => Ok(Self::Sha3256),
            "sha3512"|"sha3-512" => Ok(Self::Sha3512),
            "blake2b"|"blake2"|"b2"|"b2b" => Ok(Self::Blake2b),
            "blake2s"|"b2s" => Ok(Self::Blake2s),
            "blake3"|"b3" => Ok(Self::Blake3),
            "crc32" => Ok(Self::Crc32),
            "crc32c" => Ok(Self::Crc32c),
            s => error!("unknown hash algorithm '{s}'")
        }
        
    }
}

impl From<Hash> for rhash::Hash
{
    fn from(h: Hash) -> Self
    {
        match h
        {
            Hash::Sha256 => Self::SHA256,
            Hash::Sha512 => Self::SHA512,
            Hash::Sha3256 => Self::SHA3_256,
            Hash::Sha3512 => Self::SHA3_512,
            Hash::Blake2b => Self::BLAKE2B,
            Hash::Blake2s => Self::BLAKE2S,
            Hash::Blake3 => Self::BLAKE3,
            Hash::Crc32 => Self::CRC32,
            Hash::Crc32c => Self::CRC32C
        }
    }
}

/// Represents a file checksum, consisting of the hashing algorithm used
/// and the hash itself
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(rename_all = "kebab-case"))]
pub struct Checksum
{
    pub algo: Hash,
    pub hash: String
}

impl Checksum
{
    /// Construct a new checksum from an algorithm and hash string
    pub fn new<S>(algo: Hash, hash: S) -> Self
    where S: Into<String>
    {
        Self { hash: hash.into(), algo }
    }
}

impl FromStr for Checksum
{
    type Err = Error;
    fn from_str(input: &str) -> Result<Self>
    {
        if let Some(parts) = input.split_once(':')
        {
            Ok(Self::new(Hash::from_str(parts.0)?, parts.1))
        }
        else
        {
            error!("Missing ':' separator in checksum notation. Got '{input}'")
        }
    }
}

impl Display for Checksum
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
    {
        write!(f, "{}={}", &self.algo, &self.hash)
    }
}