compression-codecs 0.4.37

Adaptors for various compression algorithms.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use crate::{lzma::params::LzmaDecoderParams, xz2::process_stream, DecodeV2, DecodedSize};
use compression_core::util::{PartialBuffer, WriteBuffer};
use liblzma::stream::{Action, Stream};
use std::{
    convert::TryFrom,
    fmt,
    io::{self, Cursor},
};

/// Xz2 decoding stream
pub struct Xz2Decoder {
    stream: Stream,
    params: LzmaDecoderParams,
}

impl fmt::Debug for Xz2Decoder {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Xz2Decoder").finish_non_exhaustive()
    }
}

impl TryFrom<LzmaDecoderParams> for Xz2Decoder {
    type Error = liblzma::stream::Error;

    fn try_from(params: LzmaDecoderParams) -> Result<Self, Self::Error> {
        let stream = Stream::try_from(&params)?;
        Ok(Self { stream, params })
    }
}

impl Xz2Decoder {
    pub fn new(mem_limit: u64) -> Self {
        let params = LzmaDecoderParams::Auto {
            mem_limit,
            flags: 0,
        };
        Self::try_from(params).unwrap()
    }

    #[cfg(feature = "xz-parallel")]
    pub fn parallel(threads: std::num::NonZeroU32, mem_limit: u64) -> Self {
        use crate::lzma::params::MtStreamBuilder;

        let mut builder = MtStreamBuilder::default();

        builder
            .threads(threads)
            .timeout_ms(300)
            .mem_limit_stop(mem_limit);

        let params = LzmaDecoderParams::MultiThread { builder };

        Self::try_from(params).unwrap()
    }
}

impl DecodeV2 for Xz2Decoder {
    fn reinit(&mut self) -> io::Result<()> {
        *self = Self::try_from(self.params.clone())?;
        Ok(())
    }

    fn decode(
        &mut self,
        input: &mut PartialBuffer<&[u8]>,
        output: &mut WriteBuffer<'_>,
    ) -> io::Result<bool> {
        process_stream(&mut self.stream, input, output, Action::Run)
    }

    fn flush(&mut self, _output: &mut WriteBuffer<'_>) -> io::Result<bool> {
        // While decoding flush is a noop
        Ok(true)
    }

    fn finish(&mut self, output: &mut WriteBuffer<'_>) -> io::Result<bool> {
        process_stream(
            &mut self.stream,
            &mut PartialBuffer::new(&[]),
            output,
            Action::Finish,
        )
    }
}

impl DecodedSize for Xz2Decoder {
    fn decoded_size(input: &[u8]) -> io::Result<u64> {
        let cursor = Cursor::new(input);
        liblzma::uncompressed_size(cursor)
    }
}

#[cfg(test)]
mod tests {
    use std::convert::TryFrom;

    use crate::{
        lzma::params::{LzmaDecoderParams, LzmaFilter, LzmaFilters, LzmaOptions},
        Xz2Decoder,
    };

    #[test]
    fn test_lzma_decoder_from_params() {
        let filters = LzmaFilters::default().add_filter(LzmaFilter::Lzma2(LzmaOptions::default()));
        let params = LzmaDecoderParams::Raw { filters };
        Xz2Decoder::try_from(params).unwrap();
    }
}