Chronos

Get the current time from the system clock.

Gets the current Day. This does not take the user's time zone into account.

Gets the Day of tomorrow.

Gets the Day of yesterday.

Get the current DayOfWeek from the system clock.

Get the yesterday's DayOfWeek from the system clock.

Get the tomorrow's DayOfWeek from the system clock.

Convert from Time to DayOfWeek.

The Unix epoch, that is 1970-01-01 00:00:00.

Measures the time it takes to run an action and evaluate its result to WHNF. This measurement uses a monotonic clock instead of the standard system clock.

Measures the time it takes to run an action. The result is discarded. This measurement uses a monotonic clock instead of the standard system clock.

Construct a Datetime from year, month, day, hour, minute, second:

>>> datetimeFromYmdhms 2014 2 26 17 58 52Datetime {datetimeDate = Date {dateYear = Year {getYear = 2014}, dateMonth = Month {getMonth = 1}, dateDay = DayOfMonth {getDayOfMonth = 26}}, datetimeTime = TimeOfDay {timeOfDayHour = 17, timeOfDayMinute = 58, timeOfDayNanoseconds = 52000000000}}

Construct a Time from year, month, day, hour, minute, second:

>>> timeFromYmdhms 2014 2 26 17 58 52Time {getTime = 1393437532000000000}

Convert Time to Datetime.

prop> \(t :: Time) -> (datetimeToTime (timeToDatetime t)) == t

Convert Datetime to Time.

prop> \(d :: Datetime) -> timeToDatetime (datetimeToTime d) == d

Convert Datetime to DayOfWeek

Convert Date to DayOfWeek

Convert Time to OffsetDatetime by providing an Offset.

Convert OffsetDatetime to Time.

Convert Time to Day. This function is lossy; consequently, it does not roundtrip with dayToTimeMidnight.

Convert midnight of the given Day to Time.

Convert Day to a Date.

prop> \(d :: Day) -> dateToDay (dayToDate d) == d

Convert a Date to a Day.

prop> \(d :: Date) -> dayToDate (dateToDay d) == d

Convert a Day to an OrdinalDate.

Convert an OrdinalDate to a Day.

Convert a MonthDate to a DayOfYear.

Convert a DayOfYear to a MonthDate.

A Timespan representing a single second.

A Timespan representing a single minute.

A Timespan representing a single hour.

A Timespan representing a single day.

A Timespan representing a single week.

Build a DayOfWeekMatch from seven (7) values.

Build a MonthMatch from twelve (12) values.

Build an UnboxedMonthMatch from twelve (12) values.

Match a DayOfWeek against a DayOfWeekMatch.

Match a Month against a MonthMatch.

Match a Month against an UnboxedMonthMatch.

The W3C DatetimeFormat.

