Data.Time.Compat

A simple day and time aggregate, where the day is of the specified parameter, and the time is a TimeOfDay. Conversion of this (as local civil time) to UTC depends on the time zone. Conversion of this (as local mean time) to UT1 depends on the longitude.

Scale by a factor. Note that scaleCalendarDiffDays (-1) will not perfectly invert a duration, due to variable month lengths.

A list of all the days in this period.

Get the period this day is in, with the 1-based day number within the period.

periodFromDay (periodFirstDay p) = (p,1)

The number of days in this period.

Inverse of periodFromDay.

Validating inverse of periodFromDay.

Bidirectional abstract constructor for the proleptic Gregorian calendar. Invalid values will be clipped to the correct range, month first, then day.

Add months (clipped to last day), then add days

Add months (rolling over to next month), then add days

Add months, with days past the last day of the month clipped to the last day. For instance, 2005-01-30 + 1 month = 2005-02-28.

Add months, with days past the last day of the month rolling over to the next month. For instance, 2005-01-30 + 1 month = 2005-03-02.

Add years, matching month and day, with Feb 29th clipped to Feb 28th if necessary. For instance, 2004-02-29 + 2 years = 2006-02-28.

Add years, matching month and day, with Feb 29th rolled over to Mar 1st if necessary. For instance, 2004-02-29 + 2 years = 2006-03-01.

Calendrical difference, with as many whole months as possible

Calendrical difference, with as many whole months as possible.

Convert from proleptic Gregorian calendar. Invalid values will be clipped to the correct range, month first, then day.

Convert from proleptic Gregorian calendar. Invalid values will return Nothing

The number of days in a given month according to the proleptic Gregorian calendar.

Show in ISO 8601 format (yyyy-mm-dd)

Convert to proleptic Gregorian calendar.

Is this year a leap year according to the proleptic Gregorian calendar?

Also known as Before Christ. Note that Year 1 = 1 CE, and the previous Year 0 = 1 BCE. CommonEra and BeforeCommonEra form a COMPLETE set.

Also known as Anno Domini.

The twelve MonthOfYear patterns form a COMPLETE set.

dayOfWeekDiff a b = a - b in range 0 to 6. The number of days from b to the next a.

The first day-of-week on or after some day

Returns a week containing the given Day where the first day is the DayOfWeek specified.

Examples:

>>> weekAllDays Sunday (YearMonthDay 2022 02 21)[YearMonthDay 2022 2 20 .. YearMonthDay 2022 2 26]

>>> weekAllDays Monday (YearMonthDay 2022 02 21)[YearMonthDay 2022 2 21 .. YearMonthDay 2022 2 27]

>>> weekAllDays Tuesday (YearMonthDay 2022 02 21)[YearMonthDay 2022 2 15 .. YearMonthDay 2022 2 21]

Returns the first day of a week containing the given Day.

Examples:

>>> weekFirstDay Sunday (YearMonthDay 2022 02 21)YearMonthDay 2022 2 20

>>> weekFirstDay Monday (YearMonthDay 2022 02 21)YearMonthDay 2022 2 21

>>> weekFirstDay Tuesday (YearMonthDay 2022 02 21)YearMonthDay 2022 2 15

Returns the last day of a week containing the given Day.

Examples:

>>> weekLastDay Sunday (YearMonthDay 2022 02 21)YearMonthDay 2022 2 26

>>> weekLastDay Monday (YearMonthDay 2022 02 21)YearMonthDay 2022 2 27

>>> weekLastDay Tuesday (YearMonthDay 2022 02 21)YearMonthDay 2022 2 21

Get the number of picoseconds in a DiffTime.

Create a DiffTime from a number of picoseconds.

Create a DiffTime which represents an integral number of seconds.

One day in NominalDiffTime.

Get the seconds in a NominalDiffTime.

Create a NominalDiffTime from a number of seconds.

The resolution of getSystemTime, getCurrentTime, getPOSIXTime. On UNIX systems this uses clock_getres, which may be wrong on WSL2.

addUTCTime a b = a + b

diffUTCTime a b = a - b

Get the current UTCTime from the system clock.

Substitute various time-related information for each %-code in the string, as per formatCharacter.

