rfc1939 0.1.0

Parsing RFC 1939 (i.e. POP3) data streams
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
use crate::common::StatusIndicator;

/// Greeting
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Greeting<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

/// Quit
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Quit<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

#[derive(Debug, PartialEq)]
pub struct OneLineTwoParts<'a> {
    pub left: StatusIndicator,
    pub right: &'a [u8],
}

impl Default for OneLineTwoParts<'_> {
    fn default() -> Self {
        OneLineTwoParts {
            left: StatusIndicator::OK,
            right: &[],
        }
    }
}

impl Default for Quit<'_> {
    fn default() -> Self {
        Quit {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl Default for Greeting<'_> {
    fn default() -> Self {
        Greeting {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

pub trait OneLine<'a>: Default {
    fn status_indicator(&self) -> &StatusIndicator;
    fn set_status_indicator(&mut self, si: StatusIndicator);

    fn information(&self) -> &[u8];
    fn set_information(&mut self, information: &'a [u8]);
}

impl<'a> OneLine<'a> for Greeting<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}

impl<'a> OneLine<'a> for Quit<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, message: &'a [u8]) {
        self.information = message;
    }
}

impl<'a> OneLine<'a> for OneLineTwoParts<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.left
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.left = si;
    }

    fn information(&self) -> &[u8] {
        &self.right
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.right = information;
    }
}

/// STAT
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// usize, the number of messages in the maildrop
/// usize, the size of the maildrop in octets
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Stat<'a> {
    pub status_indicator: StatusIndicator,
    pub number_of_messages: usize,
    pub size_in_octets: usize,
    pub information: &'a [u8],
}

// -- Code Block in which item have a list contains paired informations.
// ################################################################################

/// LIST [msg]
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// Vec<(usize, usize)>, A vector containing tuple in which
///     left usize is message-number and
///     right usize is size of the message in octets
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct List<'a> {
    pub status_indicator: StatusIndicator,
    pub informations: Vec<(usize, usize)>,
    pub information: &'a [u8],
}

/// UIDL [msg]
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// Vec<(usize, usize)>, A vector containing tuple in which
///     left usize is message-number and
///     right usize is size of the message in octets
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Uidl<'a> {
    pub status_indicator: StatusIndicator,
    pub informations: Vec<(usize, &'a [u8])>,
    pub information: &'a [u8],
}

// ################################################################################
// -- Code Block in which item have a list contains paired informations. --

// -- Code Block in which item have email body.
// ################################################################################
// Both RETR and TOP may have a email body.
pub trait HaveMessageBody<'a>: Default {
    fn set_status_indicator(&mut self, si: StatusIndicator);
    fn set_message(&mut self, message: Option<&'a [u8]>);
    fn set_information(&mut self, information: &'a [u8]);
}
/// RETR msg
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], A slice containing message body
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Retr<'a> {
    pub status_indicator: StatusIndicator,
    pub message: Option<&'a [u8]>,
    pub information: &'a [u8],
}

impl Default for Retr<'_> {
    fn default() -> Self {
        Retr {
            status_indicator: StatusIndicator::OK,
            message: None,
            information: &[],
        }
    }
}

impl<'a> HaveMessageBody<'a> for Retr<'a> {
    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }
    fn set_message(&mut self, msg: Option<&'a [u8]>) {
        self.message = msg;
    }
    fn set_information(&mut self, info: &'a [u8]) {
        self.information = info;
    }
}

/// TOP msg n
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], A slice containing message body
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Top<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
    pub message: Option<&'a [u8]>,
}

impl Default for Top<'_> {
    fn default() -> Self {
        Top {
            status_indicator: StatusIndicator::OK,
            information: &[],
            message: None,
        }
    }
}

impl<'a> HaveMessageBody<'a> for Top<'a> {
    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }
    fn set_message(&mut self, msg: Option<&'a [u8]>) {
        self.message = msg;
    }
    fn set_information(&mut self, info: &'a [u8]) {
        self.information = info;
    }
}

// ################################################################################
// -- Code Block in which item have email body. --

/// DELE msg
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Dele<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

impl Default for Dele<'_> {
    fn default() -> Self {
        Dele {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl<'a> OneLine<'a> for Dele<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}

/// NOOP
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Noop<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

impl Default for Noop<'_> {
    fn default() -> Self {
        Noop {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl<'a> OneLine<'a> for Noop<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}

/// RSET
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Rset<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

impl Default for Rset<'_> {
    fn default() -> Self {
        Rset {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl<'a> OneLine<'a> for Rset<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}

/// USER
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct User<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

impl Default for User<'_> {
    fn default() -> Self {
        User {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl<'a> OneLine<'a> for User<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}

/// PASS
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Pass<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

impl Default for Pass<'_> {
    fn default() -> Self {
        Pass {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl<'a> OneLine<'a> for Pass<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}

/// APOP
/// StatusIndicator, Status Indicator stand for +OK/-ERR
/// &[u8], message
#[derive(Debug, PartialEq)]
pub struct Apop<'a> {
    pub status_indicator: StatusIndicator,
    pub information: &'a [u8],
}

impl Default for Apop<'_> {
    fn default() -> Self {
        Apop {
            status_indicator: StatusIndicator::OK,
            information: &[],
        }
    }
}

impl<'a> OneLine<'a> for Apop<'a> {
    fn status_indicator(&self) -> &StatusIndicator {
        &self.status_indicator
    }

    fn set_status_indicator(&mut self, si: StatusIndicator) {
        self.status_indicator = si;
    }

    fn information(&self) -> &[u8] {
        &self.information
    }

    fn set_information(&mut self, information: &'a [u8]) {
        self.information = information;
    }
}