respk 0.1.2

Manage resource files using a fast, custom open format designed especially for use in games.
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

use rusqlite::Row;
use std::ops::Deref;
use std::str;


/// Provides information about a resource.
#[derive(Clone, Debug)]
pub struct ResourceInfo {
    path: String,
    size: u32,
    compressed_size: u32,
}

impl ResourceInfo {
    /// Get the path of the resource.
    pub fn path(&self) -> &str {
        &self.path
    }

    /// Get the full size of the resource contents.
    pub fn size(&self) -> u32 {
        self.size
    }

    /// Get the compressed size of the resource.
    pub fn compressed_size(&self) -> u32 {
        self.compressed_size
    }

    pub(crate) fn from_row(row: &Row) -> ResourceInfo {
        ResourceInfo {
            path: row.get("path"),
            size: row.get("size"),
            compressed_size: row.get("compressed_size"),
        }
    }
}


/// A decompressed resource.
#[derive(Debug)]
pub struct Resource {
    info: ResourceInfo,
    contents: Vec<u8>,
}

impl Resource {
    pub(crate) fn new(info: ResourceInfo, contents: Vec<u8>) -> Resource {
        Resource {
            info: info,
            contents: contents,
        }
    }

    /// Get the contents of the resource.
    pub fn contents(&self) -> &[u8] {
        &self.contents
    }

    /// Get the contents of the resource as a string.
    pub fn contents_str(&self) -> Result<&str, str::Utf8Error> {
        str::from_utf8(&self.contents)
    }
}

impl Deref for Resource {
    type Target = ResourceInfo;

    fn deref(&self) -> &ResourceInfo {
        &self.info
    }
}