http-date 0.1.0

Parsing and formatting of HTTP date values (RFC 9110)
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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
//! Parsing and formatting of HTTP date values as defined in
//! [RFC 9110 § 5.6.7](https://www.rfc-editor.org/rfc/rfc9110#section-5.6.7).
//!
//! An HTTP date can appear in one of three formats — IMF-fixdate, RFC 850, or
//! asctime. Use [`decode`] to parse a value into a [`HttpDate`]:
//!
//! ```
//! use http_date::{decode, HttpDate};
//!
//! let date = decode("Sun, 06 Nov 1994 08:49:37 GMT")
//!     .expect("valid IMF-fixdate");
//! assert!(date.is_imf_fixdate());
//! ```
//!
//! Values can also be constructed directly from components:
//!
//! ```
//! use http_date::{Date, DateTime, DayName, HttpDate, Time, encode};
//!
//! fn datetime(year: i32) -> DateTime {
//!     DateTime {
//!         dayname: DayName::Sun,
//!         date: Date::new(year, 11, 6).expect("valid date"),
//!         time: Time::new(8, 49, 37).expect("valid time"),
//!     }
//! }
//!
//! let imf = HttpDate::imf_fixdate(datetime(1994));
//! assert!(imf.is_imf_fixdate());
//!
//! // RFC 850 uses a two-digit year; construction rejects anything larger.
//! let rfc850 = HttpDate::rfc850(datetime(94)).expect("year is 0-99");
//! assert!(rfc850.is_rfc850());
//!
//! let asctime = HttpDate::asctime(datetime(1994));
//! assert!(asctime.is_asctime());
//!
//! assert_eq!(encode(&imf), "Sun, 06 Nov 1994 08:49:37 GMT");
//! assert_eq!(encode(&rfc850), "Sunday, 06-Nov-94 08:49:37 GMT");
//! assert_eq!(encode(&asctime), "Sun Nov  6 08:49:37 1994");
//! ```
//!
//! The decoded components are available on the [`DateTime`] inside the
//! returned [`HttpDate`].

use std::fmt;
#[cfg(feature = "chrono")]
pub mod chrono;

#[derive(Debug, PartialEq, Eq, Clone, Copy)]
enum DayNameTok {
    Short(DayName),
    Long(DayName),
}

/// The day of the week as used in HTTP date values.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum DayName {
    /// Monday.
    Mon,
    /// Tuesday.
    Tue,
    /// Wednesday.
    Wed,
    /// Thursday.
    Thu,
    /// Friday.
    Fri,
    /// Saturday.
    Sat,
    /// Sunday.
    Sun,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy)]
enum PunctuationTok {
    Comma,
    Space,
}

/// The calendar date portion of an HTTP date.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct Date {
    /// The year, e.g. `1994`.
    year: i32,
    /// The month, 1–12, where 1 is January.
    month: i32,
    /// The day of the month, 1–31.
    day: i32,
}

impl Date {
    /// Constructs a date.
    ///
    /// # Errors
    ///
    /// Returns a [`DecodeError`] if a component is out of range: year 0–9999,
    /// month 1–12, day 1–31.
    pub fn new(year: i32, month: i32, day: i32) -> Result<Self, DecodeError> {
        if !(0..=9999).contains(&year) || !(1..=12).contains(&month) || !(1..=31).contains(&day) {
            return Err(DecodeError::new("Date out of range"));
        }
        Ok(Self { year, month, day })
    }

    #[must_use]
    pub fn year(&self) -> i32 {
        self.year
    }

    #[must_use]
    pub fn month(&self) -> i32 {
        self.month
    }

    #[must_use]
    pub fn day(&self) -> i32 {
        self.day
    }
}

/// The time-of-day portion of an HTTP date.
///
/// Constructed with [`Time::new`], which enforces the valid ranges, so a
/// `Time` value is always well-formed (hour 0–23, minute/second 0–59).
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct Time {
    /// The hour, 0–23.
    hour: i32,
    /// The minute, 0–59.
    minute: i32,
    /// The second, 0–59.
    second: i32,
}

impl Time {
    /// Constructs a time.
    ///
    /// # Errors
    ///
    /// Returns a [`DecodeError`] if a component is out of range: hour 0–23,
    /// minute 0–59, second 0–59.
    pub fn new(hour: i32, minute: i32, second: i32) -> Result<Self, DecodeError> {
        if !(0..=23).contains(&hour) || !(0..=59).contains(&minute) || !(0..=59).contains(&second) {
            return Err(DecodeError::new("Time out of range"));
        }
        Ok(Self {
            hour,
            minute,
            second,
        })
    }

    #[must_use]
    pub fn hour(&self) -> i32 {
        self.hour
    }

    #[must_use]
    pub fn minute(&self) -> i32 {
        self.minute
    }

