zero_escape 1.0.0

Provides encoding and decoding data using the Zero Escape Encoding method.
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

use std::fmt::{Debug, Display, Formatter};

#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum Error {
    InvalidRepr {
        pos: usize,
        flag: u8,
        byte: u8,
    },
    UnencodedInput {
        pos: usize,
        byte: u8,
    },
}

impl Error {
    pub(crate) fn new(pos: usize, byte: u8, flag: Option<u8>) -> Self {
        if let Some(flag) = flag {
            Self::InvalidRepr { pos, flag, byte }
        } else {
            Self::UnencodedInput { pos, byte }
        }
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", match self {
            Error::InvalidRepr {
                pos, flag, byte
            } => format!(
                "Detected a flag [0x{:X}], \
                but the following byte [0x{:X}] \
                at position [{}] \
                is not a valid representation.",
                flag,
                byte,
                pos,
            ),
            Error::UnencodedInput {
                pos, byte
            } => format!(
                "Provided input that was not encoded and \
                contains illegal byte [0x{:X}] \
                at position [{}].",
                byte,
                pos,
            ),
        } )
    }
}

impl std::error::Error for Error {}