rlz 0.2.0

Relative Lempel-Ziv (RLZ): a LZ based compressor against a large static dictionary
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

use bytes::{Buf, BufMut};

use crate::{coder, config, dict, index, scratch, Error};

pub(crate) struct Encoder {
    pub(crate) index: index::Index,
    pub(crate) coder: coder::Coder,
    scratch: scratch::ScratchSpace,
}

impl Encoder {
    #[tracing::instrument(skip_all)]
    pub(crate) fn build(
        dict: &dict::Dictionary,
        compression_config: &config::Configuration,
    ) -> Encoder {
        let index = index::Index::from_dict(dict, compression_config);
        Encoder {
            index,
            coder: compression_config.factor_compression.clone(),
            scratch: scratch::ScratchSpace::default(),
        }
    }

    #[tracing::instrument(skip_all)]
    pub(crate) fn encode(
        &self,
        dict: &dict::Dictionary,
        input: impl Buf,
        output: impl BufMut,
    ) -> Result<usize, Error> {
        let mut scratch = self.scratch.get();
        scratch.clear();
        for factor in self.index.factorize(dict, input) {
            self.coder.store_factor(&mut scratch, factor);
        }
        let encode_output = self.coder.encode(output, &mut scratch);
        self.scratch.release(scratch);
        encode_output
    }
}