    #[must_use]
    pub fn second(&self) -> i32 {
        self.second
    }
}

/// A fully decoded HTTP date: weekday, calendar date, and time of day.
///
/// This is the value carried by the [`HttpDate`] variants.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct DateTime {
    /// The day of the week.
    pub dayname: DayName,
    /// The calendar date.
    pub date: Date,
    /// The time of day.
    pub time: Time,
}

/// An HTTP date in one of the three formats defined in
/// [RFC 9110 § 5.6.7](https://www.rfc-editor.org/rfc/rfc9110#section-5.6.7).
///
/// Values are created with [`HttpDate::imf_fixdate`], [`HttpDate::rfc850`],
/// and [`HttpDate::asctime`], or parsed with [`decode`]. Construction
/// guarantees the components are always in range, so [`encode`] never fails.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct HttpDate {
    format: Format,
    dt: DateTime,
}

/// The textual format of an [`HttpDate`].
///
/// Private: `HttpDate` is constructor-only, so the RFC 850 two-digit-year
/// invariant can be enforced at construction.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
enum Format {
    ImfFixdate,
    Rfc850,
    Asctime,
}

impl HttpDate {
    /// Constructs an IMF-fixdate, e.g. `Sun, 06 Nov 1994 08:49:37 GMT`.
    #[must_use]
    pub fn imf_fixdate(dt: DateTime) -> Self {
        Self {
            format: Format::ImfFixdate,
            dt,
        }
    }

    /// Constructs an RFC 850 date, e.g. `Sunday, 06-Nov-94 08:49:37 GMT`.
    ///
    /// The year must be in the range 0–99.
    ///
    /// # Errors
    ///
    /// Returns a [`DecodeError`] if the year is outside 0–99, which cannot be
    /// represented in RFC 850's two-digit-year format.
    pub fn rfc850(dt: DateTime) -> Result<Self, DecodeError> {
        if !(0..=99).contains(&dt.date.year) {
            return Err(DecodeError::new("RFC 850 year out of range (0-99)"));
        }
        Ok(Self {
            format: Format::Rfc850,
            dt,
        })
    }

    /// Constructs an asctime date, e.g. `Sun Nov  6 08:49:37 1994`.
    #[must_use]
    pub fn asctime(dt: DateTime) -> Self {
        Self {
            format: Format::Asctime,
            dt,
        }
    }

    /// Returns the [`DateTime`] components of this HTTP date.
    #[must_use]
    pub fn datetime(&self) -> &DateTime {
        &self.dt
    }

    #[must_use]
    pub fn is_imf_fixdate(&self) -> bool {
        self.format == Format::ImfFixdate
    }

    #[must_use]
    pub fn is_rfc850(&self) -> bool {
        self.format == Format::Rfc850
    }

    #[must_use]
    pub fn is_asctime(&self) -> bool {
        self.format == Format::Asctime
    }
}

/* ------------------- decoder ------------------- */
/// An error returned when an HTTP date cannot be parsed.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DecodeError(String);

impl DecodeError {
    /// Constructs a new decode error with the given message.
    pub fn new(msg: impl Into<String>) -> Self {
        Self(msg.into())
    }
}

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

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

/// A streaming parser for HTTP date values, used internally by [`decode`].
struct Decoder<'a> {
    buf: &'a str,
    pos: usize,
}

