q_compress 0.2.2

Good data compression for numerical sequences
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

use std::error::Error;
use std::fmt::{Display, Formatter};
use std::fmt;

use crate::constants::{MAGIC_HEADER, MAX_ENTRIES, MAX_MAX_DEPTH};

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum QCompressError where {
  MaxEntriesError { n: usize },
  MaxDepthError { max_depth: u32},
  OutOfRangeError { num_string: String },
  MisalignedError {},
  MagicHeaderError { header: Vec<u8> },
  HeaderDtypeError { header_byte: u8, decompressor_byte: u8 },
}

impl Display for QCompressError {
  fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
    match self {
      QCompressError::MaxEntriesError {n} => write!(
        f,
        "number of elements {} exceeded max number of elements {}",
        n,
        MAX_ENTRIES,
      ),
      QCompressError::MaxDepthError {max_depth} => write!(
        f,
        "max depth {} exceeded max max depth of {}",
        max_depth,
        MAX_MAX_DEPTH,
      ),
      QCompressError::OutOfRangeError {num_string} => write!(
        f,
        "number {} was not found in any range",
        num_string,
      ),
      QCompressError::MisalignedError {} => write!(
        f,
        "cannot read_bytes on misaligned bit reader"
      ),
      QCompressError::MagicHeaderError { header } => write!(
        f,
        "header {:?} did not match qco expected header {:?}",
        header,
        MAGIC_HEADER,
      ),
      QCompressError::HeaderDtypeError {header_byte, decompressor_byte} => write!(
        f,
        "header byte {} did not match expected decompressor data type byte {}",
        header_byte,
        decompressor_byte,
      )
    }
  }
}

impl Error for QCompressError {}