From e3c0114833d796d8ee2880292335363507ab2d1f Mon Sep 17 00:00:00 2001 From: Kartikaya Gupta Date: Sun, 2 Oct 2016 15:57:14 -0400 Subject: Add dateparse documentation --- src/dateparse.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/dateparse.rs b/src/dateparse.rs index 1ce6e65..786fc1e 100644 --- a/src/dateparse.rs +++ b/src/dateparse.rs @@ -64,6 +64,15 @@ fn seconds_to_date(year: i64, month: i64, day: i64) -> i64 { result + 86400 * (day - 1) } +/// Convert a date field from an email header into a UNIX epoch timestamp. +/// This function handles the most common formatting of date fields found in +/// email headers. It may fail to parse some of the more creative formattings. +/// +/// # Examples +/// ``` +/// use mailparse::dateparse; +/// assert_eq!(dateparse("Sun, 02 Oct 2016 07:06:22 -0700 (PDT)").unwrap(), 1475417182); +/// ``` pub fn dateparse(date: &str) -> Result { let mut result = 0; let mut month = 0; -- cgit v1.2.3