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
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

#[cfg(test)]
mod tests;

mod algorithm_meta;
mod algorithms;
mod compression_level;
mod errors;
mod features;
pub mod read;
mod write;

/// Generic interface to compress data through either a Read or a Write interface
/// TODO: Example
pub mod compress {
    pub use crate::read::compress::ReadEncoder;
    pub use crate::write::compress::WriteEncoder;
}
/// Generic interface to decompress data through either a Read or a Write interface
pub mod decompress {
    pub use crate::read::decompress::ReadDecoder;
    pub use crate::write::decompress::WriteDecoder;
}
/// Implements:
///  - ReadDecoder
///  - WriteDecoder
///  - ReadEncoder
///  - WriteEncoder
///  - Algorithm
///  - AlgorithmMeta
///  - CompressionLevel
pub mod prelude {
    pub use crate::decompress::ReadDecoder;
    pub use crate::decompress::WriteDecoder;

    pub use crate::compress::ReadEncoder;
    pub use crate::compress::WriteEncoder;

    pub use crate::AlgorithmMeta;
    pub use crate::CompressionLevel;
    
    pub use crate::errors::decompression_error::DecompressionError;
    pub use crate::errors::compression_error::CompressionError;
}

/// Module specifically for implementation
/// 
/// This contains all the necessary traits, structs, and other things to implement your own
/// compression algorithm
pub mod implementation {
    pub use crate::decompress::ReadDecoder;
    pub use crate::decompress::WriteDecoder;

    pub use crate::compress::ReadEncoder;
    pub use crate::compress::WriteEncoder;

    pub use crate::AlgorithmMeta;
    pub use crate::CompressionLevel;

    pub use crate::errors::decompression_error::DecompressionError;
    pub use crate::errors::compression_error::CompressionError;

    pub use crate::Algorithm;
}
/// Metadata for algorithms to add generic data to. Should not be used to store anything except
/// data specifically for the algorithm itself
pub use crate::algorithm_meta::AlgorithmMeta;
/// Algorithm is the generic type which implements all the functions required for both encoding
/// and decoding
pub use crate::algorithms::Algorithm;
/// General Compression Level implementation for Algorithm.
/// Low = 2
/// Med = 6
/// High = 9
/// Custom values may also be assigned using the CompressionLevel::Custom(x) enum type
pub use crate::compression_level::CompressionLevel;

// Features

#[cfg(any(
    feature = "full",
    feature = "gzip"
))]
pub use features::gz::Gzip;

#[cfg(any(
    feature = "full",
    feature = "deflate"
))]pub use features::deflate::Deflate;