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

use super::{util, Archive};

use anyhow::Result;
use std::fs::File;
use std::io::prelude::*;
use std::path::Path;

pub trait WriteArchive {
    /// Writes an archive to disk with the given path. If a file is already
    /// present at the given path, it is simply overwritten.
    fn save(&self, path: &Path) -> Result<()>;

    /// Inserts a key-value pair. If the archive already contains the given
    /// key, the previous value for that key is returned.
    fn insert<S>(&mut self, key: S, value: Vec<u8>) -> Option<Vec<u8>>
    where
        S: Into<String>;
}

impl WriteArchive for Archive {
    fn save(&self, path: &Path) -> Result<()> {
        let mut file = File::create(path)?;

        // compute the file's format and write to disk.
        self.write_to_file(&mut file)?;

        Ok(())
    }

    fn insert<S>(&mut self, key: S, value: Vec<u8>) -> Option<Vec<u8>>
    where
        S: Into<String>,
    {
        let hash = util::entry_hash(key.into());

        self.entries.insert(hash, value)
    }
}

impl Archive {
    fn write_to_file(&self, file: &mut File) -> Result<()> {
        Ok(())
    }

    fn generate_data_block(&self) -> Option<Vec<u8>> {
        None
    }
}