You've already forked parse_datetime
mirror of
https://github.com/uutils/parse_datetime.git
synced 2026-06-10 16:13:15 -07:00
Ben Schofield
e53aabd914
Add a relaxed datetime parser. This datetime parser functions by using `chrono`s
own parsing utilities and a try/succeed approach to parsing.
This implementation of the datetime parser has some drawbacks and some
positives. On the positive side:
- it was easy to implement
- it is easy to add more datetime formats to
In order to add additionally supported formats, a developer can add the
required format string to the `format` mod in `parse_datetime.rs`, and
then add it as a potential format to the relevant `fmts` vec.
On the negative:
- It is not easily customiseable beyond the supported `chrono` parsing
formats. E.g., `chrono` does not currently support parsing offsets
without trailing zeros. `from_str("UTC+1")` should return a valid response
but `chrono` fails to parse this.
- Because it is an attempt driven parser, it is likely not that
performant. I have not done any performance testing as part of this
change, but I would expect a custom parser to perform much better.
humantime_to_duration
A Rust crate for parsing human-readable relative time strings and converting them to a Duration.
Features
- Parses a variety of human-readable time formats.
- Supports positive and negative durations.
- Allows for chaining time units (e.g., "1 hour 2 minutes" or "2 days and 2 hours").
- Calculate durations relative to a specified date.
- Relies on Chrono
Usage
Add this to your Cargo.toml:
[dependencies]
humantime_to_duration = "0.3.0"
Then, import the crate and use the from_str and from_str_at_date functions:
use humantime_to_duration::{from_str, from_str_at_date};
use chrono::Duration;
let duration = from_str("+3 days");
assert_eq!(duration.unwrap(), Duration::days(3));
let today = Utc::today().naive_utc();
let yesterday = today - Duration::days(1);
assert_eq!(
from_str_at_date(yesterday, "2 days").unwrap(),
Duration::days(1)
);
Supported Formats
The from_str and from_str_at_date functions support the following formats for relative time:
numunit(e.g., "-1 hour", "+3 days")unit(e.g., "hour", "day")- "now" or "today"
- "yesterday"
- "tomorrow"
- use "ago" for the past
- combined units with "and" or "," (e.g., "2 years and 1 month", "1 day, 2 hours" or "2 weeks 1 second")
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.
Return Values
The from_str and from_str_at_date functions return:
Ok(Duration)- If the input string can be parsed as a relative timeErr(ParseDurationError)- If the input string cannot be parsed as a relative time
This function will return Err(ParseDurationError::InvalidInput) if the input string
cannot be parsed as a relative time.
Fuzzer
To run the fuzzer:
$ cargo fuzz run fuzz_from_str
License
This project is licensed under the MIT License.