ircv3_parse 4.0.0

Zero-copy parser for IRCv3 messages
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
use crate::compat::{format, Debug, FmtResult, Formatter, String, ToString};

#[derive(Clone, PartialEq, thiserror::Error)]
pub enum IRCError {
    #[error("cannot parse empty message")]
    EmptyInput,
    #[error("{component} must be followed by a space")]
    MissingSpace { component: &'static str },

    #[error(transparent)]
    Command(#[from] CommandError),
    #[error(transparent)]
    Param(#[from] ParamError),
}

impl Debug for IRCError {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "IRC-PARSER[{}]: {}", self.code(), self)
    }
}

impl IRCError {
    pub fn code(&self) -> &'static str {
        match self {
            Self::EmptyInput => "SCAN",
            Self::MissingSpace { component } => component,
            Self::Command(cmd) => cmd.code(),
            Self::Param(param) => param.code(),
        }
    }

    pub(crate) fn missing_space(component: &'static str) -> Self {
        Self::MissingSpace { component }
    }

    pub(crate) fn empty_command() -> Self {
        Self::Command(CommandError::Empty)
    }

    pub(crate) fn invalid_first_char_command(c: char) -> Self {
        Self::Command(CommandError::InvalidFirstChar { char: c })
    }

    pub(crate) fn wrong_digit_count_command(actual: usize) -> Self {
        Self::Command(CommandError::WrongDigitCount { actual })
    }

    pub(crate) fn empty_middle_param() -> Self {
        Self::Param(ParamError::EmptyMiddle)
    }
}

#[derive(Clone, PartialEq, thiserror::Error)]
pub enum SerError {
    #[error("command is required")]
    MissingCommand,
    #[error("command already set")]
    DuplicateCommand,

    #[error(transparent)]
    Tag(#[from] TagError),
    #[error(transparent)]
    Source(#[from] SourceError),
    #[error(transparent)]
    Param(#[from] ParamError),
}

impl Debug for SerError {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "IRC-SERIALIZER[{}]: {}", self.code(), self)
    }
}

impl SerError {
    pub fn code(&self) -> &'static str {
        match self {
            Self::MissingCommand | Self::DuplicateCommand => "COMMAND",
            Self::Tag(tag) => tag.code(),
            Self::Source(src) => src.code(),
            Self::Param(param) => param.code(),
        }
    }

    pub fn is_missing_command(&self) -> bool {
        matches!(self, Self::MissingCommand)
    }

    pub fn is_duplicate_command(&self) -> bool {
        matches!(self, Self::DuplicateCommand)
    }

    pub(crate) fn missing_nick() -> Self {
        Self::Source(SourceError::MissingNick)
    }
}

#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum TagError {
    #[error("tags cannot be empty")]
    Empty,

    #[error("tag key cannot be empty")]
    EmptyKey,

    #[error("tag key contains invalid character '{char}' at position {position}")]
    InvalidKeyChar { char: char, position: usize },
    #[error("tag value contains invalid character '{char}' at position {position}")]
    InvalidValueChar { char: char, position: usize },

    #[error(transparent)]
    Hostname(#[from] HostnameError),
}

impl TagError {
    pub fn code(&self) -> &'static str {
        "TAG"
    }
}

#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum SourceError {
    #[error("source cannot be empty")]
    Empty,
    #[error("nickname cannot be empty")]
    EmptyNick,
    #[error("username cannot be empty")]
    EmptyUser,
    #[error("nickname must start with a letter, got '{char}'")]
    InvalidNickFirstChar { char: char },
    #[error("nickname contains invalid character '{char}' at position {position} (only letters, digits, and special chars allowed)")]
    InvalidNickChar { char: char, position: usize },

    #[error("username contains invalid character '{char}' at position {position} (control characters not allowed)")]
    InvalidUserChar { char: char, position: usize },

    #[error(transparent)]
    Hostname(#[from] HostnameError),

    #[error("missing source name")]
    MissingNick,
    #[error("source {component} already set")]
    DublicateComponent { component: &'static str },
}

impl SourceError {
    pub fn code(&self) -> &'static str {
        "SOURCE"
    }

    pub(crate) fn duplicate_component(component: &'static str) -> Self {
        Self::DublicateComponent { component }
    }
}

#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum CommandError {
    #[error("command cannot be empty")]
    Empty,
    #[error("command must start with a letter or digit, got '{char}'")]
    InvalidFirstChar { char: char },
    #[error("command must be all letters or 3-digit number, got '{input}' at position {position}")]
    InvalidCommand { input: String, position: usize },
    #[error("numeric command must be exactly 3 digits, got {actual} digits")]
    WrongDigitCount { actual: usize },
}

impl CommandError {
    pub fn code(&self) -> &'static str {
        "CMD"
    }
}

#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum ParamError {
    #[error("parameter middle cannot be empty")]
    EmptyMiddle,
    #[error("parameter middle contains invalid character '{char}' at position {position}")]
    InvalidMiddleChar { char: char, position: usize },
    #[error("parameter contains forbidden control character (colon, space, CR, LF, NUL)")]
    ContainsControlChar,
}

impl ParamError {
    pub fn code(&self) -> &'static str {
        "PARAM"
    }
}

