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
109
110
111
112
113
114
115
116

use compression_core::{
    util::{PartialBuffer, WriteBuffer},
    Level,
};
use liblzma::stream::{Action, Check, Stream};
use std::{
    convert::{TryFrom, TryInto},
    fmt, io,
};

use crate::{
    lzma::params::{LzmaEncoderParams, LzmaOptions},
    xz2::process_stream,
    EncodeV2, Xz2FileFormat,
};

/// Xz2 encoding stream
pub struct Xz2Encoder {
    stream: Stream,
    params: LzmaEncoderParams,
}

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

impl TryFrom<LzmaEncoderParams> for Xz2Encoder {
    type Error = liblzma::stream::Error;

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

fn xz2_level(level: Level) -> u32 {
    match level {
        Level::Fastest => 0,
        Level::Best => 9,
        Level::Precise(quality) => quality.try_into().unwrap_or(0).clamp(0, 9),
        _ => 5,
    }
}

impl Xz2Encoder {
    pub fn new(format: Xz2FileFormat, level: Level) -> Self {
        let preset = xz2_level(level);
        let params = match format {
            Xz2FileFormat::Xz => LzmaEncoderParams::Easy {
                preset,
                check: Check::Crc64,
            },
            Xz2FileFormat::Lzma => {
                let options = LzmaOptions::default().preset(preset);
                LzmaEncoderParams::Lzma { options }
            }
        };

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

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

        let preset = xz2_level(level);
        let mut builder = MtStreamBuilder::default();
        builder
            .threads(threads)
            .timeout_ms(300)
            .preset(preset)
            .check(Check::Crc64);
        let params = LzmaEncoderParams::MultiThread { builder };
        Self::try_from(params).unwrap()
    }
}

impl EncodeV2 for Xz2Encoder {
    fn encode(
        &mut self,
        input: &mut PartialBuffer<&[u8]>,
        output: &mut WriteBuffer<'_>,
    ) -> io::Result<()> {
        process_stream(&mut self.stream, input, output, Action::Run).map(|_| ())
    }

    fn flush(&mut self, output: &mut WriteBuffer<'_>) -> io::Result<bool> {
        let action = match &self.params {
            // Multi-threaded streams don't support SyncFlush, use FullFlush instead
            #[cfg(feature = "xz-parallel")]
            LzmaEncoderParams::MultiThread { builder: _ } => Action::FullFlush,
            _ => Action::SyncFlush,
        };

        process_stream(
            &mut self.stream,
            &mut PartialBuffer::new(&[]),
            output,
            action,
        )
    }

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