jiff/fmt/rfc2822.rs
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 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
/*!
Support for printing and parsing instants using the [RFC 2822] datetime format.
RFC 2822 is most commonly found when dealing with email messages.
Since RFC 2822 only supports specifying a complete instant in time, the parser
and printer in this module only use [`Zoned`] and [`Timestamp`]. If you need
inexact time, you can get it from [`Zoned`] via [`Zoned::datetime`].
[RFC 2822]: https://datatracker.ietf.org/doc/html/rfc2822
# Incomplete support
The RFC 2822 support in this crate is technically incomplete. Specifically,
it does not support parsing comments within folding whitespace. It will parse
comments after the datetime itself (including nested comments). See [Issue
#39][issue39] for an example. If you find a real world use case for parsing
comments within whitespace at any point in the datetime string, please file
an issue. That is, the main reason it isn't currently supported is because
it didn't seem worth the implementation complexity to account for it. But if
there are real world use cases that need it, then that would be sufficient
justification for adding it.
RFC 2822 support should otherwise be complete, including support for parsing
obselete offsets.
[issue39]: https://github.com/BurntSushi/jiff/issues/39
# Warning
The RFC 2822 format only supports writing a precise instant in time
expressed via a time zone offset. It does *not* support serializing
the time zone itself. This means that if you format a zoned datetime
in a time zone like `America/New_York` and then deserialize it, the
zoned datetime you get back will be a "fixed offset" zoned datetime.
This in turn means it will not perform daylight saving time safe
arithmetic.
Basically, you should use the RFC 2822 format if it's required (for
example, when dealing with email). But you should not choose it as a
general interchange format for new applications.
*/
use crate::{
civil::{Date, DateTime, Time, Weekday},
error::{err, ErrorContext},
fmt::{util::DecimalFormatter, Parsed, Write, WriteExt},
tz::{Offset, TimeZone},
util::{
escape, parse,
rangeint::{ri8, RFrom},
t::{self, C},
},
Error, Timestamp, Zoned,
};
/// The default date time parser that we use throughout Jiff.
pub(crate) static DEFAULT_DATETIME_PARSER: DateTimeParser =
DateTimeParser::new();
/// The default date time printer that we use throughout Jiff.
pub(crate) static DEFAULT_DATETIME_PRINTER: DateTimePrinter =
DateTimePrinter::new();
/// Convert a [`Zoned`] to an [RFC 2822] datetime string.
///
/// This is a convenience function for using [`DateTimePrinter`]. In
/// particular, this always creates and allocates a new `String`. For writing
/// to an existing string, or converting a [`Timestamp`] to an RFC 2822
/// datetime string, you'll need to use `DateTimePrinter`.
///
/// [RFC 2822]: https://datatracker.ietf.org/doc/html/rfc2822
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Errors
///
/// This returns an error if the year corresponding to this timestamp cannot be
/// represented in the RFC 2822 format. For example, a negative year.
///
/// # Example
///
/// This example shows how to convert a zoned datetime to the RFC 2822 format:
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822};
///
/// let zdt = date(2024, 6, 15).at(7, 0, 0, 0).in_tz("Australia/Tasmania")?;
/// assert_eq!(rfc2822::to_string(&zdt)?, "Sat, 15 Jun 2024 07:00:00 +1000");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[cfg(feature = "alloc")]
#[inline]
pub fn to_string(zdt: &Zoned) -> Result<alloc::string::String, Error> {
let mut buf = alloc::string::String::new();
DEFAULT_DATETIME_PRINTER.print_zoned(zdt, &mut buf)?;
Ok(buf)
}
/// Parse an [RFC 2822] datetime string into a [`Zoned`].
///
/// This is a convenience function for using [`DateTimeParser`]. In particular,
/// this takes a `&str` while the `DateTimeParser` accepts a `&[u8]`.
/// Moreover, if any configuration options are added to RFC 2822 parsing (none
/// currently exist at time of writing), then it will be necessary to use a
/// `DateTimeParser` to toggle them. Additionally, a `DateTimeParser` is needed
/// for parsing into a [`Timestamp`].
///
/// [RFC 2822]: https://datatracker.ietf.org/doc/html/rfc2822
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Errors
///
/// This returns an error if the datetime string given is invalid or if it
/// is valid but doesn't fit in the datetime range supported by Jiff. For
/// example, RFC 2822 supports offsets up to 99 hours and 59 minutes,
/// but Jiff's maximum offset is 25 hours, 59 minutes and 59 seconds.
///
/// # Example
///
/// This example shows how serializing a zoned datetime to RFC 2822 format
/// and then deserializing will drop information:
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822};
///
/// let zdt = date(2024, 7, 13)
/// .at(15, 9, 59, 789_000_000)
/// .in_tz("America/New_York")?;
/// // The default format (i.e., Temporal) guarantees lossless
/// // serialization.
/// assert_eq!(zdt.to_string(), "2024-07-13T15:09:59.789-04:00[America/New_York]");
///
/// let rfc2822 = rfc2822::to_string(&zdt)?;
/// // Notice that the time zone name and fractional seconds have been dropped!
/// assert_eq!(rfc2822, "Sat, 13 Jul 2024 15:09:59 -0400");
/// // And of course, if we parse it back, all that info is still lost.
/// // Which means this `zdt` cannot do DST safe arithmetic!
/// let zdt = rfc2822::parse(&rfc2822)?;
/// assert_eq!(zdt.to_string(), "2024-07-13T15:09:59-04:00[-04:00]");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[inline]
pub fn parse(string: &str) -> Result<Zoned, Error> {
DEFAULT_DATETIME_PARSER.parse_zoned(string)
}
/// A parser for [RFC 2822] datetimes.
///
/// [RFC 2822]: https://datatracker.ietf.org/doc/html/rfc2822
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Example
///
/// This example shows how serializing a zoned datetime to RFC 2822 format
/// and then deserializing will drop information:
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822};
///
/// let zdt = date(2024, 7, 13)
/// .at(15, 9, 59, 789_000_000)
/// .in_tz("America/New_York")?;
/// // The default format (i.e., Temporal) guarantees lossless
/// // serialization.
/// assert_eq!(zdt.to_string(), "2024-07-13T15:09:59.789-04:00[America/New_York]");
///
/// let rfc2822 = rfc2822::to_string(&zdt)?;
/// // Notice that the time zone name and fractional seconds have been dropped!
/// assert_eq!(rfc2822, "Sat, 13 Jul 2024 15:09:59 -0400");
/// // And of course, if we parse it back, all that info is still lost.
/// // Which means this `zdt` cannot do DST safe arithmetic!
/// let zdt = rfc2822::parse(&rfc2822)?;
/// assert_eq!(zdt.to_string(), "2024-07-13T15:09:59-04:00[-04:00]");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[derive(Debug)]
pub struct DateTimeParser {
relaxed_weekday: bool,
}
impl DateTimeParser {
/// Create a new RFC 2822 datetime parser with the default configuration.
#[inline]
pub const fn new() -> DateTimeParser {
DateTimeParser { relaxed_weekday: false }
}
/// When enabled, parsing will permit the weekday to be inconsistent with
/// the date. When enabled, the weekday is still parsed and can result in
/// an error if it isn't _a_ valid weekday. Only the error checking for
/// whether it is _the_ correct weekday for the parsed date is disabled.
///
/// This is sometimes useful for interaction with systems that don't do
/// strict error checking.
///
/// This is disabled by default. And note that RFC 2822 compliance requires
/// that the weekday is consistent with the date.
///
/// # Example
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822};
///
/// let string = "Sun, 13 Jul 2024 15:09:59 -0400";
/// // The above normally results in an error, since 2024-07-13 is a
/// // Saturday:
/// assert!(rfc2822::parse(string).is_err());
/// // But we can relax the error checking:
/// static P: rfc2822::DateTimeParser = rfc2822::DateTimeParser::new()
/// .relaxed_weekday(true);
/// assert_eq!(
/// P.parse_zoned(string)?,
/// date(2024, 7, 13).at(15, 9, 59, 0).in_tz("America/New_York")?,
/// );
/// // But note that something that isn't recognized as a valid weekday
/// // will still result in an error:
/// assert!(P.parse_zoned("Wat, 13 Jul 2024 15:09:59 -0400").is_err());
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[inline]
pub const fn relaxed_weekday(self, yes: bool) -> DateTimeParser {
DateTimeParser { relaxed_weekday: yes, ..self }
}
/// Parse a datetime string into a [`Zoned`] value.
///
/// Note that RFC 2822 does not support time zone annotations. The zoned
/// datetime returned will therefore always have a fixed offset time zone.
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Errors
///
/// This returns an error if the datetime string given is invalid or if it
/// is valid but doesn't fit in the datetime range supported by Jiff. For
/// example, RFC 2822 supports offsets up to 99 hours and 59 minutes,
/// but Jiff's maximum offset is 25 hours, 59 minutes and 59 seconds.
///
/// # Example
///
/// This shows a basic example of parsing a `Timestamp` from an RFC 2822
/// datetime string.
///
/// ```
/// use jiff::fmt::rfc2822::DateTimeParser;
///
/// static PARSER: DateTimeParser = DateTimeParser::new();
///
/// let zdt = PARSER.parse_zoned("Thu, 29 Feb 2024 05:34 -0500")?;
/// assert_eq!(zdt.to_string(), "2024-02-29T05:34:00-05:00[-05:00]");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn parse_zoned<I: AsRef<[u8]>>(
&self,
input: I,
) -> Result<Zoned, Error> {
let input = input.as_ref();
let zdt = self
.parse_zoned_internal(input)
.context(
"failed to parse RFC 2822 datetime into Jiff zoned datetime",
)?
.into_full()?;
Ok(zdt)
}
/// Parse an RFC 2822 datetime string into a [`Timestamp`].
///
/// # Errors
///
/// This returns an error if the datetime string given is invalid or if it
/// is valid but doesn't fit in the datetime range supported by Jiff. For
/// example, RFC 2822 supports offsets up to 99 hours and 59 minutes,
/// but Jiff's maximum offset is 25 hours, 59 minutes and 59 seconds.
///
/// # Example
///
/// This shows a basic example of parsing a `Timestamp` from an RFC 2822
/// datetime string.
///
/// ```
/// use jiff::fmt::rfc2822::DateTimeParser;
///
/// static PARSER: DateTimeParser = DateTimeParser::new();
///
/// let timestamp = PARSER.parse_timestamp("Thu, 29 Feb 2024 05:34 -0500")?;
/// assert_eq!(timestamp.to_string(), "2024-02-29T10:34:00Z");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn parse_timestamp<I: AsRef<[u8]>>(
&self,
input: I,
) -> Result<Timestamp, Error> {
let input = input.as_ref();
let ts = self
.parse_timestamp_internal(input)
.context("failed to parse RFC 2822 datetime into Jiff timestamp")?
.into_full()?;
Ok(ts)
}
/// Parses an RFC 2822 datetime as a zoned datetime.
///
/// Note that this doesn't check that the input has been completely
/// consumed.
#[inline(always)]
fn parse_zoned_internal<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, Zoned>, Error> {
let Parsed { value: (dt, offset), input } =
self.parse_datetime_offset(input)?;
let ts = offset
.to_timestamp(dt)
.context("RFC 2822 datetime out of Jiff's range")?;
let zdt = ts.to_zoned(TimeZone::fixed(offset));
Ok(Parsed { value: zdt, input })
}
/// Parses an RFC 2822 datetime as a timestamp.
///
/// Note that this doesn't check that the input has been completely
/// consumed.
#[inline(always)]
fn parse_timestamp_internal<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, Timestamp>, Error> {
let Parsed { value: (dt, offset), input } =
self.parse_datetime_offset(input)?;
let ts = offset
.to_timestamp(dt)
.context("RFC 2822 datetime out of Jiff's range")?;
Ok(Parsed { value: ts, input })
}
/// Parse the entirety of the given input into RFC 2822 components: a civil
/// datetime and its offset.
///
/// This also consumes any trailing (superfluous) whitespace.
#[inline(always)]
fn parse_datetime_offset<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, (DateTime, Offset)>, Error> {
let input = input.as_ref();
let Parsed { value: dt, input } = self.parse_datetime(input)?;
let Parsed { value: offset, input } = self.parse_offset(input)?;
let Parsed { input, .. } = self.skip_whitespace(input);
let input = if input.is_empty() {
input
} else {
self.skip_comment(input)?.input
};
Ok(Parsed { value: (dt, offset), input })
}
/// Parses a civil datetime from an RFC 2822 string. The input may have
/// leading whitespace.
///
/// This also parses and trailing whitespace, including requiring at least
/// one whitespace character.
///
/// This basically parses everything except for the zone.
#[inline(always)]
fn parse_datetime<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, DateTime>, Error> {
if input.is_empty() {
return Err(err!(
"expected RFC 2822 datetime, but got empty string"
));
}
let Parsed { input, .. } = self.skip_whitespace(input);
if input.is_empty() {
return Err(err!(
"expected RFC 2822 datetime, but got empty string after \
trimming whitespace",
));
}
let Parsed { value: wd, input } = self.parse_weekday(input)?;
let Parsed { value: day, input } = self.parse_day(input)?;
let Parsed { value: month, input } = self.parse_month(input)?;
let Parsed { value: year, input } = self.parse_year(input)?;
let Parsed { value: hour, input } = self.parse_hour(input)?;
let Parsed { input, .. } = self.parse_time_separator(input)?;
let Parsed { value: minute, input } = self.parse_minute(input)?;
let (second, input) = if !input.starts_with(b":") {
(t::Second::N::<0>(), input)
} else {
let Parsed { input, .. } = self.parse_time_separator(input)?;
let Parsed { value: second, input } = self.parse_second(input)?;
(second, input)
};
let Parsed { input, .. } = self
.parse_whitespace(input)
.with_context(|| err!("expected whitespace after parsing time"))?;
let date =
Date::new_ranged(year, month, day).context("invalid date")?;
let time = Time::new_ranged(
hour,
minute,
second,
t::SubsecNanosecond::N::<0>(),
);
let dt = DateTime::from_parts(date, time);
if let Some(wd) = wd {
if !self.relaxed_weekday && wd != dt.weekday() {
return Err(err!(
"found parsed weekday of {parsed}, \
but parsed datetime of {dt} has weekday \
{has}",
parsed = weekday_abbrev(wd),
has = weekday_abbrev(dt.weekday()),
));
}
}
Ok(Parsed { value: dt, input })
}
/// Parses an optional weekday at the beginning of an RFC 2822 datetime.
///
/// This expects that any optional whitespace preceding the start of an
/// optional day has been stripped and that the input has at least one
/// byte.
///
/// When the first byte of the given input is a digit (or is empty), then
/// this returns `None`, as it implies a day is not present. But if it
/// isn't a digit, then we assume that it must be a weekday and return an
/// error based on that assumption if we couldn't recognize a weekday.
///
/// If a weekday is parsed, then this also skips any trailing whitespace
/// (and requires at least one whitespace character).
#[inline(always)]
fn parse_weekday<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, Option<Weekday>>, Error> {
// An empty input is invalid, but we let that case be
// handled by the caller. Otherwise, we know there MUST
// be a present day if the first character isn't an ASCII
// digit.
if matches!(input[0], b'0'..=b'9') {
return Ok(Parsed { value: None, input });
}
if input.len() < 4 {
return Err(err!(
"expected day at beginning of RFC 2822 datetime \
since first non-whitespace byte, {first:?}, \
is not a digit, but given string is too short \
(length is {length})",
first = escape::Byte(input[0]),
length = input.len(),
));
}
let b1 = input[0].to_ascii_lowercase();
let b2 = input[1].to_ascii_lowercase();
let b3 = input[2].to_ascii_lowercase();
let wd = match &[b1, b2, b3] {
b"sun" => Weekday::Sunday,
b"mon" => Weekday::Monday,
b"tue" => Weekday::Tuesday,
b"wed" => Weekday::Wednesday,
b"thu" => Weekday::Thursday,
b"fri" => Weekday::Friday,
b"sat" => Weekday::Saturday,
_ => {
return Err(err!(
"expected day at beginning of RFC 2822 datetime \
since first non-whitespace byte, {first:?}, \
is not a digit, but did not recognize {got:?} \
as a valid weekday abbreviation",
first = escape::Byte(input[0]),
got = escape::Bytes(&input[..3]),
));
}
};
if input[3] != b',' {
return Err(err!(
"expected day at beginning of RFC 2822 datetime \
since first non-whitespace byte, {first:?}, \
is not a digit, but found {got:?} after parsed \
weekday {wd:?} and expected a comma",
first = escape::Byte(input[0]),
got = escape::Byte(input[3]),
wd = escape::Bytes(&input[..3]),
));
}
let Parsed { input, .. } =
self.parse_whitespace(&input[4..]).with_context(|| {
err!(
"expected whitespace after parsing {got:?}",
got = escape::Bytes(&input[..4]),
)
})?;
Ok(Parsed { value: Some(wd), input })
}
/// Parses a 1 or 2 digit day.
///
/// This assumes the input starts with what must be an ASCII digit (or it
/// may be empty).
///
/// This also parses at least one mandatory whitespace character after the
/// day.
#[inline(always)]
fn parse_day<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, t::Day>, Error> {
if input.is_empty() {
return Err(err!("expected day, but found end of input"));
}
let mut digits = 1;
if input.len() >= 2 && matches!(input[1], b'0'..=b'9') {
digits = 2;
}
let (day, input) = input.split_at(digits);
let day = parse::i64(day).with_context(|| {
err!("failed to parse {day:?} as day", day = escape::Bytes(day))
})?;
let day = t::Day::try_new("day", day).context("day is not valid")?;
let Parsed { input, .. } =
self.parse_whitespace(input).with_context(|| {
err!("expected whitespace after parsing day {day}")
})?;
Ok(Parsed { value: day, input })
}
/// Parses an abbreviated month name.
///
/// This assumes the input starts with what must be the beginning of a
/// month name (or the input may be empty).
///
/// This also parses at least one mandatory whitespace character after the
/// month name.
#[inline(always)]
fn parse_month<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, t::Month>, Error> {
if input.is_empty() {
return Err(err!(
"expected abbreviated month name, but found end of input"
));
}
if input.len() < 3 {
return Err(err!(
"expected abbreviated month name, but remaining input \
is too short (remaining bytes is {length})",
length = input.len(),
));
}
let b1 = input[0].to_ascii_lowercase();
let b2 = input[1].to_ascii_lowercase();
let b3 = input[2].to_ascii_lowercase();
let month = match &[b1, b2, b3] {
b"jan" => 1,
b"feb" => 2,
b"mar" => 3,
b"apr" => 4,
b"may" => 5,
b"jun" => 6,
b"jul" => 7,
b"aug" => 8,
b"sep" => 9,
b"oct" => 10,
b"nov" => 11,
b"dec" => 12,
_ => {
return Err(err!(
"expected abbreviated month name, \
but did not recognize {got:?} \
as a valid month",
got = escape::Bytes(&input[..3]),
));
}
};
// OK because we just assigned a numeric value ourselves
// above, and all values are valid months.
let month = t::Month::new(month).unwrap();
let Parsed { input, .. } =
self.parse_whitespace(&input[3..]).with_context(|| {
err!("expected whitespace after parsing month name")
})?;
Ok(Parsed { value: month, input })
}
/// Parses a 2, 3 or 4 digit year.
///
/// This assumes the input starts with what must be an ASCII digit (or it
/// may be empty).
///
/// This also parses at least one mandatory whitespace character after the
/// day.
///
/// The 2 or 3 digit years are "obsolete," which we support by following
/// the rules in RFC 2822:
///
/// > Where a two or three digit year occurs in a date, the year is to be
/// > interpreted as follows: If a two digit year is encountered whose
/// > value is between 00 and 49, the year is interpreted by adding 2000,
/// > ending up with a value between 2000 and 2049. If a two digit year is
/// > encountered with a value between 50 and 99, or any three digit year
/// > is encountered, the year is interpreted by adding 1900.
#[inline(always)]
fn parse_year<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, t::Year>, Error> {
let mut digits = 0;
while digits <= 3
&& !input[digits..].is_empty()
&& matches!(input[digits], b'0'..=b'9')
{
digits += 1;
}
if digits <= 1 {
return Err(err!(
"expected at least two ASCII digits for parsing \
a year, but only found {digits}",
));
}
let (year, input) = input.split_at(digits);
let year = parse::i64(year).with_context(|| {
err!(
"failed to parse {year:?} as year \
(a two, three or four digit integer)",
year = escape::Bytes(year),
)
})?;
let year = match digits {
2 if year <= 49 => year + 2000,
2 | 3 => year + 1900,
4 => year,
_ => unreachable!("digits={digits} must be 2, 3 or 4"),
};
let year =
t::Year::try_new("year", year).context("year is not valid")?;
let Parsed { input, .. } = self
.parse_whitespace(input)
.with_context(|| err!("expected whitespace after parsing year"))?;
Ok(Parsed { value: year, input })
}
/// Parses a 2-digit hour. This assumes the input begins with what should
/// be an ASCII digit. (i.e., It doesn't trim leading whitespace.)
///
/// This parses a mandatory trailing `:`, advancing the input to
/// immediately after it.
#[inline(always)]
fn parse_hour<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, t::Hour>, Error> {
let (hour, input) = parse::split(input, 2).ok_or_else(|| {
err!("expected two digit hour, but found end of input")
})?;
let hour = parse::i64(hour).with_context(|| {
err!(
"failed to parse {hour:?} as hour (a two digit integer)",
hour = escape::Bytes(hour),
)
})?;
let hour =
t::Hour::try_new("hour", hour).context("hour is not valid")?;
Ok(Parsed { value: hour, input })
}
/// Parses a 2-digit minute. This assumes the input begins with what should
/// be an ASCII digit. (i.e., It doesn't trim leading whitespace.)
#[inline(always)]
fn parse_minute<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, t::Minute>, Error> {
let (minute, input) = parse::split(input, 2).ok_or_else(|| {
err!("expected two digit minute, but found end of input")
})?;
let minute = parse::i64(minute).with_context(|| {
err!(
"failed to parse {minute:?} as minute (a two digit integer)",
minute = escape::Bytes(minute),
)
})?;
let minute = t::Minute::try_new("minute", minute)
.context("minute is not valid")?;
Ok(Parsed { value: minute, input })
}
/// Parses a 2-digit second. This assumes the input begins with what should
/// be an ASCII digit. (i.e., It doesn't trim leading whitespace.)
#[inline(always)]
fn parse_second<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, t::Second>, Error> {
let (second, input) = parse::split(input, 2).ok_or_else(|| {
err!("expected two digit second, but found end of input")
})?;
let mut second = parse::i64(second).with_context(|| {
err!(
"failed to parse {second:?} as second (a two digit integer)",
second = escape::Bytes(second),
)
})?;
if second == 60 {
second = 59;
}
let second = t::Second::try_new("second", second)
.context("second is not valid")?;
Ok(Parsed { value: second, input })
}
/// Parses a time zone offset (including obsolete offsets like EDT).
///
/// This assumes the offset must begin at the beginning of `input`. That
/// is, any leading whitespace should already have been trimmed.
#[inline(always)]
fn parse_offset<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, Offset>, Error> {
type ParsedOffsetHours = ri8<0, { t::SpanZoneOffsetHours::MAX }>;
type ParsedOffsetMinutes = ri8<0, { t::SpanZoneOffsetMinutes::MAX }>;
let sign = input.get(0).copied().ok_or_else(|| {
err!(
"expected sign for time zone offset, \
(or a legacy time zone name abbreviation), \
but found end of input",
)
})?;
let sign = if sign == b'+' {
t::Sign::N::<1>()
} else if sign == b'-' {
t::Sign::N::<-1>()
} else {
return self.parse_offset_obsolete(input);
};
let input = &input[1..];
let (hhmm, input) = parse::split(input, 4).ok_or_else(|| {
err!(
"expected at least 4 digits for time zone offset \
after sign, but found only {len} bytes remaining",
len = input.len(),
)
})?;
let hh = parse::i64(&hhmm[0..2]).with_context(|| {
err!(
"failed to parse hours from time zone offset {hhmm}",
hhmm = escape::Bytes(hhmm)
)
})?;
let hh = ParsedOffsetHours::try_new("zone-offset-hours", hh)
.context("time zone offset hours are not valid")?;
let hh = t::SpanZoneOffset::rfrom(hh);
let mm = parse::i64(&hhmm[2..4]).with_context(|| {
err!(
"failed to parse minutes from time zone offset {hhmm}",
hhmm = escape::Bytes(hhmm)
)
})?;
let mm = ParsedOffsetMinutes::try_new("zone-offset-minutes", mm)
.context("time zone offset minutes are not valid")?;
let mm = t::SpanZoneOffset::rfrom(mm);
let seconds = hh * C(3_600) + mm * C(60);
let offset = Offset::from_seconds_ranged(seconds * sign);
Ok(Parsed { value: offset, input })
}
/// Parses an obsolete time zone offset.
#[inline(never)]
fn parse_offset_obsolete<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, Offset>, Error> {
let mut letters = [0; 5];
let mut len = 0;
while len <= 4
&& !input[len..].is_empty()
&& !is_whitespace(input[len])
{
letters[len] = input[len].to_ascii_lowercase();
len += 1;
}
if len == 0 {
return Err(err!(
"expected obsolete RFC 2822 time zone abbreviation, \
but found no remaining non-whitespace characters \
after time",
));
}
let offset = match &letters[..len] {
b"ut" | b"gmt" | b"z" => Offset::UTC,
b"est" => Offset::constant(-5),
b"edt" => Offset::constant(-4),
b"cst" => Offset::constant(-6),
b"cdt" => Offset::constant(-5),
b"mst" => Offset::constant(-7),
b"mdt" => Offset::constant(-6),
b"pst" => Offset::constant(-8),
b"pdt" => Offset::constant(-7),
name => {
if name.len() == 1
&& matches!(name[0], b'a'..=b'i' | b'k'..=b'z')
{
// Section 4.3 indicates these as military time:
//
// > The 1 character military time zones were defined in
// > a non-standard way in [RFC822] and are therefore
// > unpredictable in their meaning. The original
// > definitions of the military zones "A" through "I" are
// > equivalent to "+0100" through "+0900" respectively;
// > "K", "L", and "M" are equivalent to "+1000", "+1100",
// > and "+1200" respectively; "N" through "Y" are
// > equivalent to "-0100" through "-1200" respectively;
// > and "Z" is equivalent to "+0000". However, because of
// > the error in [RFC822], they SHOULD all be considered
// > equivalent to "-0000" unless there is out-of-band
// > information confirming their meaning.
//
// So just treat them as UTC.
Offset::UTC
} else if name.len() >= 3
&& name.iter().all(|&b| matches!(b, b'a'..=b'z'))
{
// Section 4.3 also says that anything that _looks_ like a
// zone name should just be -0000 too:
//
// > Other multi-character (usually between 3 and 5)
// > alphabetic time zones have been used in Internet
// > messages. Any such time zone whose meaning is not
// > known SHOULD be considered equivalent to "-0000"
// > unless there is out-of-band information confirming
// > their meaning.
Offset::UTC
} else {
// But anything else we throw our hands up I guess.
return Err(err!(
"expected obsolete RFC 2822 time zone abbreviation, \
but found {found:?}",
found = escape::Bytes(&input[..len]),
));
}
}
};
Ok(Parsed { value: offset, input: &input[len..] })
}
/// Parses a time separator. This returns an error if one couldn't be
/// found.
#[inline(always)]
fn parse_time_separator<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, ()>, Error> {
if input.is_empty() {
return Err(err!(
"expected time separator of ':', but found end of input",
));
}
if input[0] != b':' {
return Err(err!(
"expected time separator of ':', but found {got}",
got = escape::Byte(input[0]),
));
}
Ok(Parsed { value: (), input: &input[1..] })
}
/// Parses at least one whitespace character. If no whitespace was found,
/// then this returns an error.
#[inline(always)]
fn parse_whitespace<'i>(
&self,
input: &'i [u8],
) -> Result<Parsed<'i, ()>, Error> {
let oldlen = input.len();
let parsed = self.skip_whitespace(input);
let newlen = parsed.input.len();
if oldlen == newlen {
return Err(err!(
"expected at least one whitespace character (space or tab), \
but found none",
));
}
Ok(parsed)
}
/// Skips over any ASCII whitespace at the beginning of `input`.
///
/// This returns the input unchanged if it does not begin with whitespace.
#[inline(always)]
fn skip_whitespace<'i>(&self, mut input: &'i [u8]) -> Parsed<'i, ()> {
while input.first().map_or(false, |&b| is_whitespace(b)) {
input = &input[1..];
}
Parsed { value: (), input }
}
/// This attempts to parse and skip any trailing "comment" in an RFC 2822
/// datetime.
///
/// This is a bit more relaxed than what RFC 2822 specifies. We basically
/// just try to balance parenthesis and skip over escapes.
///
/// This assumes that if a comment exists, its opening parenthesis is at
/// the beginning of `input`. That is, any leading whitespace has been
/// stripped.
#[inline(never)]
fn skip_comment<'i>(
&self,
mut input: &'i [u8],
) -> Result<Parsed<'i, ()>, Error> {
if !input.starts_with(b"(") {
return Ok(Parsed { value: (), input });
}
input = &input[1..];
let mut depth: u8 = 1;
let mut escape = false;
for byte in input.iter().copied() {
input = &input[1..];
if escape {
escape = false;
} else if byte == b'\\' {
escape = true;
} else if byte == b')' {
// I believe this error case is actually impossible, since as
// soon as we hit 0, we break out. If there is more "comment,"
// then it will flag an error as unparsed input.
depth = depth.checked_sub(1).ok_or_else(|| {
err!(
"found closing parenthesis in comment with \
no matching opening parenthesis"
)
})?;
if depth == 0 {
break;
}
} else if byte == b'(' {
depth = depth.checked_add(1).ok_or_else(|| {
err!("found too many nested parenthesis in comment")
})?;
}
}
if depth > 0 {
return Err(err!(
"found opening parenthesis in comment with \
no matching closing parenthesis"
));
}
Ok(self.skip_whitespace(input))
}
}
/// A printer for [RFC 2822] datetimes.
///
/// This printer converts an in memory representation of a precise instant in
/// time to an RFC 2822 formatted string. That is, [`Zoned`] or [`Timestamp`],
/// since all other datetime types in Jiff are inexact.
///
/// [RFC 2822]: https://datatracker.ietf.org/doc/html/rfc2822
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Example
///
/// This example shows how to convert a zoned datetime to the RFC 2822 format:
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822::DateTimePrinter};
///
/// const PRINTER: DateTimePrinter = DateTimePrinter::new();
///
/// let zdt = date(2024, 6, 15).at(7, 0, 0, 0).in_tz("Australia/Tasmania")?;
///
/// let mut buf = String::new();
/// PRINTER.print_zoned(&zdt, &mut buf)?;
/// assert_eq!(buf, "Sat, 15 Jun 2024 07:00:00 +1000");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
///
/// # Example: using adapters with `std::io::Write` and `std::fmt::Write`
///
/// By using the [`StdIoWrite`](super::StdIoWrite) and
/// [`StdFmtWrite`](super::StdFmtWrite) adapters, one can print datetimes
/// directly to implementations of `std::io::Write` and `std::fmt::Write`,
/// respectively. The example below demonstrates writing to anything
/// that implements `std::io::Write`. Similar code can be written for
/// `std::fmt::Write`.
///
/// ```no_run
/// use std::{fs::File, io::{BufWriter, Write}, path::Path};
///
/// use jiff::{civil::date, fmt::{StdIoWrite, rfc2822::DateTimePrinter}};
///
/// let zdt = date(2024, 6, 15).at(7, 0, 0, 0).in_tz("Asia/Kolkata")?;
///
/// let path = Path::new("/tmp/output");
/// let mut file = BufWriter::new(File::create(path)?);
/// DateTimePrinter::new().print_zoned(&zdt, StdIoWrite(&mut file)).unwrap();
/// file.flush()?;
/// assert_eq!(
/// std::fs::read_to_string(path)?,
/// "Sat, 15 Jun 2024 07:00:00 +0530",
/// );
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[derive(Debug)]
pub struct DateTimePrinter {
// The RFC 2822 printer has no configuration at present.
_private: (),
}
impl DateTimePrinter {
/// Create a new RFC 2822 datetime printer with the default configuration.
#[inline]
pub const fn new() -> DateTimePrinter {
DateTimePrinter { _private: () }
}
/// Format a `Zoned` datetime into a string.
///
/// This never emits `-0000` as the offset in the RFC 2822 format. If you
/// desire a `-0000` offset, use [`DateTimePrinter::print_timestamp`] via
/// [`Zoned::timestamp`].
///
/// Moreover, since RFC 2822 does not support fractional seconds, this
/// routine prints the zoned datetime as if truncating any fractional
/// seconds.
///
/// This is a convenience routine for [`DateTimePrinter::print_zoned`]
/// with a `String`.
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Errors
///
/// This can return an error if the year corresponding to this timestamp
/// cannot be represented in the RFC 2822 format. For example, a negative
/// year.
///
/// # Example
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822::DateTimePrinter};
///
/// const PRINTER: DateTimePrinter = DateTimePrinter::new();
///
/// let zdt = date(2024, 6, 15).at(7, 0, 0, 0).in_tz("America/New_York")?;
/// assert_eq!(
/// PRINTER.zoned_to_string(&zdt)?,
/// "Sat, 15 Jun 2024 07:00:00 -0400",
/// );
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[cfg(feature = "alloc")]
pub fn zoned_to_string(
&self,
zdt: &Zoned,
) -> Result<alloc::string::String, Error> {
let mut buf = alloc::string::String::with_capacity(4);
self.print_zoned(zdt, &mut buf)?;
Ok(buf)
}
/// Format a `Timestamp` datetime into a string.
///
/// This always emits `-0000` as the offset in the RFC 2822 format. If you
/// desire a `+0000` offset, use [`DateTimePrinter::print_zoned`] with a
/// zoned datetime with [`TimeZone::UTC`].
///
/// Moreover, since RFC 2822 does not support fractional seconds, this
/// routine prints the timestamp as if truncating any fractional seconds.
///
/// This is a convenience routine for [`DateTimePrinter::print_timestamp`]
/// with a `String`.
///
/// # Errors
///
/// This returns an error if the year corresponding to this
/// timestamp cannot be represented in the RFC 2822 format. For example, a
/// negative year.
///
/// # Example
///
/// ```
/// use jiff::{fmt::rfc2822::DateTimePrinter, Timestamp};
///
/// let timestamp = Timestamp::from_second(1)
/// .expect("one second after Unix epoch is always valid");
/// assert_eq!(
/// DateTimePrinter::new().timestamp_to_string(×tamp)?,
/// "Thu, 1 Jan 1970 00:00:01 -0000",
/// );
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[cfg(feature = "alloc")]
pub fn timestamp_to_string(
&self,
timestamp: &Timestamp,
) -> Result<alloc::string::String, Error> {
let mut buf = alloc::string::String::with_capacity(4);
self.print_timestamp(timestamp, &mut buf)?;
Ok(buf)
}
/// Format a `Timestamp` datetime into a string in a way that is explicitly
/// compatible with [RFC 9110]. This is typically useful in contexts where
/// strict compatibility with HTTP is desired.
///
/// This always emits `GMT` as the offset and always uses two digits for
/// the day. This results in a fixed length format that always uses 29
/// characters.
///
/// Since neither RFC 2822 nor RFC 9110 supports fractional seconds, this
/// routine prints the timestamp as if truncating any fractional seconds.
///
/// This is a convenience routine for
/// [`DateTimePrinter::print_timestamp_rfc9110`] with a `String`.
///
/// # Errors
///
/// This returns an error if the year corresponding to this timestamp
/// cannot be represented in the RFC 2822 or RFC 9110 format. For example,
/// a negative year.
///
/// # Example
///
/// ```
/// use jiff::{fmt::rfc2822::DateTimePrinter, Timestamp};
///
/// let timestamp = Timestamp::from_second(1)
/// .expect("one second after Unix epoch is always valid");
/// assert_eq!(
/// DateTimePrinter::new().timestamp_to_rfc9110_string(×tamp)?,
/// "Thu, 01 Jan 1970 00:00:01 GMT",
/// );
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
///
/// [RFC 9110]: https://datatracker.ietf.org/doc/html/rfc9110#section-5.6.7-15
#[cfg(feature = "alloc")]
pub fn timestamp_to_rfc9110_string(
&self,
timestamp: &Timestamp,
) -> Result<alloc::string::String, Error> {
let mut buf = alloc::string::String::with_capacity(29);
self.print_timestamp_rfc9110(timestamp, &mut buf)?;
Ok(buf)
}
/// Print a `Zoned` datetime to the given writer.
///
/// This never emits `-0000` as the offset in the RFC 2822 format. If you
/// desire a `-0000` offset, use [`DateTimePrinter::print_timestamp`] via
/// [`Zoned::timestamp`].
///
/// Moreover, since RFC 2822 does not support fractional seconds, this
/// routine prints the zoned datetime as if truncating any fractional
/// seconds.
///
/// # Warning
///
/// The RFC 2822 format only supports writing a precise instant in time
/// expressed via a time zone offset. It does *not* support serializing
/// the time zone itself. This means that if you format a zoned datetime
/// in a time zone like `America/New_York` and then deserialize it, the
/// zoned datetime you get back will be a "fixed offset" zoned datetime.
/// This in turn means it will not perform daylight saving time safe
/// arithmetic.
///
/// Basically, you should use the RFC 2822 format if it's required (for
/// example, when dealing with email). But you should not choose it as a
/// general interchange format for new applications.
///
/// # Errors
///
/// This returns an error when writing to the given [`Write`]
/// implementation would fail. Some such implementations, like for `String`
/// and `Vec<u8>`, never fail (unless memory allocation fails).
///
/// This can also return an error if the year corresponding to this
/// timestamp cannot be represented in the RFC 2822 format. For example, a
/// negative year.
///
/// # Example
///
/// ```
/// use jiff::{civil::date, fmt::rfc2822::DateTimePrinter};
///
/// const PRINTER: DateTimePrinter = DateTimePrinter::new();
///
/// let zdt = date(2024, 6, 15).at(7, 0, 0, 0).in_tz("America/New_York")?;
///
/// let mut buf = String::new();
/// PRINTER.print_zoned(&zdt, &mut buf)?;
/// assert_eq!(buf, "Sat, 15 Jun 2024 07:00:00 -0400");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn print_zoned<W: Write>(
&self,
zdt: &Zoned,
wtr: W,
) -> Result<(), Error> {
self.print_civil_with_offset(zdt.datetime(), Some(zdt.offset()), wtr)
}
/// Print a `Timestamp` datetime to the given writer.
///
/// This always emits `-0000` as the offset in the RFC 2822 format. If you
/// desire a `+0000` offset, use [`DateTimePrinter::print_zoned`] with a
/// zoned datetime with [`TimeZone::UTC`].
///
/// Moreover, since RFC 2822 does not support fractional seconds, this
/// routine prints the timestamp as if truncating any fractional seconds.
///
/// # Errors
///
/// This returns an error when writing to the given [`Write`]
/// implementation would fail. Some such implementations, like for `String`
/// and `Vec<u8>`, never fail (unless memory allocation fails).
///
/// This can also return an error if the year corresponding to this
/// timestamp cannot be represented in the RFC 2822 format. For example, a
/// negative year.
///
/// # Example
///
/// ```
/// use jiff::{fmt::rfc2822::DateTimePrinter, Timestamp};
///
/// let timestamp = Timestamp::from_second(1)
/// .expect("one second after Unix epoch is always valid");
///
/// let mut buf = String::new();
/// DateTimePrinter::new().print_timestamp(×tamp, &mut buf)?;
/// assert_eq!(buf, "Thu, 1 Jan 1970 00:00:01 -0000");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn print_timestamp<W: Write>(
&self,
timestamp: &Timestamp,
wtr: W,
) -> Result<(), Error> {
let dt = TimeZone::UTC.to_datetime(*timestamp);
self.print_civil_with_offset(dt, None, wtr)
}
/// Print a `Timestamp` datetime to the given writer in a way that is
/// explicitly compatible with [RFC 9110]. This is typically useful in
/// contexts where strict compatibility with HTTP is desired.
///
/// This always emits `GMT` as the offset and always uses two digits for
/// the day. This results in a fixed length format that always uses 29
/// characters.
///
/// Since neither RFC 2822 nor RFC 9110 supports fractional seconds, this
/// routine prints the timestamp as if truncating any fractional seconds.
///
/// # Errors
///
/// This returns an error when writing to the given [`Write`]
/// implementation would fail. Some such implementations, like for `String`
/// and `Vec<u8>`, never fail (unless memory allocation fails).
///
/// This can also return an error if the year corresponding to this
/// timestamp cannot be represented in the RFC 2822 or RFC 9110 format. For
/// example, a negative year.
///
/// # Example
///
/// ```
/// use jiff::{fmt::rfc2822::DateTimePrinter, Timestamp};
///
/// let timestamp = Timestamp::from_second(1)
/// .expect("one second after Unix epoch is always valid");
///
/// let mut buf = String::new();
/// DateTimePrinter::new().print_timestamp_rfc9110(×tamp, &mut buf)?;
/// assert_eq!(buf, "Thu, 01 Jan 1970 00:00:01 GMT");
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
///
/// [RFC 9110]: https://datatracker.ietf.org/doc/html/rfc9110#section-5.6.7-15
pub fn print_timestamp_rfc9110<W: Write>(
&self,
timestamp: &Timestamp,
wtr: W,
) -> Result<(), Error> {
self.print_civil_always_utc(timestamp, wtr)
}
fn print_civil_with_offset<W: Write>(
&self,
dt: DateTime,
offset: Option<Offset>,
mut wtr: W,
) -> Result<(), Error> {
static FMT_DAY: DecimalFormatter = DecimalFormatter::new();
static FMT_YEAR: DecimalFormatter = DecimalFormatter::new().padding(4);
static FMT_TIME_UNIT: DecimalFormatter =
DecimalFormatter::new().padding(2);
if dt.year() < 0 {
// RFC 2822 actually says the year must be at least 1900, but
// other implementations (like Chrono) allow any positive 4-digit
// year.
return Err(err!(
"datetime {dt} has negative year, \
which cannot be formatted with RFC 2822",
));
}
wtr.write_str(weekday_abbrev(dt.weekday()))?;
wtr.write_str(", ")?;
wtr.write_int(&FMT_DAY, dt.day())?;
wtr.write_str(" ")?;
wtr.write_str(month_name(dt.month()))?;
wtr.write_str(" ")?;
wtr.write_int(&FMT_YEAR, dt.year())?;
wtr.write_str(" ")?;
wtr.write_int(&FMT_TIME_UNIT, dt.hour())?;
wtr.write_str(":")?;
wtr.write_int(&FMT_TIME_UNIT, dt.minute())?;
wtr.write_str(":")?;
wtr.write_int(&FMT_TIME_UNIT, dt.second())?;
wtr.write_str(" ")?;
let Some(offset) = offset else {
wtr.write_str("-0000")?;
return Ok(());
};
wtr.write_str(if offset.is_negative() { "-" } else { "+" })?;
let mut hours = offset.part_hours_ranged().abs().get();
let mut minutes = offset.part_minutes_ranged().abs().get();
// RFC 2822, like RFC 3339, requires that time zone offsets are an
// integral number of minutes. While rounding based on seconds doesn't
// seem clearly indicated, we choose to do that here. An alternative
// would be to return an error. It isn't clear how important this is in
// practice though.
if offset.part_seconds_ranged().abs() >= 30 {
if minutes == 59 {
hours = hours.saturating_add(1);
minutes = 0;
} else {
minutes = minutes.saturating_add(1);
}
}
wtr.write_int(&FMT_TIME_UNIT, hours)?;
wtr.write_int(&FMT_TIME_UNIT, minutes)?;
Ok(())
}
fn print_civil_always_utc<W: Write>(
&self,
timestamp: &Timestamp,
mut wtr: W,
) -> Result<(), Error> {
static FMT_DAY: DecimalFormatter = DecimalFormatter::new().padding(2);
static FMT_YEAR: DecimalFormatter = DecimalFormatter::new().padding(4);
static FMT_TIME_UNIT: DecimalFormatter =
DecimalFormatter::new().padding(2);
let dt = TimeZone::UTC.to_datetime(*timestamp);
if dt.year() < 0 {
// RFC 2822 actually says the year must be at least 1900, but
// other implementations (like Chrono) allow any positive 4-digit
// year.
return Err(err!(
"datetime {dt} has negative year, \
which cannot be formatted with RFC 2822",
));
}
wtr.write_str(weekday_abbrev(dt.weekday()))?;
wtr.write_str(", ")?;
wtr.write_int(&FMT_DAY, dt.day())?;
wtr.write_str(" ")?;
wtr.write_str(month_name(dt.month()))?;
wtr.write_str(" ")?;
wtr.write_int(&FMT_YEAR, dt.year())?;
wtr.write_str(" ")?;
wtr.write_int(&FMT_TIME_UNIT, dt.hour())?;
wtr.write_str(":")?;
wtr.write_int(&FMT_TIME_UNIT, dt.minute())?;
wtr.write_str(":")?;
wtr.write_int(&FMT_TIME_UNIT, dt.second())?;
wtr.write_str(" ")?;
wtr.write_str("GMT")?;
Ok(())
}
}
fn weekday_abbrev(wd: Weekday) -> &'static str {
match wd {
Weekday::Sunday => "Sun",
Weekday::Monday => "Mon",
Weekday::Tuesday => "Tue",
Weekday::Wednesday => "Wed",
Weekday::Thursday => "Thu",
Weekday::Friday => "Fri",
Weekday::Saturday => "Sat",
}
}
fn month_name(month: i8) -> &'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!("invalid month value {month}"),
}
}
/// Returns true if the given byte is "whitespace" as defined by RFC 2822.
///
/// From S2.2.2:
///
/// > Many of these tokens are allowed (according to their syntax) to be
/// > introduced or end with comments (as described in section 3.2.3) as well
/// > as the space (SP, ASCII value 32) and horizontal tab (HTAB, ASCII value
/// > 9) characters (together known as the white space characters, WSP), and
/// > those WSP characters are subject to header "folding" and "unfolding" as
/// > described in section 2.2.3.
///
/// In other words, ASCII space or tab.
///
/// With all that said, it seems odd to limit this to just spaces or tabs, so
/// we relax this and let it absorb any kind of ASCII whitespace. This also
/// handles, I believe, most cases of "folding" whitespace. (By treating `\r`
/// and `\n` as whitespace.)
fn is_whitespace(byte: u8) -> bool {
byte.is_ascii_whitespace()
}
#[cfg(test)]
mod tests {
use alloc::string::{String, ToString};
use crate::civil::date;
use super::*;
#[test]
fn ok_parse_basic() {
let p = |input| DateTimeParser::new().parse_zoned(input).unwrap();
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 -0500"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("Tue, 9 Jan 2024 05:34:45 -0500"),
@"2024-01-09T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("Tue, 09 Jan 2024 05:34:45 -0500"),
@"2024-01-09T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("10 Jan 2024 05:34:45 -0500"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("10 Jan 2024 05:34 -0500"),
@"2024-01-10T05:34:00-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("10 Jan 2024 05:34:45 +0500"),
@"2024-01-10T05:34:45+05:00[+05:00]",
);
insta::assert_debug_snapshot!(
p("Thu, 29 Feb 2024 05:34 -0500"),
@"2024-02-29T05:34:00-05:00[-05:00]",
);
// leap second constraining
insta::assert_debug_snapshot!(
p("10 Jan 2024 05:34:60 -0500"),
@"2024-01-10T05:34:59-05:00[-05:00]",
);
}
#[test]
fn ok_parse_obsolete_zone() {
let p = |input| DateTimeParser::new().parse_zoned(input).unwrap();
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 EST"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 EDT"),
@"2024-01-10T05:34:45-04:00[-04:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 CST"),
@"2024-01-10T05:34:45-06:00[-06:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 CDT"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 mst"),
@"2024-01-10T05:34:45-07:00[-07:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 mdt"),
@"2024-01-10T05:34:45-06:00[-06:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 pst"),
@"2024-01-10T05:34:45-08:00[-08:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 pdt"),
@"2024-01-10T05:34:45-07:00[-07:00]",
);
// Various things that mean UTC.
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 UT"),
@"2024-01-10T05:34:45+00:00[UTC]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 Z"),
@"2024-01-10T05:34:45+00:00[UTC]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 gmt"),
@"2024-01-10T05:34:45+00:00[UTC]",
);
// Even things that are unrecognized just get treated as having
// an offset of 0.
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 XXX"),
@"2024-01-10T05:34:45+00:00[UTC]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 ABCDE"),
@"2024-01-10T05:34:45+00:00[UTC]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 FUCK"),
@"2024-01-10T05:34:45+00:00[UTC]",
);
}
// whyyyyyyyyyyyyy
#[test]
fn ok_parse_comment() {
let p = |input| DateTimeParser::new().parse_zoned(input).unwrap();
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 -0500 (wat)"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 -0500 (w(a)t)"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p(r"Wed, 10 Jan 2024 05:34:45 -0500 (w\(a\)t)"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
}
#[test]
fn ok_parse_whitespace() {
let p = |input| DateTimeParser::new().parse_zoned(input).unwrap();
insta::assert_debug_snapshot!(
p("Wed, 10 \t Jan \n\r\n\n 2024 05:34:45 -0500"),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
insta::assert_debug_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 -0500 "),
@"2024-01-10T05:34:45-05:00[-05:00]",
);
}
#[test]
fn err_parse_invalid() {
let p = |input| {
DateTimeParser::new().parse_zoned(input).unwrap_err().to_string()
};
insta::assert_snapshot!(
p("Thu, 10 Jan 2024 05:34:45 -0500"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: found parsed weekday of Thu, but parsed datetime of 2024-01-10T05:34:45 has weekday Wed",
);
insta::assert_snapshot!(
p("Wed, 29 Feb 2023 05:34:45 -0500"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: invalid date: parameter 'day' with value 29 is not in the required range of 1..=28",
);
insta::assert_snapshot!(
p("Mon, 31 Jun 2024 05:34:45 -0500"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: invalid date: parameter 'day' with value 31 is not in the required range of 1..=30",
);
insta::assert_snapshot!(
p("Tue, 32 Jun 2024 05:34:45 -0500"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: day is not valid: parameter 'day' with value 32 is not in the required range of 1..=31",
);
insta::assert_snapshot!(
p("Sun, 30 Jun 2024 24:00:00 -0500"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: hour is not valid: parameter 'hour' with value 24 is not in the required range of 0..=23",
);
}
#[test]
fn err_parse_incomplete() {
let p = |input| {
DateTimeParser::new().parse_zoned(input).unwrap_err().to_string()
};
insta::assert_snapshot!(
p(""),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected RFC 2822 datetime, but got empty string",
);
insta::assert_snapshot!(
p(" "),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected RFC 2822 datetime, but got empty string after trimming whitespace",
);
insta::assert_snapshot!(
p("Wat"),
@r###"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected day at beginning of RFC 2822 datetime since first non-whitespace byte, "W", is not a digit, but given string is too short (length is 3)"###,
);
insta::assert_snapshot!(
p("Wed"),
@r###"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected day at beginning of RFC 2822 datetime since first non-whitespace byte, "W", is not a digit, but given string is too short (length is 3)"###,
);
insta::assert_snapshot!(
p("Wat, "),
@r###"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected day at beginning of RFC 2822 datetime since first non-whitespace byte, "W", is not a digit, but did not recognize "Wat" as a valid weekday abbreviation"###,
);
insta::assert_snapshot!(
p("Wed, "),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected day, but found end of input",
);
insta::assert_snapshot!(
p("Wed, 1"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected whitespace after parsing day 1: expected at least one whitespace character (space or tab), but found none",
);
insta::assert_snapshot!(
p("Wed, 10"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected whitespace after parsing day 10: expected at least one whitespace character (space or tab), but found none",
);
insta::assert_snapshot!(
p("Wed, 10 J"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected abbreviated month name, but remaining input is too short (remaining bytes is 1)",
);
insta::assert_snapshot!(
p("Wed, 10 Wat"),
@r###"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected abbreviated month name, but did not recognize "Wat" as a valid month"###,
);
insta::assert_snapshot!(
p("Wed, 10 Jan"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected whitespace after parsing month name: expected at least one whitespace character (space or tab), but found none",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected at least two ASCII digits for parsing a year, but only found 1",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected whitespace after parsing year: expected at least one whitespace character (space or tab), but found none",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024 05"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected time separator of ':', but found end of input",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024 053"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected time separator of ':', but found 3",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024 05:34"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected whitespace after parsing time: expected at least one whitespace character (space or tab), but found none",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024 05:34:"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected two digit second, but found end of input",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024 05:34:45"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected whitespace after parsing time: expected at least one whitespace character (space or tab), but found none",
);
insta::assert_snapshot!(
p("Wed, 10 Jan 2024 05:34:45 J"),
@r###"failed to parse RFC 2822 datetime into Jiff zoned datetime: expected obsolete RFC 2822 time zone abbreviation, but found "J""###,
);
}
#[test]
fn err_parse_comment() {
let p = |input| {
DateTimeParser::new().parse_zoned(input).unwrap_err().to_string()
};
insta::assert_snapshot!(
p(r"Wed, 10 Jan 2024 05:34:45 -0500 (wa)t)"),
@r###"parsed value '2024-01-10T05:34:45-05:00[-05:00]', but unparsed input "t)" remains (expected no unparsed input)"###,
);
insta::assert_snapshot!(
p(r"Wed, 10 Jan 2024 05:34:45 -0500 (wa(t)"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: found opening parenthesis in comment with no matching closing parenthesis",
);
insta::assert_snapshot!(
p(r"Wed, 10 Jan 2024 05:34:45 -0500 (w"),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: found opening parenthesis in comment with no matching closing parenthesis",
);
insta::assert_snapshot!(
p(r"Wed, 10 Jan 2024 05:34:45 -0500 ("),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: found opening parenthesis in comment with no matching closing parenthesis",
);
insta::assert_snapshot!(
p(r"Wed, 10 Jan 2024 05:34:45 -0500 ( "),
@"failed to parse RFC 2822 datetime into Jiff zoned datetime: found opening parenthesis in comment with no matching closing parenthesis",
);
}
#[test]
fn ok_print_zoned() {
if crate::tz::db().is_definitively_empty() {
return;
}
let p = |zdt: &Zoned| -> String {
let mut buf = String::new();
DateTimePrinter::new().print_zoned(&zdt, &mut buf).unwrap();
buf
};
let zdt = date(2024, 1, 10)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap();
insta::assert_snapshot!(p(&zdt), @"Wed, 10 Jan 2024 05:34:45 -0500");
let zdt = date(2024, 2, 5)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap();
insta::assert_snapshot!(p(&zdt), @"Mon, 5 Feb 2024 05:34:45 -0500");
let zdt = date(2024, 7, 31)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap();
insta::assert_snapshot!(p(&zdt), @"Wed, 31 Jul 2024 05:34:45 -0400");
let zdt = date(2024, 3, 5).at(5, 34, 45, 0).in_tz("UTC").unwrap();
// Notice that this prints a +0000 offset.
// But when printing a Timestamp, a -0000 offset is used.
// This is because in the case of Timestamp, the "true"
// offset is not known.
insta::assert_snapshot!(p(&zdt), @"Tue, 5 Mar 2024 05:34:45 +0000");
}
#[test]
fn ok_print_timestamp() {
if crate::tz::db().is_definitively_empty() {
return;
}
let p = |ts: Timestamp| -> String {
let mut buf = String::new();
DateTimePrinter::new().print_timestamp(&ts, &mut buf).unwrap();
buf
};
let ts = date(2024, 1, 10)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"Wed, 10 Jan 2024 10:34:45 -0000");
let ts = date(2024, 2, 5)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"Mon, 5 Feb 2024 10:34:45 -0000");
let ts = date(2024, 7, 31)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"Wed, 31 Jul 2024 09:34:45 -0000");
let ts = date(2024, 3, 5)
.at(5, 34, 45, 0)
.in_tz("UTC")
.unwrap()
.timestamp();
// Notice that this prints a +0000 offset.
// But when printing a Timestamp, a -0000 offset is used.
// This is because in the case of Timestamp, the "true"
// offset is not known.
insta::assert_snapshot!(p(ts), @"Tue, 5 Mar 2024 05:34:45 -0000");
}
#[test]
fn ok_print_rfc9110_timestamp() {
if crate::tz::db().is_definitively_empty() {
return;
}
let p = |ts: Timestamp| -> String {
let mut buf = String::new();
DateTimePrinter::new()
.print_timestamp_rfc9110(&ts, &mut buf)
.unwrap();
buf
};
let ts = date(2024, 1, 10)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"Wed, 10 Jan 2024 10:34:45 GMT");
let ts = date(2024, 2, 5)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"Mon, 05 Feb 2024 10:34:45 GMT");
let ts = date(2024, 7, 31)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"Wed, 31 Jul 2024 09:34:45 GMT");
let ts = date(2024, 3, 5)
.at(5, 34, 45, 0)
.in_tz("UTC")
.unwrap()
.timestamp();
// Notice that this prints a +0000 offset.
// But when printing a Timestamp, a -0000 offset is used.
// This is because in the case of Timestamp, the "true"
// offset is not known.
insta::assert_snapshot!(p(ts), @"Tue, 05 Mar 2024 05:34:45 GMT");
}
#[test]
fn err_print_zoned() {
if crate::tz::db().is_definitively_empty() {
return;
}
let p = |zdt: &Zoned| -> String {
let mut buf = String::new();
DateTimePrinter::new()
.print_zoned(&zdt, &mut buf)
.unwrap_err()
.to_string()
};
let zdt = date(-1, 1, 10)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap();
insta::assert_snapshot!(p(&zdt), @"datetime -000001-01-10T05:34:45 has negative year, which cannot be formatted with RFC 2822");
}
#[test]
fn err_print_timestamp() {
if crate::tz::db().is_definitively_empty() {
return;
}
let p = |ts: Timestamp| -> String {
let mut buf = String::new();
DateTimePrinter::new()
.print_timestamp(&ts, &mut buf)
.unwrap_err()
.to_string()
};
let ts = date(-1, 1, 10)
.at(5, 34, 45, 0)
.in_tz("America/New_York")
.unwrap()
.timestamp();
insta::assert_snapshot!(p(ts), @"datetime -000001-01-10T10:30:47 has negative year, which cannot be formatted with RFC 2822");
}
}