Data.Time.Calendar.Compat · time-compat-1.9.8

Days

3 declarations

newtypenewtype Day

#

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

Constructors

ModifiedJulianDay
- toModifiedJulianDay :: Integer

Instances16Enum, Eq, Data, Ord, Read, Show, …

Enum DayDefined in time-1.12.2 · Data.Time.Calendar.Days
Eq DayDefined in time-1.12.2 · Data.Time.Calendar.Days
Data DayDefined in time-1.12.2 · Data.Time.Calendar.Days
Ord DayDefined in time-1.12.2 · Data.Time.Calendar.Days
Read DayDefined in time-1.12.2 · Data.Time.Format.Parse · orphan
Show DayDefined in time-1.12.2 · Data.Time.Calendar.Gregorian · orphan
Ix DayDefined in time-1.12.2 · Data.Time.Calendar.Days
Generic DayDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan
NFData DayDefined in time-1.12.2 · Data.Time.Calendar.Days
Hashable DayDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan
DayPeriod DayDefined in time-1.12.2 · Data.Time.Calendar.Days
FormatTime DayDefined in time-1.12.2 · Data.Time.Format.Format.Instances · orphan
ParseTime DayDefined in time-1.12.2 · Data.Time.Format.Parse.Instances · orphan
ISO8601 DayDefined in time-1.12.2 · Data.Time.Format.ISO8601
yyyy-mm-dd (ISO 8601:2004(E) sec. 4.1.2.2 extended format)
Lift DayDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan
type Rep Day = D1 ('MetaData "Day" "Data.Time.Calendar.Days" "time-1.12.2-cfd2" 'True) (C1 ('MetaCons "ModifiedJulianDay" 'PrefixI 'True) (S1 ('MetaSel ('Just "toModifiedJulianDay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))Defined in time-compat-1.9.8 · Data.Time.Orphans · orphan

valueaddDays :: Integer -> Day -> Day

#

valuediffDays :: Day -> Day -> Integer

#

DayPeriod

6 declarations

classclass Ord p => DayPeriod p where

#

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

Methods

periodFirstDay :: p -> Day
Returns the first Day in a period of days.
periodLastDay :: p -> Day
Returns the last Day in a period of days.
dayPeriod :: Day -> p
Get the period this day is in.

Instances4DayPeriod

DayPeriod DayDefined in time-1.12.2 · Data.Time.Calendar.Days
DayPeriod MonthDefined in time-1.12.2 · Data.Time.Calendar.Month
DayPeriod QuarterDefined in time-1.12.2 · Data.Time.Calendar.Quarter
DayPeriod YearDefined in time-1.12.2 · Data.Time.Calendar.Gregorian · orphan

valueperiodAllDays :: DayPeriod p => p -> [Day]

#

A list of all the days in this period.

valueperiodLength :: DayPeriod p => p -> Int

#

The number of days in this period.

valueperiodFromDay :: DayPeriod p => Day -> (p, Int)

#

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

periodFromDay (periodFirstDay p) = (p,1)

valueperiodToDay :: DayPeriod p => p -> Int -> Day

#

Inverse of periodFromDay.

valueperiodToDayValid :: DayPeriod p => p -> Int -> Maybe Day

#

Validating inverse of periodFromDay.

CalendarDiffTime

6 declarations

datadata CalendarDiffDays

#

Constructors

CalendarDiffDays
- cdMonths :: Integer
- cdDays :: Integer

Instances12Eq, Data, Show, Generic, Semigroup, Monoid, …

Eq CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Calendar.CalendarDiffDays
Data CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Calendar.CalendarDiffDays
Show CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Calendar.CalendarDiffDays
Generic CalendarDiffDaysDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan
Semigroup CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Calendar.CalendarDiffDays
Additive
Monoid CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Calendar.CalendarDiffDays
Additive
NFData CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Calendar.CalendarDiffDays
FormatTime CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Format.Format.Instances · orphan
ParseTime CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Format.Parse.Instances · orphan
ISO8601 CalendarDiffDaysDefined in time-1.12.2 · Data.Time.Format.ISO8601
PyYmMdD (ISO 8601:2004(E) sec. 4.4.3.2)
Lift CalendarDiffDaysDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan
type Rep CalendarDiffDays = D1 ('MetaData "CalendarDiffDays" "Data.Time.Calendar.CalendarDiffDays" "time-1.12.2-cfd2" 'False) (C1 ('MetaCons "CalendarDiffDays" 'PrefixI 'True) (S1 ('MetaSel ('Just "cdMonths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "cdDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))Defined in time-compat-1.9.8 · Data.Time.Orphans · orphan

valuecalendarDay :: CalendarDiffDays

#

valuecalendarWeek :: CalendarDiffDays

#

valuecalendarMonth :: CalendarDiffDays

#

valuecalendarYear :: CalendarDiffDays

#

valuescaleCalendarDiffDays :: Integer -> CalendarDiffDays -> CalendarDiffDays

#

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

Year, month and day

17 declarations

typetype Year = Integer

#

Year of Common Era (when positive).

patternpattern CommonEra :: Integer -> Year

#

Also known as Anno Domini.

patternpattern BeforeCommonEra :: Integer -> Year

#

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.

typetype MonthOfYear = Int

#

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

patternpattern January :: MonthOfYear

#

patternpattern February :: MonthOfYear

#

patternpattern March :: MonthOfYear

#

patternpattern April :: MonthOfYear

#

patternpattern May :: MonthOfYear

#

patternpattern June :: MonthOfYear

#

patternpattern July :: MonthOfYear

#

patternpattern August :: MonthOfYear

#

patternpattern September :: MonthOfYear

#

patternpattern October :: MonthOfYear

#

patternpattern November :: MonthOfYear

#

patternpattern December :: MonthOfYear

#

The twelve MonthOfYear patterns form a COMPLETE set.

typetype DayOfMonth = Int

#

Day of month, in range 1 to 31.

Gregorian calendar

14 declarations

valuetoGregorian :: Day -> (Year, MonthOfYear, DayOfMonth)

#

Convert to proleptic Gregorian calendar.

valuefromGregorian :: Year -> MonthOfYear -> DayOfMonth -> Day

#

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

valuefromGregorianValid :: Year -> MonthOfYear -> DayOfMonth -> Maybe Day

#

Convert from proleptic Gregorian calendar. Invalid values will return Nothing

valueshowGregorian :: Day -> String

#

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

valuegregorianMonthLength :: Year -> MonthOfYear -> DayOfMonth

#

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

valueaddGregorianMonthsClip :: Integer -> Day -> Day

#

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.

valueaddGregorianMonthsRollOver :: Integer -> Day -> Day

#

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.

valueaddGregorianYearsClip :: Integer -> Day -> Day

#

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.

valueaddGregorianYearsRollOver :: Integer -> Day -> Day

#

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.

valueaddGregorianDurationClip :: CalendarDiffDays -> Day -> Day

#

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

valueaddGregorianDurationRollOver :: CalendarDiffDays -> Day -> Day

#

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

valuediffGregorianDurationClip :: Day -> Day -> CalendarDiffDays

#

Calendrical difference, with as many whole months as possible

valuediffGregorianDurationRollOver :: Day -> Day -> CalendarDiffDays

#

Calendrical difference, with as many whole months as possible.

valueisLeapYear :: Year -> Bool

#

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

Week

7 declarations

datadata DayOfWeek

#

Monday Tuesday Wednesday Thursday Friday Saturday Sunday

Instances11Enum, Eq, Data, Ord, Read, Show, …

Enum DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
"Circular", so for example [Tuesday ..] gives an endless sequence. Also: fromEnum gives [1 .. 7] for [Monday .. Sunday], and toEnum performs mod 7 to give a cycle of days.
Eq DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
Data DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
Ord DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
Read DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
Show DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
Ix DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
NFData DayOfWeekDefined in time-1.12.2 · Data.Time.Calendar.Week
Hashable DayOfWeekDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan
FormatTime DayOfWeekDefined in time-1.12.2 · Data.Time.Format.Format.Instances · orphan
Lift DayOfWeekDefined in time-compat-1.9.8 · Data.Time.Orphans · orphan

valuedayOfWeek :: Day -> DayOfWeek

#

valuedayOfWeekDiff :: DayOfWeek -> DayOfWeek -> Int

#

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

valuefirstDayOfWeekOnAfter :: DayOfWeek -> Day -> Day

#

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

valueweekAllDays :: DayOfWeek -> Day -> [Day]

#

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

Examples:

Example1 expression

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

Example1 expression

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

Example1 expression

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

valueweekFirstDay :: DayOfWeek -> Day -> Day

#

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

Examples:

Example1 expression

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

Example1 expression

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

Example1 expression

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

valueweekLastDay :: DayOfWeek -> Day -> Day

#

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

Examples:

Example1 expression

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

Example1 expression

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

Example1 expression

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

Type aliases

1 declaration

patternpattern YearMonthDay :: Year -> MonthOfYear -> DayOfMonth -> Day

#

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