phpserz 0.2.2

A PHP serialization format parser and deserializer
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

/// An PHPserz error.
#[derive(Debug)]
pub struct Error {
    kind: ErrorKind,
}

impl Error {
    /// Get the kind of error.
    #[must_use]
    pub const fn kind(&self) -> &ErrorKind {
        &self.kind
    }

    /// Get the position of the error.
    #[must_use]
    pub const fn position(&self) -> Option<usize> {
        match &self.kind {
            ErrorKind::MismatchByte { position, .. }
            | ErrorKind::UnexpectedByte { position, .. }
            | ErrorKind::Empty { position }
            | ErrorKind::MissingQuotes { position }
            | ErrorKind::StringTooLong { position }
            | ErrorKind::InvalidNumber { position }
            | ErrorKind::Overflow { position } => Some(*position),
            ErrorKind::Deserialize { position, .. } => *position,
            ErrorKind::Eof | ErrorKind::Utf8(_) => None,
        }
    }
}

/// The kind of error that can occur when working with PHP serialized data.
#[derive(Debug)]
#[non_exhaustive]
pub enum ErrorKind {
    Eof,
    MismatchByte {
        expected: u8,
        found: u8,
        position: usize,
    },
    UnexpectedByte {
        found: u8,
        position: usize,
    },
    Utf8(std::str::Utf8Error),
    Deserialize {
        message: String,
        position: Option<usize>,
    },
    Empty {
        position: usize,
    },
    MissingQuotes {
        position: usize,
    },
    StringTooLong {
        position: usize,
    },
    InvalidNumber {
        position: usize,
    },
    Overflow {
        position: usize,
    },
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match &self.kind {
            ErrorKind::Empty { .. }
            | ErrorKind::MismatchByte { .. }
            | ErrorKind::UnexpectedByte { .. }
            | ErrorKind::Eof
            | ErrorKind::Deserialize { .. }
            | ErrorKind::StringTooLong { .. }
            | ErrorKind::InvalidNumber { .. }
            | ErrorKind::Overflow { .. }
            | ErrorKind::MissingQuotes { .. } => None,
            ErrorKind::Utf8(err) => Some(err),
        }
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match &self.kind {
            ErrorKind::MismatchByte {
                expected,
                found,
                position,
            } => {
                if found.is_ascii_alphanumeric() {
                    write!(
                        f,
                        "Expected byte '{}', found '{}' at position: {}",
                        *expected as char, *found as char, position
                    )
                } else {
                    write!(
                        f,
                        "Expected byte '{}', found 0x{:02x} at position: {}",
                        *expected as char, found, position
                    )
                }
            }
            ErrorKind::UnexpectedByte { found, position } => {
                if found.is_ascii_alphanumeric() {
                    write!(
                        f,
                        "Unexpected byte '{}' at position: {}",
                        *found as char, position
                    )
                } else {
                    write!(f, "Unexpected byte 0x{found:02x} at position: {position}")
                }
            }
            ErrorKind::Eof => write!(f, "Unexpected end of data"),
            ErrorKind::Deserialize { message, position } => {
                if let Some(pos) = position {
                    write!(f, "Deserialization error: {message} at position: {pos}")
                } else {
                    write!(f, "Deserialization error: {message}")
                }
            }
            ErrorKind::Empty { position } => {
                write!(f, "Unable to decode empty data at position: {position}")
            }
            ErrorKind::MissingQuotes { position } => {
                write!(f, "Missing quotes in string at position: {position}")
            }
            ErrorKind::StringTooLong { position } => {
                write!(f, "String is too long at position: {position}")
            }
            ErrorKind::InvalidNumber { position } => {
                write!(f, "Invalid number at position: {position}")
            }
            ErrorKind::Overflow { position } => write!(f, "Overflow at position: {position}"),
            ErrorKind::Utf8(err) => write!(f, "UTF-8 conversion error: {err}"),
        }
    }
}

impl From<ErrorKind> for Error {
    fn from(kind: ErrorKind) -> Self {
        Self { kind }
    }
}

#[cfg(feature = "serde")]
impl serde::de::Error for Error {
    fn custom<T: std::fmt::Display>(msg: T) -> Self {
        Self::from(ErrorKind::Deserialize {
            message: msg.to_string(),
            position: None,
        })
    }
}