impl Decoder<'_> {
    fn new(buf: &str) -> Decoder<'_> {
        Decoder { buf, pos: 0 }
    }

    #[inline]
    fn advance(&mut self, n: usize) {
        self.pos += n;
    }

    #[inline]
    fn byte_at(&self, idx: usize) -> Result<u8, DecodeError> {
        self.buf
            .as_bytes()
            .get(idx)
            .copied()
            .ok_or_else(|| DecodeError::new("Unexpected end of input"))
    }

    fn expect(&mut self, expected: u8) -> Result<(), DecodeError> {
        let actual = self.byte_at(self.pos)?;
        if actual == expected {
            self.advance(1);
            Ok(())
        } else {
            Err(DecodeError::new(format!(
                "Expected byte {}, but found {}",
                expected as char, actual as char
            )))
        }
    }

    #[inline]
    fn space(&mut self) -> Result<(), DecodeError> {
        self.expect(b' ')
    }

    #[inline]
    fn comma(&mut self) -> Result<(), DecodeError> {
        self.expect(b',')
    }

    #[inline]
    fn colon(&mut self) -> Result<(), DecodeError> {
        self.expect(b':')
    }

    fn month(&mut self) -> Result<i32, DecodeError> {
        let m = self
            .buf
            .get(self.pos..self.pos + 3)
            .ok_or_else(|| DecodeError::new("Unexpected end of input"))?;
        let n = match m {
            "Jan" => 1,
            "Feb" => 2,
            "Mar" => 3,
            "Apr" => 4,
            "May" => 5,
            "Jun" => 6,
            "Jul" => 7,
            "Aug" => 8,
            "Sep" => 9,
            "Oct" => 10,
            "Nov" => 11,
            "Dec" => 12,
            _ => {
                return Err(DecodeError::new(format!("Invalid month value: {m}")));
            }
        };
        self.advance(3);
        Ok(n)
    }

    fn digits(&mut self, n: usize) -> Result<i32, DecodeError> {
        let buf = self.buf.as_bytes();
        let mut value: i32 = 0;
        for i in 0..n {
            let pos = self.pos + i;
            match buf.get(pos) {
                Some(&c @ b'0'..=b'9') => {
                    value = value * 10 + i32::from(c - b'0');
                }
                Some(&c) => {
                    return Err(DecodeError::new(format!(
                        "Expected digit at position {}, but found {}",
                        pos, c as char
                    )));
                }
                None => return Err(DecodeError::new("Unexpected end of input")),
            }
        }
        self.advance(n);
        Ok(value)
    }

    fn year(&mut self) -> Result<i32, DecodeError> {
        self.digits(4)
    }

    fn day(&mut self) -> Result<i32, DecodeError> {
        self.digits(2)
    }

    fn string(&mut self) -> String {
        let mut out = String::with_capacity(5);
        while self.pos < self.buf.len() {
            let c = self.buf.as_bytes()[self.pos];
            if !c.is_ascii_alphabetic() {
                break;
            }
            out.push(c as char);
            self.advance(1);
        }
        out
    }

    fn dayname_tok(&mut self) -> Result<DayNameTok, DecodeError> {
        let s = self.string();
        let dayname = match s.as_str() {
            "Mon" => DayNameTok::Short(DayName::Mon),
            "Tue" => DayNameTok::Short(DayName::Tue),
            "Wed" => DayNameTok::Short(DayName::Wed),
            "Thu" => DayNameTok::Short(DayName::Thu),
            "Fri" => DayNameTok::Short(DayName::Fri),
            "Sat" => DayNameTok::Short(DayName::Sat),
            "Sun" => DayNameTok::Short(DayName::Sun),
            "Monday" => DayNameTok::Long(DayName::Mon),
            "Tuesday" => DayNameTok::Long(DayName::Tue),
            "Wednesday" => DayNameTok::Long(DayName::Wed),
            "Thursday" => DayNameTok::Long(DayName::Thu),
            "Friday" => DayNameTok::Long(DayName::Fri),
            "Saturday" => DayNameTok::Long(DayName::Sat),
            "Sunday" => DayNameTok::Long(DayName::Sun),
            _ => return Err(DecodeError::new(format!("Invalid day name: {s}"))),
        };
        Ok(dayname)
    }

    fn punctuation_tok(&mut self) -> Result<PunctuationTok, DecodeError> {
        let c = self.byte_at(self.pos)?;
        let tok = match c {
            b',' => PunctuationTok::Comma,
            b' ' => PunctuationTok::Space,
            _ => {
                return Err(DecodeError::new(format!(
                    "Expected punctuation at position {}, but found {}",
                    self.pos, c as char
                )));
            }
        };
        self.advance(1);
        Ok(tok)
    }

    fn date1(&mut self) -> Result<Date, DecodeError> {
        let day = self.day()?;
        self.space()?;
        let month = self.month()?;
        self.space()?;
        let year = self.year()?;
        Date::new(year, month, day)
    }

    fn time(&mut self) -> Result<Time, DecodeError> {
        let hour = self.digits(2)?;
        self.colon()?;
        let minute = self.digits(2)?;
        self.colon()?;
        let second = self.digits(2)?;
        Time::new(hour, minute, second)
    }

    fn gmt(&mut self) -> Result<(), DecodeError> {
        let s = self.string();
        if s != "GMT" {
            return Err(DecodeError::new(format!("Expected 'GMT', but found '{s}'")));
        }
        Ok(())
    }

    // IMF-fixdate: day-name "," SP date1 SP time SP "GMT"
    fn imf_fixdate(&mut self, dayname: DayName) -> Result<HttpDate, DecodeError> {
        self.space()?;
        let date = self.date1()?;
        self.space()?;
        let time = self.time()?;
        self.space()?;
        self.gmt()?;
        Ok(HttpDate::imf_fixdate(DateTime {
            dayname,
            date,
            time,
        }))
    }

    fn date2(&mut self) -> Result<Date, DecodeError> {
        let day = self.day()?;
        self.expect(b'-')?;
        let month = self.month()?;
        self.expect(b'-')?;
        let year = self.digits(2)?;
        Date::new(year, month, day)
    }

    // RFC 850 date: day-name "," SP date2 SP time SP "GMT"
    fn rfc850_date(&mut self, dayname: DayName) -> Result<HttpDate, DecodeError> {
        self.comma()?;
        self.space()?;
        let date = self.date2()?;
        self.space()?;
        let time = self.time()?;
        self.space()?;
        self.gmt()?;
        let date = DateTime {
            dayname,
            date,
            time,
        };
        HttpDate::rfc850(date)
    }

    fn date3(&mut self) -> Result<(i32, i32), DecodeError> {
        // month
        let m = self.month()?;
        self.space()?;
        // day
        let d = match self.byte_at(self.pos)? {
            b' ' => {
                self.space()?;
                self.digits(1)?
            }
            _ => self.digits(2)?,
        };
        Ok((m, d))
    }

    // asctime date: day-name SP month SP (2DIGIT / (SP 1DIGIT)) SP time SP 4DIGIT
    fn asctime_date(&mut self, dayname: DayName) -> Result<HttpDate, DecodeError> {
        let (month, day) = self.date3()?;
        self.space()?;
        let time = self.time()?;
        self.space()?;
        let year = self.year()?;
        let date = Date::new(year, month, day)?;
        Ok(HttpDate::asctime(DateTime {
            dayname,
            date,
            time,
        }))
    }
}

