krabka-compression 0.7.0

Kafka wire-protocol compression codecs for Rust
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

//! Errors returned by `compress` and `decompress`.

use thiserror::Error;

/// Errors that can occur during compression or decompression.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum CompressionError {
    /// The requested codec was not enabled at compile time. The codec name
    /// is one of `"gzip"`, `"snappy"`, `"lz4"`, `"zstd"`.
    #[error("compression feature `{0}` not enabled at compile time")]
    FeatureDisabled(&'static str),

    /// The codec could not parse the compressed payload. Examples are truncated
    /// input, bad framing, and an invalid checksum.
    #[error("invalid compressed data: {0}")]
    InvalidData(String),

    /// Decompression produced, or would produce, more output than the caller's
    /// `max_output` cap allows. This guards against decompression bombs, that
    /// is a small compressed payload that expands to gigabytes.
    #[error("decompressed output exceeds limit of {limit} bytes")]
    TooLarge { limit: usize },

    /// The compression level is outside the range that Kafka accepts for the
    /// codec, or the codec has no levels. `reason` is the message of Kafka's
    /// level validator (`CompressionType.levelValidator`).
    #[error("invalid {codec} compression level {level}: {reason}")]
    InvalidLevel {
        /// The codec name: `"none"`, `"gzip"`, `"snappy"`, `"lz4"` or `"zstd"`.
        codec: &'static str,
        /// The level that the caller gave.
        level: i32,
        /// Kafka's message for the level.
        reason: String,
    },

    /// I/O error from one of the codec libraries.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn feature_disabled_display() {
        let e = CompressionError::FeatureDisabled("snappy");
        assert2::assert!(
            e.to_string() == "compression feature `snappy` not enabled at compile time"
        );
    }
}