hydrate-base 0.0.2

Game asset pipeline and authoring framework
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

use std::fmt;
use std::hash::{Hash, Hasher};
use std::sync::Arc;

#[derive(Clone, Debug)]
pub enum StringHashContents {
    Static(&'static str),
    Runtime(Arc<String>),
    Unknown,
}

/// Store a hash and optionally the string used to create it. The string may not be available if:
///  - The hash was created directly without a string
///  - The `strip-stringhash-strings` feature is enabled in the crate
///
/// This allows for debugging ease normally but can be used in release to save memory and avoid
/// leaking data in strings
#[derive(Clone)]
pub struct StringHash {
    hash: u128,
    // The contents are a debugging aid that may be stripped
    #[cfg(not(feature = "strip-stringhash-strings"))]
    contents: StringHashContents,
}

impl fmt::Debug for StringHash {
    fn fmt(
        &self,
        f: &mut fmt::Formatter<'_>,
    ) -> fmt::Result {
        #[cfg(feature = "strip-stringhash-strings")]
        {
            f.debug_struct("StringHash")
                .field("hash", &format!("{:0>32x}", self.hash))
                .finish()
        }

        #[cfg(not(feature = "strip-stringhash-strings"))]
        {
            f.debug_struct("StringHash")
                .field("hash", &format!("{:0>32x}", self.hash))
                .field("contents", &self.contents)
                .finish()
        }
    }
}

impl PartialEq for StringHash {
    fn eq(
        &self,
        other: &Self,
    ) -> bool {
        self.hash.eq(&other.hash)
    }
}

impl Eq for StringHash {}

impl Hash for StringHash {
    fn hash<H: Hasher>(
        &self,
        state: &mut H,
    ) {
        self.hash.hash(state);
    }
}

impl StringHash {
    pub const fn from_static_str(s: &'static str) -> Self {
        let hash = if s.is_empty() {
            0u128
        } else {
            const_fnv1a_hash::fnv1a_hash_str_128(s) | 1u128
        };

        #[cfg(not(feature = "strip-stringhash-strings"))]
        let contents = StringHashContents::Static(s);

        StringHash {
            hash,
            #[cfg(not(feature = "strip-stringhash-strings"))]
            contents,
        }
    }

    pub fn from_runtime_str(s: &str) -> Self {
        let hash = if s.is_empty() {
            0u128
        } else {
            const_fnv1a_hash::fnv1a_hash_str_128(s) | 1u128
        };

        #[cfg(not(feature = "strip-stringhash-strings"))]
        let contents = StringHashContents::Runtime(Arc::new(s.to_string()));

        StringHash {
            hash,
            #[cfg(not(feature = "strip-stringhash-strings"))]
            contents,
        }
    }

    pub fn from_hash(hash: u128) -> Self {
        StringHash {
            hash,
            #[cfg(not(feature = "strip-stringhash-strings"))]
            contents: StringHashContents::Unknown,
        }
    }

    pub fn hash(&self) -> u128 {
        self.hash
    }

    #[cfg(not(feature = "strip-stringhash-strings"))]
    pub fn contents(&self) -> &StringHashContents {
        &self.contents
    }
}