better-limit-reader 3.0.0

Configurable limit reader that limits the number of bytes read from an underlying reader, supporting decompression from Gzip and Zlib compressed via `flate2`
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use crate::{error_from, LimitReaderOutputBuilderError};
use std::{
    error::Error as StdError,
    fmt::{self},
    num::TryFromIntError,
    string::FromUtf8Error,
};

/// Boxed error, a ptr to the Error via dynamic dispatch allocated on the heap at run time.
#[allow(clippy::module_name_repetitions)]
pub type BoxError = Box<dyn StdError + Send + Sync>;

/// Error type
pub struct Error {
    kind: ErrorKind,
    error: BoxError,
}

#[derive(Debug)]
#[non_exhaustive]
#[allow(clippy::module_name_repetitions)]
#[allow(clippy::enum_variant_names)]
pub enum ErrorKind {
    ReadError,
    IoError,
    LimitReaderOutputBuilderError,
    Utf8Error,
    TryFromIntError,
}

impl ErrorKind {
    pub(crate) fn as_str(&self) -> &'static str {
        #[allow(clippy::enum_glob_use)]
        use ErrorKind::*;
        // tidy-alphabetical-start
        match *self {
            ReadError => "read error",
            IoError => "io error",
            Utf8Error => "invalid utf-8",
            LimitReaderOutputBuilderError => "builder error",
            TryFromIntError => "conversion error",
        }
    }
}

impl fmt::Display for ErrorKind {
    /// Shows a human-readable description of the `ErrorKind`.
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.write_str(self.as_str())
    }
}

impl StdError for Error {
    fn source(&self) -> Option<&(dyn StdError + 'static)> {
        Some(&*self.error)
    }
}

#[allow(dead_code)]
impl Error {
    pub fn new<E>(kind: ErrorKind, error: E) -> Error
    where
        E: Into<BoxError>,
    {
        Self::_new(kind, error.into())
    }

    fn _new(kind: ErrorKind, error: BoxError) -> Error {
        Error { kind, error }
    }
}

impl fmt::Debug for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut f = f.debug_tuple("better-limit-reader::Error");
        f.field(&self.kind);
        f.field(&self.error);
        f.finish()
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Error: {}", &self.error)
    }
}

error_from!(std::io::Error, ErrorKind::IoError);
error_from!(FromUtf8Error, ErrorKind::Utf8Error);
error_from!(
    LimitReaderOutputBuilderError,
    ErrorKind::LimitReaderOutputBuilderError
);
error_from!(TryFromIntError, ErrorKind::TryFromIntError);

#[macro_use]
pub mod macros {
    /// Implement provided Error type with a suitable `ErrorKind`
    #[macro_export]
    macro_rules! error_from {
        ($typ:ty, $kind:expr) => {
            impl From<$typ> for Error {
                fn from(error: $typ) -> Self {
                    Self {
                        error: error.into(),
                        kind: $kind,
                    }
                }
            }
        };
    }
}

/// Default error for [`crate::prelude::LimitReader`]
#[allow(clippy::module_name_repetitions)]
pub type LimitReaderError = Error;