hydraulic 0.1.0

An interface for generic compression library usage with a collection (unimplemented so far) of pre-existing compression libraries
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

use std::io::Read;

use crate::algorithm_meta::AlgorithmMeta;
use crate::algorithms::Algorithm;
use crate::errors::decompression_error::DecompressionError;

#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub struct ReadDecoder<'a, T: Algorithm, D: Read> {
    meta: AlgorithmMeta,
    algorithm: &'a T,
    pub origin: D,
}

impl<'a, T: Algorithm, D: Read> ReadDecoder<'a, T, D> {
    pub fn new(algorithm: &'a T, origin: D) -> Self {
        Self {
            meta: AlgorithmMeta { level: None },
            algorithm,
            origin,
        }
    }

    /// Attempts to read data of size equal to the buffer. Returns a Vec<u8> of the decompressed
    /// resulting data
    // TODO: Add in errors
    pub fn read(&mut self, buf: &mut [u8]) -> Result<Vec<u8>, DecompressionError> {
        self.origin.read_exact(buf).unwrap();
        self.algorithm.partial_decode(&buf, &self.meta)
    }

    /// Attempts to read and decompress all data within the origin until EOF
    pub fn read_all(&mut self) -> Result<Vec<u8>, DecompressionError> {
        let mut buf = Vec::new();
        self.origin.read_to_end(&mut buf).unwrap();

        self.algorithm.partial_decode(&*buf, &self.meta)
    }

    /// Attempts to finalise the data which remains within the buffer. This function makes
    /// no assumption on how much data remains within the origin
    pub fn finish(mut self) -> Result<Vec<u8>, DecompressionError> {
        Ok(Vec::from(
            self.algorithm.finalise_decode(&self.meta)?,
        ))
    }
}