>>> encode_YmdHMS SubsecondPrecisionAuto w3c (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"2014-02-26T17:58:52"

prop> \(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS w3c (encode_YmdHMS s w3c dt))

A DatetimeFormat that separates the members of the Date by slashes.

>>> encode_YmdHMS SubsecondPrecisionAuto slash (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"2014/02/26 17:58:52"

prop> \(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS slash (encode_YmdHMS s slash dt))

A DatetimeFormat that separates the members of the Date by hyphens.

>>> encode_YmdHMS SubsecondPrecisionAuto hyphen (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"2014-02-26 17:58:52"

prop> \(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS hyphen (encode_YmdHMS s hyphen dt))

A DatetimeFormat with no separators, except for a T between the Date and Time.

>>> encode_YmdHMS SubsecondPrecisionAuto compact (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"20140226T175852"

prop> \(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS compact (encode_YmdHMS s compact dt))

Deconstruct a Time into its TimeParts.

The Month of January.

The Month of February.

The Month of March.

The Month of April.

The Month of May.

The Month of June.

The Month of July.

The Month of August.

The Month of September.

The Month of October.

The Month of November.

The Month of December.

The DayOfWeek Sunday.

The DayOfWeek Monday.

The DayOfWeek Tuesday.

The DayOfWeek Wednesday.

The DayOfWeek Thursday.

The DayOfWeek Friday.

The DayOfWeek Saturday.

Return the number of days in a given month.

Is the Year a leap year?

>>> isLeapYear (Year 1996)True

>>> isLeapYear (Year 2019)False

All UTC time offsets. See List of UTC time offsets.

Compute the Timespan between the given date and epoch.

Convert a Timespan to its equivalent in seconds.

Given a Date and a separator, construct a Text Builder corresponding to Year/Month/Day encoding.

Given a Date and a separator, construct a Text Builder corresponding to a Day/Month/Year encoding.

Given a SubsecondPrecision and a separator, construct a Text Builder corresponding to an Hour/Minute/Second encoding.

Parse a Year/Month/Day-encoded Date that uses the given separator.

Parse a Year/Month/Day-encoded Date that either has no separators or uses any non-numeric character for each separator.

Parse a Month/Day/Year-encoded Date that uses the given separator.

Parse a Month/Day/Year-encoded Date that either has no separators or uses any non-numeric character for each separator.

Parse a Day/Month/Year-encoded Date that uses the given separator.

Parse a Day/Month/Year-encoded Date that either has no separators or uses any non-numeric character for each separator.

Given a Date and a separator, construct a ByteString Builder corresponding to a Day/Month/Year encoding.

Parse a Year/Month/Day-encoded Date that uses the given separator.

Given a MeridiemLocale, a SubsecondPrecision, and a separator, construct a Text Builder according to an IMS encoding.

This differs from builder_IMSp in that their is a space between the seconds and locale.

Given a MeridiemLocale, a SubsecondPrecision, and a separator, construct a Text Builder according to an IMS encoding.

Parse an Hour/Minute/Second-encoded TimeOfDay that uses the given separator.

Parses text that is formatted as either of the following:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Given a SubsecondPrecision and a separator, construct a ByteString Builder corresponding to an Hour/Minute/Second encoding of the given TimeOfDay.

Given a MeridiemLocale, a SubsecondPrecision, and a separator, construct a ByteString Builder corresponding to an IMS encoding of the given TimeOfDay. This differs from builderUtf8_IMSp in that there is a space between the seconds and locale.

Given a MeridiemLocale, a SubsecondPrecision, and a separator, construct a ByteString Builder corresponding to an IMS encoding of the given TimeOfDay.

Parse an Hour/Minute/Second-encoded TimeOfDay that uses the given separator.

Parses text that is formatted as either of the following:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parse a TimeOfDay that was encoded using the given separator.

Given a SubsecondPrecision and a DatetimeFormat, construct a Text Builder corresponding to a Day/Month/Year,Hour/Minute/Second encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder corresponding to a Day/Month/Year,IMS encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder corresponding to a Day/Month/Year,IMS encoding of the given Datetime. This differs from builder_DmyIMSp in that it adds a space between the locale and seconds.

Given a SubsecondPrecision and a DatetimeFormat, construct a Text Builder corresponding to a Year/Month/Day,Hour/Minute/Second encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder that corresponds to a Year/Month/Day,IMS encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder that corresponds to a Year/Month/Day,IMS encoding of the given Datetime. This inserts a space between the locale and seconds.

Construct a Text Builder corresponding to the W3C encoding of the given Datetime.

Deprecated. This is just a poorly named alias for builderIso8601.

Construct a Text Builder corresponding to the ISO-8601 encoding of the given Datetime.

Construct Text corresponding to the ISO-8601 encoding of the given Datetime.

>>> encodeIso8601 (datetimeFromYmdhms 2014 2 26 17 58 52)"2014-02-26T17:58:52"

Given a Date and a separator, construct a Text corresponding to a Year/Month/Day encoding.

>>> encode_Ymd (Just ':') (Date (Year 2022) january (DayOfMonth 13))"2022:01:13"

Given a Date and a separator, construct a Text corresponding to a Day/Month/Year encoding.

>>> encode_Dmy (Just ':') (Date (Year 2022) january (DayOfMonth 13))"13:01:2022"

Given a SubsecondPrecision and DatetimeFormat, construct Text that corresponds to a Day/Month/Year,Hour/Minute/Second encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct Text that corresponds to a Day/Month/Year,IMS encoding of the given Datetime. This inserts a space between the locale and seconds.

Given a SubsecondPrecision and DatetimeFormat, construct Text that corresponds to a Year/Month/Day,Hour/Minute/Second encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct Text that corresponds to a Year/Month/Day,IMS encoding of the given Datetime. This inserts a space between the locale and seconds.

Parse a Day/Month/Year,Hour/Minute/Second-encoded Datetime that was encoded with the given DatetimeFormat.

Parse a Day/Month/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator, such as:

01-05-2017T23:13:05 01-05-2017 23:13:05 01052017 23:13:05 01y01/2018x23;50&29

Parses a Year/Month/Day,Hour/Minute/Second-encoded Datetime that was encoded using the given DatetimeFormat.

Parses a Year/Month/Day,Hour/Minute/Second-encoded Datetime that was encoded with either no separators or any non-numeric character for each separator.

Parses a Year/Month/Date,Hour/Minute/Second-encoded Datetime from Text that was encoded with the given DatetimeFormat and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parses a Year/Month/Date,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parses text that is formatted as either of the following:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parse a Day/Month/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parses a Month/Day/Year,Hour/Minute/Second-encoded Datetime that was encoded using the given DatetimeFormat.

Parses a Month/Day/Year,Hour/Minute/Second-encoded Datetime that was encoded with either no separators or any non-numeric character for each separator.

Parse a Month/Day/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with with the given DatetimeFormat and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero.

Parse a Month/Day/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero.

Parses a Datetime from Text that was encoded with any of the following formats and with either no separators or any non-numeric character for each separator.

• %Y-%M-%D %H:%M

• %Y-%M-%D %H:%M:%S

• %D-%M-%Y %H:%M

• %D-%M-%Y %H:%M:%S

• %M-%D-%Y %H:%M

• %M-%D-%Y %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. Note that this is the least performant parser due to backtracking

Decode a Day/Month/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with the given DatetimeFormat.

Decodes Day/Month/Year,Hour/Minute/Second-encoded Datetime from Text that is encoded with either no separators or any non-numeric characters as separators, such as:

2017-01-05T23:13:05 2017-01-05 23:13:05 20170105 23:13:05 2018x01y01/23;50&29

Decode a Month/Day/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with the given DatetimeFormat.

Decode a Month/Day/Year,Hour/Minute/Second-encoded Datetime from Text with either no separators or any non-numeric character for each separator.

Decode a Month/Day/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with the given DatetimeFormat and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero.

Parse a Month/Day/Year,Hour/Minute/Second-encoded Datetime from Text with either no separators or any non-numeric character for each separator and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero.

Decode a Year/Month/Day,Hour/Minute/Second-encoded Datetime from Text that was encoded with the given DatetimeFormat.

Decode a Year/Month/Day,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator.

Decode a Year/Month/Date,Hour/Minute/Second-encoded Datetime from Text that was encoded with the given DatetimeFormat and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Decode a Year/Month/Date,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Decode a Day/Month/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with with the given DatetimeFormat and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Decode a Day/Month/Year,Hour/Minute/Second-encoded Datetime from Text that was encoded with either no separators or any non-numeric character for each separator and with either of the following time formats:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parses text that was encoded in DMY, YMD, or MDY format with optional seconds and any non-numeric character as separators.

Decode an ISO-8601-encode datetime. The encoded time must be suffixed by either Z or +00:00 or +00.

Given a SubsecondPrecision and a DatetimeFormat, construct a ByteString corresponding to a Year/Month/Day,Hour/Minute/Second encoding of the given Datetime.

Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a ByteString corresponding to a Year/Month/Day,IMS encoding of the given Datetime. This inserts a space between the locale and seconds.

Given a SubsecondPrecision and a DatetimeFormat, construct a ByteString Builder corresponding to a Year/Month/Day,Hour/Minute/Second encoding of the given Datetime.

Given a SubsecondPrecision and a DatetimeFormat, construct a ByteString Builder corresponding to a Year/Month/Day,IMS encoding of the given Datetime.

Given a SubsecondPrecision and a DatetimeFormat, construct a ByteString Builder corresponding to a Year/Month/Day,IMS encoding of the given Datetime. This inserts a space between the locale and seconds.

Construct a ByteString Builder corresponding to a W3C encoding of the given Datetime.

Decode a Year/Month/Day,Hour/Minute/Second-encoded Datetime from a ByteString.

Parses text that is formatted as either of the following:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parse a Year/Month/Day,Hour/Minute/Second-encoded Datetime that was encoded using the given DatetimeFormat.

Parses text that is formatted as either of the following:

• %H:%M

• %H:%M:%S

That is, the seconds and subseconds part is optional. If it is not provided, it is assumed to be zero. This format shows up in Google Chrome's datetime-local inputs.

Parse a Datetime that was encoded using the given DatetimeFormat.

Encode a datetime with ISO-8601. The result does not include any indication of a time zone. If the subsecond part is zero, it is suppressed. Examples of output:

2021-01-05T23:00:51
2021-01-05T23:00:52.123
2021-01-05T23:00:53.674094347

Decode an ISO-8601-encode datetime.

Decode a datetime that is nearly ISO-8601-encoded but uses a space instead of a T to separate the date and the time. For example: 2022-10-29 14:00:05.

Decode an ISO-8601-encode datetime. The encoded time must be suffixed by either Z or +00:00 or +00.

Decode an ISO-8601-encode datetime. The encoded time must not be suffixed by an offset. Any offset (e.g. -05:00, +00:00, Z) will cause a decode failure.

Given an OffsetFormat, a SubsecondPrecision, and a DatetimeFormat, construct Text corresponding to the Year/Month/Day,Hour/Minute/Second-encoding of the given OffsetDatetime.

Given an OffsetFormat, a SubsecondPrecision, and a DatetimeFormat, construct Text corresponding to the Day/Month/Year,Hour/Minute/Second encoding of the given OffsetDatetime.

Given an OffsetFormat, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder corresponding to a Year/Month/Day,Hour/Minute/Second encoding of the given OffsetDatetime.

Given an OffsetFormat, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder corresponding to the Day/Month/Year,Hour/Minute/Second-encoding of the given OffsetDatetime.

Parse a Year/Month/Day,Hour/Minute/Second-encoded OffsetDatetime that was encoded using the given OffsetFormat and DatetimeFormat.

Parse a Day/Month/Year,Hour/Minute/Second-encoded OffsetDatetime that was encoded using the given OffsetFormat and DatetimeFormat.

Given an OffsetFormat, a MeridiemLocale, a SubsecondPrecision, and DatetimeFormat, construct a Text Builder corresponding to a Year/Month/Day,IMS-encoding of the given OffsetDatetime.

Given an OffsetFormat, a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a Text Builder corresponding to the Day/Month/Year,IMS encoding of the given OffsetDatetime.

Construct a Text Builder corresponding to the w3c-formatting of the given OffsetDatetime.

Given an OffsetFormat, a SubsecondPrecision, and a DatetimeFormat, construct a ByteString Builder corresponding to the Year/Month/Day,Hour/Minute/Second encoding of the given OffsetDatetime.

Parse a Year/Month/Day,Hour/Minute/Second-encoded OffsetDatetime that was encoded using the given OffsetFormat and DatetimeFormat.

Given an OffsetFormat, a 'MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat, construct a ByteString Builder corresponding to a Year/Month/Day,IMS-encoded OffsetDatetime.

Construct a ByteString Builder corresponding to the W3C encoding of the given Datetime.

Consume an ISO-8601-encoded datetime with offset. This will consume any of the following:

2021-12-05T23:01:09Z
2021-12-05T23:01:09.000Z
2021-12-05T23:01:09.123456789Z
2021-12-05T23:01:09+05:00
2021-12-05T23:01:09.357-11:00

Decode an ISO-8601-encode datetime. The encoded time must include an offset (e.g. -05:00, +00:00, Z).

Encode an Offset to Text using the given OffsetFormat.

Construct a Builder corresponding to the given Offset encoded using the given OffsetFormat.

Decode an Offset from Text that was encoded using the given OffsetFormat.

Parse an Offset that was encoded using the given OffsetFormat.

Encode an Offset as a ByteString using the given OffsetFormat.

Construct a ByteString Builder corresponding to the encoding of an Offset using the given OffsetFormat.

Decode an Offset from a ByteString that was encoded using the given OffsetFormat.

Parse an Offset that was encoded using the given OffsetFormat.

Encode a Timespan as Text using the given SubsecondPrecision.

Construct a Text Builder corresponding to an encoding of the given Timespan using the given SubsecondPrecision.

Given a SubsecondPrecision, construct a ByteString corresponding to an encoding of the given Timespan.

Given a SubsecondPrecision, construct a ByteString Builder corresponding to an encoding of the given Timespan.

Is the given Time within the TimeInterval?

Convert a TimeInterval to a Timespan. This is equivalent to width.

The TimeInterval that covers the entire range of Times that Chronos supports.

prop> \(t :: Time) -> within t whole

The singleton (degenerate) TimeInterval.

Get the lower bound of the TimeInterval.

Get the upper bound of the TimeInterval.

The width of the TimeInterval. This is equivalent to timeIntervalToTimespan.

A smart constructor for TimeInterval. In general, you should prefer using this over the TimeInterval constructor, since it maintains the invariant that lowerBound interval <= upperBound interval.

An infix timeIntervalBuilder.