intern-mint 0.3.0

byte slice interning
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use std::{
    borrow::Borrow,
    cmp::Ordering,
    ffi::{OsStr, OsString},
    hash::{Hash, Hasher},
    ops::Deref,
    path::{Path, PathBuf},
    sync::LazyLock,
};

use triomphe::Arc;

use crate::{borrow::BorrowedInterned, pool::POOL};

#[derive(Clone, Eq)]
#[repr(transparent)]
/// The main type offered by this crate, responsible for interning slices
pub struct Interned(Arc<[u8]>);

impl Interned {
    /// Constructs a new [Interned] for a given `value`
    ///
    /// # Example
    ///
    /// ```
    /// use intern_mint::Interned;
    ///
    /// let a = Interned::new(b"hello");
    /// let b = Interned::new(b"hello");
    ///
    /// assert_eq!(a.as_ptr(), b.as_ptr());
    /// ```
    pub fn new(value: &[u8]) -> Self {
        Self(POOL.get_or_insert(value))
    }

    pub(crate) fn from_existing(value: Arc<[u8]>) -> Self {
        Self(value)
    }
}

pub(crate) static DEFAULT: LazyLock<Interned> = LazyLock::new(|| Interned::new(Default::default()));

impl Default for Interned {
    fn default() -> Self {
        DEFAULT.clone()
    }
}

impl Drop for Interned {
    fn drop(&mut self) {
        POOL.remove_if_needed(&self.0);
    }
}

impl Deref for Interned {
    type Target = BorrowedInterned;

    fn deref(&self) -> &Self::Target {
        BorrowedInterned::new(self.0.deref())
    }
}

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

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

impl PartialOrd for Interned {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for Interned {
    fn cmp(&self, other: &Self) -> Ordering {
        self.deref().cmp(other)
    }
}

impl From<&[u8]> for Interned {
    fn from(value: &[u8]) -> Self {
        Interned::new(value)
    }
}
impl From<Vec<u8>> for Interned {
    fn from(value: Vec<u8>) -> Self {
        value.as_slice().into()
    }
}

impl From<&str> for Interned {
    fn from(value: &str) -> Self {
        value.as_bytes().into()
    }
}

impl From<String> for Interned {
    fn from(value: String) -> Self {
        value.as_bytes().into()
    }
}

impl From<&String> for Interned {
    fn from(value: &String) -> Self {
        value.as_bytes().into()
    }
}

impl From<&OsStr> for Interned {
    fn from(value: &OsStr) -> Self {
        value.as_encoded_bytes().into()
    }
}

impl From<OsString> for Interned {
    fn from(value: OsString) -> Self {
        value.as_encoded_bytes().into()
    }
}

impl From<&OsString> for Interned {
    fn from(value: &OsString) -> Self {
        value.as_encoded_bytes().into()
    }
}

impl From<&Path> for Interned {
    fn from(value: &Path) -> Self {
        value.as_os_str().into()
    }
}

impl From<PathBuf> for Interned {
    fn from(value: PathBuf) -> Self {
        value.as_os_str().into()
    }
}

impl From<&PathBuf> for Interned {
    fn from(value: &PathBuf) -> Self {
        value.as_os_str().into()
    }
}

impl Borrow<BorrowedInterned> for Interned {
    fn borrow(&self) -> &BorrowedInterned {
        self.deref()
    }
}

impl AsRef<BorrowedInterned> for Interned {
    fn as_ref(&self) -> &BorrowedInterned {
        self.deref()
    }
}