/// Parses an HTTP date from its textual representation.
///
/// Accepts any of the three date formats defined in
/// [RFC 9110 § 5.6.7](https://www.rfc-editor.org/rfc/rfc9110#section-5.6.7):
///
/// | Format      | Example                          |
/// |-------------|----------------------------------|
/// | IMF-fixdate | `Sun, 06 Nov 1994 08:49:37 GMT`  |
/// | RFC 850     | `Sunday, 06-Nov-94 08:49:37 GMT` |
/// | asctime     | `Sun Nov  6 08:49:37 1994`       |
///
/// # Errors
///
/// Returns a [`DecodeError`] if `buf` is not a well-formed HTTP date, for
/// example when the day name or month is unknown, a required separator is
/// missing, the input is truncated, there is trailing data after the date,
/// or a component is out of range (day 1–31, hour 0–23, minute/second 0–59).
///
/// # Examples
///
/// An IMF-fixdate (the format HTTP servers must emit):
///
/// ```
/// use http_date::{decode, HttpDate};
///
/// let date = decode("Sun, 06 Nov 1994 08:49:37 GMT")
///     .expect("valid IMF-fixdate");
/// assert!(date.is_imf_fixdate());
/// ```
///
/// An RFC 850 date:
///
/// ```
/// use http_date::{decode, HttpDate};
///
/// let date = decode("Sunday, 06-Nov-94 08:49:37 GMT")
///     .expect("valid RFC 850 date");
/// assert!(date.is_rfc850());
/// ```
///
/// An asctime date:
///
/// ```
/// use http_date::{decode, HttpDate};
///
/// let date = decode("Sun Nov  6 08:49:37 1994")
///     .expect("valid asctime date");
/// assert!(date.is_asctime());
/// ```
///
/// Malformed input is rejected:
///
/// ```
/// use http_date::decode;
///
/// assert!(decode("not a date").is_err());
/// ```
pub fn decode(buf: &str) -> Result<HttpDate, DecodeError> {
    let mut decoder = Decoder::new(buf);
    let date = match decoder.dayname_tok()? {
        DayNameTok::Long(dayname) => decoder.rfc850_date(dayname),
        DayNameTok::Short(dayname) => match decoder.punctuation_tok()? {
            PunctuationTok::Comma => decoder.imf_fixdate(dayname),
            PunctuationTok::Space => decoder.asctime_date(dayname),
        },
    }?;
    // The RFC 9110 `HTTP-date` grammar spans the whole field value, so any
    // leftover input means `buf` is not a well-formed HTTP date.
    if decoder.pos != decoder.buf.len() {
        return Err(DecodeError::new(format!(
            "Trailing data after HTTP date at position {}",
            decoder.pos
        )));
    }
    Ok(date)
}

/* ------------------- encoder ------------------- */

impl DayName {
    /// The three-letter abbreviation used by IMF-fixdate and asctime, e.g. `Mon`.
    fn short(self) -> &'static str {
        match self {
            DayName::Mon => "Mon",
            DayName::Tue => "Tue",
            DayName::Wed => "Wed",
            DayName::Thu => "Thu",
            DayName::Fri => "Fri",
            DayName::Sat => "Sat",
            DayName::Sun => "Sun",
        }
    }

    /// The full name used by RFC 850 dates, e.g. `Monday`.
    fn long(self) -> &'static str {
        match self {
            DayName::Mon => "Monday",
            DayName::Tue => "Tuesday",
            DayName::Wed => "Wednesday",
            DayName::Thu => "Thursday",
            DayName::Fri => "Friday",
            DayName::Sat => "Saturday",
            DayName::Sun => "Sunday",
        }
    }
}