The general form is %<modifier><width><alternate><specifier>, where <modifier>, <width>, and <alternate> are optional.

<modifier>

glibc-style modifiers can be used before the specifier (here marked as z):

%-z

no padding

%_z

pad with spaces

%0z

pad with zeros

%^z

convert to upper case

%#z

convert to lower case (consistently, unlike glibc)

<width>

Width digits can also be used after any modifiers and before the specifier (here marked as z), for example:

%4z

pad to 4 characters (with default padding character)

%_12z

pad with spaces to 12 characters

<alternate>

An optional E character indicates an alternate formatting. Currently this only affects %Z and %z.

%Ez

alternate formatting

<specifier>

For all types (note these three are done by formatTime, not by formatCharacter):

%%

%

%t

tab

%n

newline

TimeZone

For TimeZone (and ZonedTime and UTCTime):

%z

timezone offset in the format

±HHMM

%Ez

timezone offset in the format

±HH:MM

%Z

timezone name (or else offset in the format

±HHMM

)

%EZ

timezone name (or else offset in the format

±HH:MM

)

LocalTime

For LocalTime (and ZonedTime and UTCTime and UniversalTime):

%c

as

dateTimeFmt

locale

(e.g.

%a %b %e %H:%M:%S %Z %Y

)

TimeOfDay

For TimeOfDay (and LocalTime and ZonedTime and UTCTime and UniversalTime):

%R

same as

%H:%M

%T

same as

%H:%M:%S

%X

as

timeFmt

locale

(e.g.

%H:%M:%S

)

%r

as

time12Fmt

locale

(e.g.

%I:%M:%S %p

)

%P

day-half of day from (

amPm

locale

), converted to lowercase,

am

,

pm

%p

day-half of day from (

amPm

locale

),

AM

,

PM

%H

hour of day (24-hour), 0-padded to two chars,

00

-

23

%k

hour of day (24-hour), space-padded to two chars,

0

-

23

%I

hour of day-half (12-hour), 0-padded to two chars,

01

-

12

%l

hour of day-half (12-hour), space-padded to two chars,

1

-

12

%M

minute of hour, 0-padded to two chars,

00

-

59

%S

second of minute (without decimal part), 0-padded to two chars,

00

-

60

%q

picosecond of second, 0-padded to twelve chars,

000000000000

-

999999999999

.

%Q

decimal point and fraction of second, up to 12 second decimals, without trailing zeros. For a whole number of seconds,

%Q

omits the decimal point unless padding is specified.

UTCTime and ZonedTime

For UTCTime and ZonedTime:

%s

number of whole seconds since the Unix epoch. For times before the Unix epoch, this is a negative number. Note that in

%s.%q

and

%s%Q

the decimals are positive, not negative. For example, 0.9 seconds before the Unix epoch is formatted as

-1.1

with

%s%Q

.

DayOfWeek

For DayOfWeek (and Day and LocalTime and ZonedTime and UTCTime and UniversalTime):

%u

day of week number for Week Date format,

1

(= Monday) -

7

(= Sunday)

%w

day of week number,

0

(= Sunday) -

6

(= Saturday)

%a

day of week, short form (

snd

from

wDays

locale

),

Sun

-

Sat

%A

day of week, long form (

fst

from

wDays

locale

),

Sunday

-

Saturday

Month

For Month (and Day and LocalTime and ZonedTime and UTCTime and UniversalTime):

%Y

year, no padding. Note

%0Y

and

%_Y

pad to four chars

%y

year of century, 0-padded to two chars,

00

-

99

%C

century, no padding. Note

%0C

and

%_C

pad to two chars

%B

month name, long form (

fst

from

months

locale

),

January

-

December

%b, %h

month name, short form (

snd

from

months

locale

),

Jan

-

Dec

%m

month of year, 0-padded to two chars,

01

-

12

Day

For Day (and LocalTime and ZonedTime and UTCTime and UniversalTime):

%D

same as

%m/%d/%y

%F

same as

%Y-%m-%d

%x

as

dateFmt

locale

(e.g.

%m/%d/%y

)

%d

day of month, 0-padded to two chars,

01

-

31

%e

day of month, space-padded to two chars,

1

-

31

%j

