singlefile-formats 0.3.1

Default file format implementations for singlefile.
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

#![cfg_attr(docsrs, doc(cfg(feature = "flate")))]
#![cfg(feature = "flate")]

//! Defines [`CompressionFormat`]s for the DEFLATE, gzip and zlib compression algorithms.

pub extern crate flate2 as original;

use crate::compression::{CompressionFormat, CompressionFormatLevels};

use std::io::{Read, Write};

/// A [`CompressionFormat`] corresponding to the DEFLATE compression algorithm.
/// Implemented using the [`flate2`] crate.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct Deflate;

impl CompressionFormat for Deflate {
  type Encoder<W: Write> = flate2::write::DeflateEncoder::<W>;
  type Decoder<R: Read> = flate2::read::DeflateDecoder::<R>;

  fn encode_writer<W: Write>(&self, writer: W, compression: u32) -> Self::Encoder<W> {
    Self::Encoder::new(writer, flate2::Compression::new(compression))
  }

  fn decode_reader<R: Read>(&self, reader: R) -> Self::Decoder<R> {
    Self::Decoder::new(reader)
  }
}

impl CompressionFormatLevels for Deflate {
  const COMPRESSION_LEVEL_NONE: u32 = 0;
  const COMPRESSION_LEVEL_FAST: u32 = 1;
  const COMPRESSION_LEVEL_BEST: u32 = 9;
  const COMPRESSION_LEVEL_DEFAULT: u32 = 6;
}

/// A [`CompressionFormat`] corresponding to the gzip compression algorithm.
/// Implemented using the [`flate2`] crate.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct Gz;

impl CompressionFormat for Gz {
  type Encoder<W: Write> = flate2::write::GzEncoder::<W>;
  type Decoder<R: Read> = flate2::read::GzDecoder::<R>;

  fn encode_writer<W: Write>(&self, writer: W, compression: u32) -> Self::Encoder<W> {
    Self::Encoder::new(writer, flate2::Compression::new(compression))
  }

  fn decode_reader<R: Read>(&self, reader: R) -> Self::Decoder<R> {
    Self::Decoder::new(reader)
  }
}

impl CompressionFormatLevels for Gz {
  const COMPRESSION_LEVEL_NONE: u32 = 0;
  const COMPRESSION_LEVEL_FAST: u32 = 1;
  const COMPRESSION_LEVEL_BEST: u32 = 9;
  const COMPRESSION_LEVEL_DEFAULT: u32 = 6;
}

/// A [`CompressionFormat`] corresponding to the zlib compression algorithm.
/// Implemented using the [`flate2`] crate.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct ZLib;

impl CompressionFormat for ZLib {
  type Encoder<W: Write> = flate2::write::ZlibEncoder::<W>;
  type Decoder<R: Read> = flate2::read::ZlibDecoder::<R>;

  fn encode_writer<W: Write>(&self, writer: W, compression: u32) -> Self::Encoder<W> {
    Self::Encoder::new(writer, flate2::Compression::new(compression))
  }

  fn decode_reader<R: Read>(&self, reader: R) -> Self::Decoder<R> {
    Self::Decoder::new(reader)
  }
}

impl CompressionFormatLevels for ZLib {
  const COMPRESSION_LEVEL_NONE: u32 = 0;
  const COMPRESSION_LEVEL_FAST: u32 = 1;
  const COMPRESSION_LEVEL_BEST: u32 = 9;
  const COMPRESSION_LEVEL_DEFAULT: u32 = 6;
}