/// The three-letter month abbreviation, e.g. `Jan`.
fn month_name(month: i32) -> &'static str {
    match month {
        1 => "Jan",
        2 => "Feb",
        3 => "Mar",
        4 => "Apr",
        5 => "May",
        6 => "Jun",
        7 => "Jul",
        8 => "Aug",
        9 => "Sep",
        10 => "Oct",
        11 => "Nov",
        12 => "Dec",
        _ => unreachable!("month {month} is out of range 1..=12"),
    }
}

/// Formats an HTTP date as a string in its original textual format.
///
/// The output is guaranteed to parse back with [`decode`] to the same value.
/// `HttpDate` values are always well-formed — constructed via
/// [`HttpDate::imf_fixdate`], [`HttpDate::rfc850`], or [`HttpDate::asctime`],
/// or parsed with [`decode`] — so formatting cannot fail.
///
/// # Examples
///
/// ```
/// use http_date::{decode, encode};
///
/// let date = decode("Sun, 06 Nov 1994 08:49:37 GMT").unwrap();
/// assert_eq!(encode(&date), "Sun, 06 Nov 1994 08:49:37 GMT");
/// ```
#[must_use]
pub fn encode(date: &HttpDate) -> String {
    let dt = date.datetime();
    let month = month_name(dt.date.month());
    let day = dt.date.day();
    let year = dt.date.year();
    let time = dt.time;
    match date.format {
        Format::ImfFixdate => format!(
            "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT",
            dt.dayname.short(),
            day,
            month,
            year,
            time.hour(),
            time.minute(),
            time.second(),
        ),
        // `format` is private, so `Format::Rfc850` implies year <= 99 by
        // construction (`HttpDate::rfc850`).
        Format::Rfc850 => format!(
            "{}, {:02}-{}-{:02} {:02}:{:02}:{:02} GMT",
            dt.dayname.long(),
            day,
            month,
            year,
            time.hour(),
            time.minute(),
            time.second(),
        ),
        Format::Asctime => format!(
            "{} {} {:2} {:02}:{:02}:{:02} {:04}",
            dt.dayname.short(),
            month,
            day,
            time.hour(),
            time.minute(),
            time.second(),
            year,
        ),
    }
}

impl fmt::Display for HttpDate {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&encode(self))
    }
}