day of year, 0-padded to three chars,

001

-

366

%f

century for Week Date format, no padding. Note

%0f

and

%_f

pad to two chars

%V

week of year for Week Date format, 0-padded to two chars,

01

-

53

%U

week of year where weeks start on Sunday (as

sundayStartWeek

), 0-padded to two chars,

00

-

53

%W

week of year where weeks start on Monday (as

mondayStartWeek

), 0-padded to two chars,

00

-

53

Duration types

The specifiers for DiffTime, NominalDiffTime, CalendarDiffDays, and CalendarDiffTime are semantically separate from the other types. Specifiers on negative time differences will generally be negative (think rem rather than mod).

NominalDiffTime and DiffTime

Note that a "minute" of DiffTime is simply 60 SI seconds, rather than a minute of civil time. Use NominalDiffTime to work with civil time, ignoring any leap seconds.

For NominalDiffTime and DiffTime:

%w

total whole weeks

%d

total whole days

%D

whole days of week

%h

total whole hours

%H

whole hours of day

%m

total whole minutes

%M

whole minutes of hour

%s

total whole seconds

%Es

total seconds, with decimal point and up to <width> (default 12) decimal places, without trailing zeros. For a whole number of seconds,

%Es

omits the decimal point unless padding is specified.

%0Es

total seconds, with decimal point and <width> (default 12) decimal places.

%S

whole seconds of minute

%ES

seconds of minute, with decimal point and up to <width> (default 12) decimal places, without trailing zeros. For a whole number of seconds,

%ES

omits the decimal point unless padding is specified.

%0ES

seconds of minute as two digits, with decimal point and <width> (default 12) decimal places.

CalendarDiffDays

For CalendarDiffDays (and CalendarDiffTime):

%y

total years

%b

total months

%B

months of year

%w

total weeks, not including months

%d

total days, not including months

%D

days of week

CalendarDiffTime

For CalendarDiffTime:

%h

total hours, not including months

%H

hours of day

%m

total minutes, not including months

%M

minutes of hour

%s

total whole seconds, not including months

%Es

total seconds, not including months, with decimal point and up to <width> (default 12) decimal places, without trailing zeros. For a whole number of seconds,

%Es

omits the decimal point unless padding is specified.

%0Es

total seconds, not including months, with decimal point and <width> (default 12) decimal places.

%S

whole seconds of minute

%ES

seconds of minute, with decimal point and up to <width> (default 12) decimal places, without trailing zeros. For a whole number of seconds,

%ES

omits the decimal point unless padding is specified.

%0ES

seconds of minute as two digits, with decimal point and <width> (default 12) decimal places.

Locale representing American usage.

knownTimeZones contains only the ten time-zones mentioned in RFC 822 sec. 5: "UT", "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", "PDT". Note that the parsing functions will regardless parse "UTC", single-letter military time-zones, and +HHMM format.

Construct format string according to ISO-8601.

The Maybe String argument allows to supply an optional time specification. E.g.:

iso8601DateFormat Nothing            == "%Y-%m-%d"           -- i.e. YYYY-MM-DD
iso8601DateFormat (Just "%H:%M:%S")  == "%Y-%m-%dT%H:%M:%S"  -- i.e. YYYY-MM-DDTHH:MM:SS

Format string according to RFC822.

Parses a time value given a format string. Missing information will be derived from 1970-01-01 00:00 UTC (which was a Thursday). Supports the same %-codes as formatTime, including %-, %_ and %0 modifiers, however padding widths are not supported. Case is not significant in the input string. Some variations in the input are accepted:

%z %Ez

accepts any of

±HHMM

or

±HH:MM

.

%Z %EZ

accepts any string of letters, or any of the formats accepted by

%z

.

%0Y

accepts exactly four digits.

%0G

accepts exactly four digits.

%0C

accepts exactly two digits.

%0f

accepts exactly two digits.

For example, to parse a date in YYYY-MM-DD format, while allowing the month and date to have optional leading zeros (notice the - modifier used for %m and %d):

Prelude Data.Time> parseTimeM True defaultTimeLocale "%Y-%-m-%-d" "2010-3-04" :: Maybe Day
Just 2010-03-04