#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum HostnameError {
    #[error("hostname cannot be empty")]
    Empty,
    #[error("hostname label cannot be empty")]
    EmptyLabel,

    #[error("hostname label must start with a letter or digit, got '{char}'")]
    InvalidFirstChar { char: char },
    #[error("hostname label cannot end with hyphen, got '{char}'")]
    InvalidLastChar { char: char },
    #[error("hostname label contains invalid character '{char}'")]
    InvalidChar { char: char },

    #[error("hostname label exceeds maximum length (max {max} characters, got {actual})")]
    LabelTooLong { max: usize, actual: usize },
    #[error("hostname exceeds maximum depth (max {max} labels, got {actual})")]
    TooManyLabels { max: usize, actual: usize },
    #[error("hostname exceeds maximum total length (max {max} characters, got {actual})")]
    TooLong { max: usize, actual: usize },
}

impl HostnameError {
    pub fn code(&self) -> &'static str {
        "RFC952"
    }
}

#[derive(Clone, PartialEq, thiserror::Error)]
pub enum DeError {
    #[error("command mismatch: expected `{expected}`, got `{actual}`")]
    CommandMismatch { expected: String, actual: String },

    #[error("component not found: {component}")]
    ComponentNotFound { component: &'static str },

    #[error("not found `{component}` value: `{key}`{}", .context.as_ref().map(|context| format!(" ({context})")).unwrap_or_default())]
    NotFound {
        component: &'static str,
        key: String,
        context: Option<String>,
    },

    #[error("failed to parse IRC message: {0}")]
    ParseError(#[from] IRCError),
}

impl Debug for DeError {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "IRC-DESERIALIZER[{}]: {}", self.code(), self)
    }
}

impl DeError {
    pub fn code(&self) -> &'static str {
        match self {
            Self::CommandMismatch { .. } => "COMMAND_MISMATCH",
            Self::ComponentNotFound { .. } => "COMPONENT_NOT_FOUND",
            Self::NotFound { .. } => "NOT_FOUND",
            Self::ParseError(e) => e.code(),
        }
    }

    pub fn is_parse_error(&self) -> bool {
        matches!(self, DeError::ParseError(..))
    }

    pub fn is_tags_component_not_found(&self) -> bool {
        matches!(self, DeError::ComponentNotFound { component: "tags" })
    }

    pub fn is_source_component_not_found(&self) -> bool {
        matches!(
            self,
            DeError::ComponentNotFound {
                component: "source"
            }
        )
    }

    pub fn is_param_component_not_found(&self) -> bool {
        matches!(self, DeError::ComponentNotFound { component: "param" })
    }

    pub fn is_trailing_component_not_found(&self) -> bool {
        matches!(
            self,
            DeError::ComponentNotFound {
                component: "trailing"
            }
        )
    }

    pub fn is_not_found_tag(&self) -> bool {
        matches!(
            self,
            DeError::NotFound {
                component: "tag",
                ..
            }
        )
    }

    pub fn is_not_found_source(&self) -> bool {
        matches!(
            self,
            DeError::NotFound {
                component: "source",
                ..
            }
        )
    }

    pub fn is_not_found_param(&self) -> bool {
        matches!(
            self,
            DeError::NotFound {
                component: "param",
                ..
            }
        )
    }

    pub fn is_not_found_command(&self) -> bool {
        matches!(
            self,
            DeError::NotFound {
                component: "command",
                ..
            }
        )
    }

    pub fn is_not_found_trailing(&self) -> bool {
        matches!(
            self,
            DeError::NotFound {
                component: "trailing",
                ..
            }
        )
    }

    pub fn is_command_mismatch(&self) -> bool {
        matches!(self, DeError::CommandMismatch { .. })
    }

    pub fn command_mismatch(expected: impl Into<String>, actual: impl Into<String>) -> Self {
        Self::CommandMismatch {
            expected: expected.into(),
            actual: actual.into(),
        }
    }

    pub fn tags_component_not_found() -> Self {
        Self::ComponentNotFound { component: "tags" }
    }

    pub fn source_component_not_found() -> Self {
        Self::ComponentNotFound {
            component: "source",
        }
    }

    pub fn param_component_not_found() -> Self {
        Self::ComponentNotFound { component: "param" }
    }

    pub fn not_found(component: &'static str, key: impl Into<String>) -> Self {
        Self::NotFound {
            component,
            key: key.into(),
            context: None,
        }
    }

    pub fn not_found_with_context(
        component: &'static str,
        key: impl Into<String>,
        context: impl Into<String>,
    ) -> Self {
        Self::NotFound {
            component,
            key: key.into(),
            context: Some(context.into()),
        }
    }

    pub fn not_found_tag(key: impl Into<String>) -> Self {
        Self::not_found("tag", key)
    }

    pub fn not_found_source(component: &'static str) -> Self {
        Self::not_found("source", component)
    }

    pub fn not_found_param(index: usize) -> Self {
        Self::not_found("param", index.to_string())
    }

    pub fn not_found_trailing() -> Self {
        Self::ComponentNotFound {
            component: "trailing",
        }
    }

    pub fn not_found_variant(
        component: &'static str,
        actual: impl Into<String>,
        expected: impl Into<String>,
    ) -> Self {
        Self::not_found_with_context(
            component,
            actual,
            format!("expected one of: {}", expected.into()),
        )
    }
}