/* ------------------- tests ------------------- */

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn expect_matching_byte_advances_position() {
        let mut d = Decoder::new("abc");
        assert_eq!(d.expect(b'a'), Ok(()));
        assert_eq!(d.pos, 1);
    }

    #[test]
    fn expect_mismatched_byte_returns_error() {
        let mut d = Decoder::new("abc");
        let result = d.expect(b'b');
        assert!(result.is_err());
        assert_eq!(d.pos, 0); // Position should not advance on error
    }

    #[test]
    fn expect_at_end_of_input_returns_error() {
        let mut d = Decoder::new("ab");
        d.pos = 2;
        let err = d.expect(b'a').unwrap_err();
        assert_eq!(err.to_string(), "DecodeError: Unexpected end of input");
        assert_eq!(d.pos, 2);
    }

    #[test]
    fn parsing_punctuated_sequence_advances_through_input() {
        let mut d = Decoder::new("Sun, 06");
        // weekday(Sun)
        d.expect(b'S').unwrap();
        d.expect(b'u').unwrap();
        d.expect(b'n').unwrap();
        d.comma().unwrap();
        d.space().unwrap();
        // day-of-month(06)
        d.expect(b'0').unwrap();
        d.expect(b'6').unwrap();
        assert_eq!(d.pos, 7); // consumed "Sun, 06"
    }

    #[test]
    fn parsing_date_sequence_with_month_advances_through_input() {
        let mut d = Decoder::new("Sun, 06 Nov 1994");
        // weekday(Sun)
        d.expect(b'S').unwrap();
        d.expect(b'u').unwrap();
        d.expect(b'n').unwrap();
        d.comma().unwrap();
        d.space().unwrap();
        // day-of-month(06)
        assert_eq!(d.day().unwrap(), 6);
        d.space().unwrap();
        // month(Nov)
        let month = d.month().unwrap();
        assert_eq!(month, 11);
        d.space().unwrap();
        // year(1994)
        assert_eq!(d.year().unwrap(), 1994);
        assert_eq!(d.pos, 16); // consumed "Sun, 06 Nov 1994"
    }

    #[test]
    fn string_reads_alphabetic_run_and_advances() {
        let mut d = Decoder::new("Sun, 06");
        assert_eq!(d.string(), "Sun");
        assert_eq!(d.pos, 3); // consumed "Sun"
    }

    #[test]
    fn string_reads_to_end_of_input() {
        let mut d = Decoder::new("GMT");
        assert_eq!(d.string(), "GMT");
        assert_eq!(d.pos, 3); // consumed "GMT"
    }

    #[test]
    fn string_returns_empty_when_current_byte_is_not_alphabetic() {
        let mut d = Decoder::new("123");
        assert_eq!(d.string(), "");
        assert_eq!(d.pos, 0); // position should not advance
    }

    #[test]
    fn string_returns_empty_at_end_of_input() {
        let mut d = Decoder::new("Sun,");
        d.pos = 4; // position at end of input
        assert_eq!(d.string(), "");
        assert_eq!(d.pos, 4); // position should not advance
    }

    // Test cases for dayname_tok

    #[test]
    fn dayname_tok_parses_all_names() {
        let cases = [
            ("Mon", DayNameTok::Short(DayName::Mon)),
            ("Tue", DayNameTok::Short(DayName::Tue)),
            ("Wed", DayNameTok::Short(DayName::Wed)),
            ("Thu", DayNameTok::Short(DayName::Thu)),
            ("Fri", DayNameTok::Short(DayName::Fri)),
            ("Sat", DayNameTok::Short(DayName::Sat)),
            ("Sun", DayNameTok::Short(DayName::Sun)),
            ("Monday", DayNameTok::Long(DayName::Mon)),
            ("Tuesday", DayNameTok::Long(DayName::Tue)),
            ("Wednesday", DayNameTok::Long(DayName::Wed)),
            ("Thursday", DayNameTok::Long(DayName::Thu)),
            ("Friday", DayNameTok::Long(DayName::Fri)),
            ("Saturday", DayNameTok::Long(DayName::Sat)),
            ("Sunday", DayNameTok::Long(DayName::Sun)),
        ];
        for (s, expected) in cases {
            let mut d = Decoder::new(s);
            assert_eq!(d.dayname_tok(), Ok(expected), "day name {s}");
            assert_eq!(d.pos, s.len(), "pos after {s}");
        }
    }

    #[test]
    fn dayname_tok_rejects_invalid_name() {
        let mut d = Decoder::new("Funday");
        let result = d.dayname_tok();
        assert!(result.is_err());
        assert_eq!(d.pos, 6); // consumed the invalid name
    }

    #[test]
    fn dayname_tok_is_case_sensitive() {
        let mut d = Decoder::new("mon");
        let result = d.dayname_tok();
        assert!(result.is_err());
        assert_eq!(d.pos, 3); // consumed the invalid name
    }

    #[test]
    fn dayname_tok_rejects_empty_run() {
        let mut d = Decoder::new(", 06 Nov 1994");
        let result = d.dayname_tok();
        assert!(result.is_err());
        assert_eq!(d.pos, 0); // position should not advance
    }

    #[test]
    fn dayname_tok_rejects_truncated_long_name() {
        let mut d = Decoder::new("Wednes");
        let result = d.dayname_tok();
        assert!(result.is_err());
        assert_eq!(d.pos, 6); // consumed the partial name
    }

    // Test cases for punctuation_tok

    #[test]
    fn punctuation_tok_parses_comma() {
        let mut d = Decoder::new(",06 Nov");
        assert_eq!(d.punctuation_tok(), Ok(PunctuationTok::Comma));
        assert_eq!(d.pos, 1);
    }

    #[test]
    fn punctuation_tok_parses_space() {
        let mut d = Decoder::new(" 06 Nov");
        assert_eq!(d.punctuation_tok(), Ok(PunctuationTok::Space));
        assert_eq!(d.pos, 1);
    }

    #[test]
    fn punctuation_tok_rejects_non_punctuation() {
        let mut d = Decoder::new("06 Nov");
        let err = d.punctuation_tok().unwrap_err();
        assert!(
            err.to_string()
                .contains("Expected punctuation at position 0, but found 0")
        );
        assert_eq!(d.pos, 0); // position unchanged on error
    }

    #[test]
    fn punctuation_tok_at_end_of_input_returns_error() {
        let mut d = Decoder::new("06");
        d.pos = 2; // at end of input
        let err = d.punctuation_tok().unwrap_err();
        assert_eq!(err.to_string(), "DecodeError: Unexpected end of input");
        assert_eq!(d.pos, 2);
    }

    // Test cases for date1

    #[test]
    fn date1_parses_valid_date() {
        let mut d = Decoder::new("06 Nov 1994");
        assert_eq!(d.date1(), Date::new(1994, 11, 6));
        assert_eq!(d.pos, 11); // consumed "06 Nov 1994"
    }

    #[test]
    fn date1_parses_leading_zero_day() {
        let mut d = Decoder::new("01 Jan 2000");
        assert_eq!(d.date1(), Date::new(2000, 1, 1));
        assert_eq!(d.pos, 11);
    }

    #[test]
    fn date1_rejects_non_digit_day() {
        let mut d = Decoder::new("0x Nov 1994");
        let err = d.date1().unwrap_err();
        assert!(
            err.to_string()
                .contains("Expected digit at position 1, but found x")
        );
    }

    #[test]
    fn date1_rejects_missing_space_after_day() {
        let mut d = Decoder::new("06Nov 1994");
        let err = d.date1().unwrap_err();
        assert!(err.to_string().contains("but found N"));
    }

    #[test]
    fn date1_rejects_invalid_month() {
        let mut d = Decoder::new("06 Xyz 1994");
        let err = d.date1().unwrap_err();
        assert!(err.to_string().contains("Invalid month value: Xyz"));
    }

    #[test]
    fn date1_rejects_truncated_year() {
        let mut d = Decoder::new("06 Nov 19");
        let err = d.date1().unwrap_err();
        assert_eq!(err.to_string(), "DecodeError: Unexpected end of input");
    }

    #[test]
    fn time_parses_valid_time() {
        let mut d = Decoder::new("08:49:37 GMT");
        assert_eq!(d.time(), Time::new(8, 49, 37));
        assert_eq!(d.pos, 8); // consumed "08:49:37"
    }

    #[test]
    fn time_rejects_missing_colon() {
        let mut d = Decoder::new("0849:37");
        let err = d.time().unwrap_err();
        assert!(err.to_string().contains("but found 4"));
    }

    #[test]
    fn time_rejects_non_digit_minute() {
        let mut d = Decoder::new("08:x9:37");
        let err = d.time().unwrap_err();
        assert!(
            err.to_string()
                .contains("Expected digit at position 3, but found x")
        );
    }

    #[test]
    fn time_rejects_truncated_seconds() {
        let mut d = Decoder::new("08:49:3");
        let err = d.time().unwrap_err();
        assert_eq!(err.to_string(), "DecodeError: Unexpected end of input");
    }

    // Test cases for decode

    fn expect_imf_fixdate(decoded: &HttpDate) -> DateTime {
        assert!(decoded.is_imf_fixdate(), "expected ImfFixdate");
        *decoded.datetime()
    }

    fn expect_rfc850(decoded: &HttpDate) -> DateTime {
        assert!(decoded.is_rfc850(), "expected Rfc850");
        *decoded.datetime()
    }

    fn expect_asctime(decoded: &HttpDate) -> DateTime {
        assert!(decoded.is_asctime(), "expected Asctime");
        *decoded.datetime()
    }

    #[test]
    fn decode_parses_imf_fixdate() {
        let dt = expect_imf_fixdate(&decode("Sun, 06 Nov 1994 08:49:37 GMT").unwrap());
        assert_eq!(dt.dayname, DayName::Sun);
        assert_eq!(dt.date, Date::new(1994, 11, 6).unwrap());
        assert_eq!(dt.time, Time::new(8, 49, 37).unwrap());
    }

    #[test]
    fn decode_parses_rfc850_date() {
        let dt = expect_rfc850(&decode("Sunday, 06-Nov-94 08:49:37 GMT").unwrap());
        assert_eq!(dt.dayname, DayName::Sun);
        assert_eq!(dt.date, Date::new(94, 11, 6).unwrap());
        assert_eq!(dt.time, Time::new(8, 49, 37).unwrap());
    }

    #[test]
    fn decode_parses_asctime() {
        let dt = expect_asctime(&decode("Sun Nov  6 08:49:37 1994").unwrap());
        assert_eq!(dt.dayname, DayName::Sun);
        assert_eq!(dt.date, Date::new(1994, 11, 6).unwrap());
        assert_eq!(dt.time, Time::new(8, 49, 37).unwrap());
    }

    #[test]
    fn decode_parses_all_imf_fixdate_weekdays() {
        let cases = [
            ("Mon", DayName::Mon),
            ("Tue", DayName::Tue),
            ("Wed", DayName::Wed),
            ("Thu", DayName::Thu),
            ("Fri", DayName::Fri),
            ("Sat", DayName::Sat),
            ("Sun", DayName::Sun),
        ];
        for (name, dayname) in cases {
            let input = format!("{name}, 06 Nov 1994 08:49:37 GMT");
            let dt = expect_imf_fixdate(&decode(&input).unwrap());
            assert_eq!(dt.dayname, dayname, "weekday {name}");
        }
    }

    #[test]
    fn decode_rejects_invalid_dayname() {
        let err = decode("Funday, 06 Nov 1994 08:49:37 GMT").expect_err("expected decode to fail");
        assert!(err.to_string().contains("Invalid day name: Funday"));
    }

    #[test]
    fn decode_rejects_missing_punctuation() {
        // "Sun 06 Nov..." is neither ", " (IMF) nor " " after a short name
        // followed by a valid asctime; "Sun 06" fails because a month is
        // expected next.
        let err = decode("Sun 06 Nov 1994").expect_err("expected decode to fail");
        assert!(err.to_string().contains("Invalid month value: 06"));
    }

    #[test]
    fn decode_rejects_imf_fixdate_missing_gmt() {
        let err = decode("Sun, 06 Nov 1994 08:49:37 ").expect_err("expected decode to fail");
        assert!(err.to_string().contains("Expected 'GMT', but found ''"));
    }

    #[test]
    fn decode_rejects_truncated_input() {
        let err = decode("Sun, 06 Nov").expect_err("expected decode to fail");
        assert_eq!(err.to_string(), "DecodeError: Unexpected end of input");
    }

    #[test]
    fn decode_rejects_empty_input() {
        let err = decode("").expect_err("expected decode to fail");
        assert_eq!(err.to_string(), "DecodeError: Invalid day name: ");
    }

    #[test]
    fn decode_rejects_trailing_data() {
        for input in [
            "Sun, 06 Nov 1994 08:49:37 GMT ",
            "Sun, 06 Nov 1994 08:49:37 GMT 123",
            "Sun, 06 Nov 1994 08:49:37 GMT.",
            "Sunday, 06-Nov-94 08:49:37 GMT extra",
            "Sun Nov  6 08:49:37 1994!",
        ] {
            let err = decode(input)
                .err()
                .unwrap_or_else(|| panic!("expected {input:?} to be rejected"));
            assert!(
                err.to_string().contains("Trailing data"),
                "{input:?} failed for a different reason: {err}"
            );
        }
    }

    #[test]
    fn decode_rejects_out_of_range_components() {
        for input in [
            "Sun, 00 Nov 1994 08:49:37 GMT",
            "Sun, 32 Nov 1994 08:49:37 GMT",
            "Sunday, 32-Nov-94 08:49:37 GMT",
            "Sun Nov 32 08:49:37 1994",
            "Sun Nov  0 08:49:37 1994", // asctime single-digit day 0
            "Sun, 06 Nov 1994 24:49:37 GMT",
            "Sun, 06 Nov 1994 08:60:37 GMT",
            "Sun, 06 Nov 1994 08:49:60 GMT",
        ] {
            let err = decode(input)
                .err()
                .unwrap_or_else(|| panic!("expected {input:?} to be rejected"));
            assert!(
                err.to_string().contains("out of range"),
                "{input:?} failed for a different reason: {err}"
            );
        }
    }

    #[test]
    fn decode_accepts_boundary_components() {
        assert!(decode("Sun, 31 Nov 1994 08:49:37 GMT").is_ok());
        assert!(decode("Sun, 06 Nov 1994 23:59:59 GMT").is_ok());
    }

    // A fixed valid `DateTime` used by the constructor tests below.
    fn sun_nov_6(year: i32) -> DateTime {
        DateTime {
            dayname: DayName::Sun,
            date: Date::new(year, 11, 6).unwrap(),
            time: Time::new(8, 49, 37).unwrap(),
        }
    }

    #[test]
    fn date_new_rejects_out_of_range() {
        assert!(Date::new(1994, 11, 6).is_ok());
        assert!(Date::new(-1, 11, 6).is_err());
        assert!(Date::new(10_000, 11, 6).is_err());
        assert!(Date::new(1994, 0, 6).is_err());
        assert!(Date::new(1994, 13, 6).is_err());
        assert!(Date::new(1994, 11, 0).is_err());
        assert!(Date::new(1994, 11, 32).is_err());
    }

    #[test]
    fn time_new_rejects_out_of_range() {
        assert!(Time::new(8, 49, 37).is_ok());
        assert!(Time::new(24, 0, 0).is_err());
        assert!(Time::new(0, 60, 0).is_err());
        assert!(Time::new(0, 0, 60).is_err());
        assert!(Time::new(-1, 0, 0).is_err());
    }

    #[test]
    fn rfc850_constructor_rejects_year_above_99() {
        assert!(HttpDate::rfc850(sun_nov_6(99)).is_ok());
        assert!(HttpDate::rfc850(sun_nov_6(100)).is_err());
        assert!(HttpDate::rfc850(sun_nov_6(1994)).is_err());
    }

    #[test]
    fn encode_round_trips_constructed_values() {
        let cases = [
            HttpDate::imf_fixdate(sun_nov_6(1994)),
            HttpDate::rfc850(sun_nov_6(94)).unwrap(),
            HttpDate::asctime(sun_nov_6(1994)),
        ];
        for date in cases {
            let s = encode(&date);
            assert_eq!(decode(&s).unwrap(), date, "encode produced {s:?}");
        }
    }
}