DateTime: High-Level Date and Time for Rust

Date_Time is a high-level rust library for use in situations where precision beyond seconds is not necessary.

It handles serialisable dates and times from 01 Jan 0000 at 00:00:00 to Dec 31 9999 at 23:59:59.

Note: This README may contain documentation of features which have not been released yet. To ensure it is accurate for a specific version, use the tag selector and select the version you're using.

Changelog - Note Version 2.0.0 includes a breaking change.

Code of Conduct

Usage

Put this in your Cargo.toml:

[dependencies]
date_time = "2.1.1"

Then put this in your crate root:

extern crate date_time;

Overview

All of the types in this library implement Debug, Copy, and Clone traits.

Naming

This library was originally a port from a closed-source Kotlin library with similar functionality. As such, each of the types are suffixed with "Tuple".

Type aliases exist without the Tuple suffixes from version 1.2.1 onwards.

There is a new replacement of the Kotlin library available here.

Serde Support

Types exported by this library have Serialize and Deserialize implementations behind the serde_support feature flag.

Times

TimeTuple

Times can be generated using the timetuple::TimeTuple type.

Times must either be instantiated using TimeTuple::new() which takes hour, minute, and second parameters or TimeTuple::from_seconds(), which just takes a total number of seconds. These are then converted into seconds and split apart again to create a tuple between 00:00:00 and 23:59:59.

TimeTuple implements the following traits and is therefore fully comparable with other TimeTuples.

• PartialOrd
• Ord
• PartialEq
• Eq

It can also be added to and subtracted from another TimeTuple, but the user must be aware that this will loop around midnight.

For example:

• TimeTuple::new(22, 0, 0) + TimeTuple::new(1, 0, 0) will produce TimeTuple { h: 23, m: 0, s:0 }
• TimeTuple::new(22, 0, 0) + TimeTuple::new(3, 0, 0) will produce TimeTuple { h: 1, m: 0, s:0 }

Serialisation

TimeTuple can be serialised using to_string() (generated from Display trait) and to_hhmm_string().

For 8:30:30 AM, the former will produce "08:30:30" and the latter will produce "08:30".

A TimeTuple can be instantiated by calling TimeTuple::from_str() with a string in the format of hh:mm:ss.

Mutation

The following methods exist to manipulate an existing TimeTuple:

• add_seconds()
• subtract_seconds()
• add_minutes()
• subtract_minutes()
• add_hours()
• subtract_hours()

Each takes a single argument of the number to add/subtract. These methods all wrap such that the resulting time is a valid time between 00:00:00 and 23:59:59.

Duration

A second time type, Duration exists for cases where a duration should be stored in hours, minutes and seconds. This is similar to the TimeTuple type but allows hours to be greater than 24.

The difference between any two DateTimes can be calculated using Duration::between().

Dates

Dates can be generated using the datetuple::DateTuple and monthtuple::MonthTuple types. The MonthTuple type is similar to DateTuple but doesn't include a day of the month.

DateTuple

DateTuple wraps a year, month, and day of month in a struct.

A DateTuple can be created using DateTuple::new(), passing a year between 0 and 9999 and a month and date which are valid for that year. Feb 29 can be created if the year is a leap year.

A DateTuple can be converted to and from a number of days as a u32 using the to_days() and from_days() methods. The number of days referenced is the number of days between 0000-01-01 and the DateTuple's value inclusive.

DateTuple is fully comparable with another DateTuple and implements PartialOrd, Ord, PartialEq, and Eq.

Serialisation

DateTuple can be serialised using to_string() (generated from Display trait) and to_readable_string().

For 23rd January 2002, the former will produce "2002-01-23" and the latter will produce "23 Jan 2002".

A DateTuple can be instantiated by calling DateTuple::from_str() with a string in the format of yyyy-mm-dd.

If listing multiple DateTuple objects in a human readable format, you may wish to pad them with a space to the left to ensure alignment. This can be done with the format specifier {:>11} in a call such as format!().

Mutation

The following methods exist to manipulate an existing DateTuple:

• add_days()
• subtract_days()
• add_months()
• subtract_months()
• add_years()
• subtract_years()

Each takes a single argument of the number to add/subtract. These methods will always return a valid date. If the date were to fall after the end of a month, such as after adding one year to Feb 29 on a leap year, the last valid date in the month will be returned.

The following two methods consume a DateTuple and return another:

• next_date()
• previous_date()

They work similarly to next_month() and previous_month() described below.

MonthTuple

MonthTuple is identical to DateTuple but without a day of the month.

It can be instantiated using MonthTuple::new(), passing a year between 0000 and 9999 and a month between 1 and 12.

MonthTuple is fully comparable with another MonthTuple and implements PartialOrd, Ord, PartialEq, and Eq.

MonthTuple also implements From<DateTuple> so a DateTuple can be converted to a MonthTuple using MonthTuple::from(date_tuple: DateTuple).

Mutation

The following methods exist to manipulate an existing MonthTuple:

• add_months()
• subtract_months()
• add_years()
• subtract_years()

Each takes a single argument of the number to add/subtract.

next_month and previous_month

MonthTuple provides two methods: next_month and previous_month which consume the MonthTuple and return the MonthTuple which chronologically follows or precedes it.

These will continue to return the maximum and minimum values of Jan 0000 and Dec 9999 if they are reached.

These methods consume the existing MonthTuple.

Serialisation

MonthTuple can be serialised using to_string() (generated from Display trait) and to_readable_string().

For January 2002, the former will produce "2002-01" and the latter will produce "Jan 2002".

A MonthTuple can be instantiated by calling MonthTuple::from_str() with a string in the format of yyyy-mm.

DateTime

The date_time_tuple::DateTimeTuple type wraps a DateTuple and a TimeTuple.

Like the other modules in this library, it is fully comparable with other DateTimeTuple structs.

The difference between two DateTimes can be calculated using Duration::between().

Serialisation

DateTimeTuple can be serialised using to_string() (generated from Display trait) and to_readable_string().

For 23rd January 2002 at 08:30:30 AM, the former will produce "2002-01-23@08:30:30" and the latter will produce "23 Jan 2002 08:30:30".

A DateTimeTuple can be instantiated by calling DateTimeTuple::from_str() with a string in the format of yyyy-mm-dd@hh:mm:ss.

Limitations

This library was designed for high-level implementations of dates in which precision is not necessary.

For a more precise wrapper of dates, try a crate such as chrono.

• This library is only designed for use when dates need only to be precise to the level of seconds.
• This library is timezone-agnostic; it doesn't deal with any difference between time zones.
• Only datetimes between 01 Jan 0000 00:00:00 and 31 Dec 9999 23:59:59 are supported.

Vulnerabilities

Vulnerabilities should be reported through GitHub issues (or confidentially by email to 44178347+notquiteamonad@users.noreply.github.com).

Dependabot is being used by this repository to ensure dependencies are kept up-to-date, meaning security fixes will be applied as quickly as possible once vulnerabilities are patched in dependencies.