Parse a time value given a format string. Fails if the input could not be parsed using the given format. See parseTimeM for details.

Parse a time value given a format string. See parseTimeM for details.

Parse a time value given a format string. See parseTimeM for details.

Scale by a factor. Note that scaleCalendarDiffTime (-1) will not perfectly invert a duration, due to variable month lengths.

addLocalTime a b = a + b

diffLocalTime a b = a - b

Get the UT1 time of a local time on a particular meridian (in degrees, positive is East).

Get the UTC time of a local time in a time zone.

Get the local time of a UT1 time on a particular meridian (in degrees, positive is East).

Get the local time of a UTC time in a time zone.

Get the time of day given the fraction of a day since midnight.

Convert a count of days and a time of day since midnight into a period of time.

Convert a time of day in some timezone to a time of day in UTC, together with a day adjustment.

Hour twelve

Hour zero

Same as timeToTimeOfDay.

Same as timeOfDayToTime.

Get the fraction of a day since midnight given a time of day.

Get the time since midnight for a given time of day.

Convert a period of time into a count of days and a time of day since midnight. The time of day will never have a leap second.

Get the time of day given a time since midnight. Time more than 24h will be converted to leap-seconds.

Convert a time of day in UTC to a time of day in some timezone, together with a day adjustment.

Get the configured time-zone for the current time.

Get the configured time-zone for a given time (varying as per summertime adjustments).

On Unix systems the output of this function depends on:

1. The value of TZ environment variable (if set)

2. The system time zone (usually configured by /etc/localtime symlink)

For details see tzset(3) and localtime(3).

Example:

> let t = UTCTime (fromGregorian 2021 7 1) 0
> getTimeZone t
CEST
> setEnv "TZ" "America/New_York" >> getTimeZone t
EDT
> setEnv "TZ" "Europe/Berlin" >> getTimeZone t
CEST

On Windows systems the output of this function depends on:

1. The value of TZ environment variable (if set). See here for how Windows interprets this variable.

2. The system time zone, configured in Settings

Create a nameless non-summer timezone for this number of hours.

Create a nameless non-summer timezone for this number of minutes.

Text representing the offset of this timezone, such as "-0800" or "+0400" (like %z in formatTime).

Text representing the offset of this timezone, such as "-0800" or "+0400" (like %z in formatTime), with arbitrary padding.

The UTC time zone.

The Modified Julian Day is a standard count of days, with zero being the day 1858-11-17.

The class of types which can be represented as a period of days.

Day of month, in range 1 to 31.

Month of year, in range 1 (January) to 12 (December).

Year of Common Era (when positive).

This is a length of time, as measured by a clock. Conversion functions such as fromInteger and realToFrac will treat it as seconds. For example, (0.010 :: DiffTime) corresponds to 10 milliseconds.

It has a precision of one picosecond (= 10^-12 s). Enumeration functions will treat it as picoseconds.

This is a length of time, as measured by UTC. It has a precision of 10^-12 s.

Conversion functions such as fromInteger and realToFrac will treat it as seconds. For example, (0.010 :: NominalDiffTime) corresponds to 10 milliseconds.

It has a precision of one picosecond (= 10^-12 s). Enumeration functions will treat it as picoseconds.

It ignores leap-seconds, so it's not necessarily a fixed amount of clock time. For instance, 23:00 UTC + 2 hours of NominalDiffTime = 01:00 UTC (+ 1 day), regardless of whether a leap-second intervened.

This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.

The Modified Julian Date is the day with the fraction of the day, measured from UT midnight. It's used to represent UT1, which is time as measured by the earth's rotation, adjusted for various wobbles.

The class of types which can be parsed given a UNIX-style time format string.

Time of day as represented in hour, minute and second (with picoseconds), typically used to express local time of day.

TimeOfDay 24 0 0 is considered invalid for the purposes of makeTimeOfDayValid, as well as reading and parsing, but valid for ISO 8601 parsing in Data.Time.Format.ISO8601.

A TimeZone is a whole number of minutes offset from UTC, together with a name and a "just for summer" flag.

A local time together with a time zone.

There is no Eq instance for ZonedTime. If you want to compare local times, use zonedTimeToLocalTime. If you want to compare absolute times, use zonedTimeToUTC.