jagged 0.2.0

jagged provides an API to read data entries from JAG archives.
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

use super::util;
use std::collections::HashMap;

// some possible issues w/ current design: excessive copying??
// a lot of the interfacing is a clear copy on HashMap.. maybe we can
// leverage that.

#[derive(Clone, Debug, Default)]
pub struct Archive {
    pub(crate) entries: HashMap<u32, Vec<u8>>,
}

impl Archive {
    /// Creates a new archive with an empty entry table.
    pub fn new() -> Self {
        Default::default()
    }
}

impl Archive {
    /// Returns `true` if the entry table contains the specified key.
    pub fn contains_key<S>(&self, key: S) -> bool
    where
        S: Into<String>,
    {
        let hash = util::entry_hash(key.into());

        self.entries.contains_key(&hash)
    }

    /// Removes an entry.
    pub fn remove<S>(&mut self, key: S) -> Option<Vec<u8>>
    where
        S: Into<String>,
    {
        let hash = util::entry_hash(key.into());

        self.entries.remove(&hash)
    }

    /// Clears the entry table of this archive
    pub fn clear(&mut self) {
        self.entries.clear();
    }

    /// Returns the number of entries this archive contains.
    pub fn len(&self) -> usize {
        self.entries.len()
    }

    /// Returns `true` if the archive contains no entries
    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }
}