byte-size 0.2.7

An effective short string shrinker with total disregard for speed, memory usage and executable size
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

use bimap::BiHashMap;
use crate::builder::Builder;
use crate::iterator::CodeIterator;
use crate::error::Result;
use crate::ir::CodeType;

///Used to compress and decompress
///
/// Can only be created with the [Builder] struct via [Builder::engine]
pub struct Engine {
    pub (crate) custom_spaces: bool,
    pub (crate) custom_map: BiHashMap<& 'static [u8], usize>,
    pub (crate) lengths: Vec<usize>,
}

impl Engine {

    ///Compress the string using the builder options
    pub fn compress(&self, string: & str) -> Vec<u8> {
        let mut res = Vec::new();

        for code in CodeIterator::new(string, &self) {
            code.serialize_into(& mut res, &self);
        }

        res
    }

    ///Tries to decompress the byte slice.
    ///
    /// If successful, the decompressed string is returned. Otherwise a [Result] is returned.
    pub fn decompress(&self, mut bytes: & [u8]) -> Result<String> {
        let mut string = String::new();

        while !bytes.is_empty() {
            let code = CodeType::deserialize_from(& mut bytes, &self)?;

            code.add_to_string(& mut string, &self)?;
        }

        Ok(string)
    }

}

///Convenience function to compress a string using the [Builder::default] options
pub fn compress(string: &str) -> Vec<u8> {
    Builder::default().engine().compress(string)
}

///Convenience function to decompress a byte slice using the [Builder::default] options
pub fn decompress(bytes: & [u8]) -> Result<String> {
    Builder::default().engine().decompress(bytes)
}