summaryrefslogtreecommitdiffstats
path: root/third_party/rust/httpdate/README.md
blob: c90c6f425290a7f77f728c51721362d6631b00ca (plain)
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
# Date and time utils for HTTP.

[![Build Status](https://travis-ci.org/pyfisch/httpdate.svg?branch=master)](https://travis-ci.org/pyfisch/httpdate)
[![Crates.io](https://img.shields.io/crates/v/httpdate.svg)](https://crates.io/crates/httpdate)
[![Documentation](https://docs.rs/httpdate/badge.svg)](https://docs.rs/httpdate)

Multiple HTTP header fields store timestamps.
For example a response created on May 15, 2015 may contain the header
`Date: Fri, 15 May 2015 15:34:21 GMT`. Since the timestamp does not
contain any timezone or leap second information it is equvivalent to
writing 1431696861 Unix time. Rust’s `SystemTime` is used to store
these timestamps.

This crate provides two public functions:

* `parse_http_date` to parse a HTTP datetime string to a system time
* `fmt_http_date` to format a system time to a IMF-fixdate

In addition it exposes the `HttpDate` type that can be used to parse
and format timestamps. Convert a sytem time to `HttpDate` and vice versa.
The `HttpType` (8 bytes) is smaller than `SystemTime` (16 bytes) and
using the display impl avoids a temporary allocation.

Read the [blog post](https://pyfisch.org/blog/http-datetime-handling/) to learn
more.

Fuzz it by installing *cargo-fuzz* and running `cargo fuzz run fuzz_target_1`.