diff --git a/Cargo.lock b/Cargo.lock index 53ea4dd..ebed510 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -13,7 +13,7 @@ dependencies = [ [[package]] name = "humantime_to_duration" -version = "0.1.4" +version = "0.2.0" dependencies = [ "regex", "time", diff --git a/src/lib.rs b/src/lib.rs index 90661c2..e826cea 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -62,7 +62,7 @@ impl From for ParseDurationError { /// * "tomorrow" /// * use "ago" for the past /// -/// [num] can be a positive or negative integer. +/// `[num]` can be a positive or negative integer. /// [unit] can be one of the following: "fortnight", "week", "day", "hour", /// "minute", "min", "second", "sec" and their plural forms. /// @@ -89,6 +89,35 @@ impl From for ParseDurationError { /// assert!(matches!(from_str("invalid"), Err(ParseDurationError::InvalidInput))); /// ``` pub fn from_str(s: &str) -> Result { + from_str_at_date(OffsetDateTime::now_utc().date(), s) +} + +/// Parses a duration string and returns a `Duration` instance, with the duration +/// calculated from the specified date. +/// +/// # Arguments +/// +/// * `date` - A `Date` instance representing the base date for the calculation +/// * `s` - A string slice representing the relative time. +/// +/// # Errors +/// +/// This function will return `Err(ParseDurationError::InvalidInput)` if the input string +/// cannot be parsed as a relative time. +/// +/// # Examples +/// +/// ``` +/// use time::{Date, Duration, OffsetDateTime}; +/// use humantime_to_duration::{from_str_at_date, ParseDurationError}; +/// let today = OffsetDateTime::now_utc().date(); +/// let yesterday = today - Duration::days(1); +/// assert_eq!( +/// from_str_at_date(yesterday, "2 days").unwrap(), +/// Duration::days(1) // 1 day from the specified date + 1 day from the input string +/// ); +/// ``` +pub fn from_str_at_date(date: Date, s: &str) -> Result { let time_pattern: Regex = Regex::new( r"(?x) (?:(?P[-+]?\d*)\s*)? @@ -160,35 +189,11 @@ pub fn from_str(s: &str) -> Result { if captures_processed == 0 { Err(ParseDurationError::InvalidInput) } else { - Ok(total_duration) - } -} - -/// Parses a duration string and returns a `Duration` instance, with the duration -/// calculated from the specified date. -/// -/// # Arguments -/// -/// * `date` - A `Date` instance representing the base date for the calculation -/// * `s` - A string slice representing the relative time. -/// -/// # Examples -/// -/// ``` -/// use time::{Date, Duration, OffsetDateTime}; -/// use humantime_to_duration::{from_str_at_date, ParseDurationError}; -/// let today = OffsetDateTime::now_utc().date(); -/// let yesterday = today - Duration::days(1); -/// assert_eq!( -/// from_str_at_date(yesterday, "2 days").unwrap(), -/// Duration::days(1) // 1 day from the specified date + 1 day from the input string -/// ); -/// ``` -pub fn from_str_at_date(date: Date, s: &str) -> Result { - let time_now = OffsetDateTime::now_utc().date(); - let date_duration = date - time_now; + let time_now = OffsetDateTime::now_utc().date(); + let date_duration = date - time_now; - Ok(from_str(s)? + date_duration) + Ok(total_duration + date_duration) + } } #[cfg(test)]