Data.Time.Calendar

time-1.9.3: A time library

Safe Haskell | Safe-Inferred
Language | Haskell2010

Data.Time.Calendar

Contents

- Days
- Calendar Duration
- Gregorian calendar
- Week

Synopsis

- newtype Day = ModifiedJulianDay {
  - toModifiedJulianDay :: Integer
  }
- addDays :: Integer -> Day -> Day
- diffDays :: Day -> Day -> Integer
- data CalendarDiffDays = CalendarDiffDays {
  - cdMonths :: Integer
  - cdDays :: Integer
  }
- calendarDay :: CalendarDiffDays
- calendarWeek :: CalendarDiffDays
- calendarMonth :: CalendarDiffDays
- calendarYear :: CalendarDiffDays
- scaleCalendarDiffDays :: Integer -> CalendarDiffDays -> CalendarDiffDays
- toGregorian :: Day -> (Integer, Int, Int)
- fromGregorian :: Integer -> Int -> Int -> Day
- fromGregorianValid :: Integer -> Int -> Int -> Maybe Day
- showGregorian :: Day -> String
- gregorianMonthLength :: Integer -> Int -> Int
- addGregorianMonthsClip :: Integer -> Day -> Day
- addGregorianMonthsRollOver :: Integer -> Day -> Day
- addGregorianYearsClip :: Integer -> Day -> Day
- addGregorianYearsRollOver :: Integer -> Day -> Day
- addGregorianDurationClip :: CalendarDiffDays -> Day -> Day
- addGregorianDurationRollOver :: CalendarDiffDays -> Day -> Day
- diffGregorianDurationClip :: Day -> Day -> CalendarDiffDays
- diffGregorianDurationRollOver :: Day -> Day -> CalendarDiffDays
- isLeapYear :: Integer -> Bool
- data DayOfWeek
  - = Monday
  - | Tuesday
  - | Wednesday
  - | Thursday
  - | Friday
  - | Saturday
  - | Sunday
- dayOfWeek :: Day -> DayOfWeek

# Days

newtype Day Source #

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

Constructors

ModifiedJulianDay |
Fields toModifiedJulianDay :: Integer

#### Instances

Instances details

Enum Day # |
Instance details Defined in Data.Time.Calendar.Days Methods succ :: Day -> Day Source # pred :: Day -> Day Source # toEnum :: Int -> Day Source # fromEnum :: Day -> Int Source # enumFrom :: Day -> [Day] Source # enumFromThen :: Day -> Day -> [Day] Source # enumFromTo :: Day -> Day -> [Day] Source # enumFromThenTo :: Day -> Day -> Day -> [Day] Source #
Eq Day # |
Instance details Defined in Data.Time.Calendar.Days Methods (==) :: Day -> Day -> Bool # (/=) :: Day -> Day -> Bool #
Data Day # |
Instance details Defined in Data.Time.Calendar.Days Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Day -> c Day Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Day Source # toConstr :: Day -> Constr Source # dataTypeOf :: Day -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Day) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Day) Source # gmapT :: (forall b. Data b => b -> b) -> Day -> Day Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Day -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Day -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Day -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Day -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Day -> m Day Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Day -> m Day Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Day -> m Day Source #
Ord Day # |
Instance details Defined in Data.Time.Calendar.Days Methods compare :: Day -> Day -> Ordering # (<) :: Day -> Day -> Bool # (<=) :: Day -> Day -> Bool # (>) :: Day -> Day -> Bool # (>=) :: Day -> Day -> Bool # max :: Day -> Day -> Day # min :: Day -> Day -> Day #
Read Day # |
Instance details Defined in Data.Time.Format.Parse Methods readsPrec :: Int -> ReadS Day Source # readList :: ReadS [Day] Source # readPrec :: ReadPrec Day Source # readListPrec :: ReadPrec [Day] Source #
Show Day # |
Instance details Defined in Data.Time.Calendar.Gregorian Methods showsPrec :: Int -> Day -> ShowS Source # show :: Day -> String Source # showList :: [Day] -> ShowS Source #
Ix Day # |
Instance details Defined in Data.Time.Calendar.Days Methods range :: (Day, Day) -> [Day] Source # index :: (Day, Day) -> Day -> Int Source # unsafeIndex :: (Day, Day) -> Day -> Int Source # inRange :: (Day, Day) -> Day -> Bool Source # rangeSize :: (Day, Day) -> Int Source # unsafeRangeSize :: (Day, Day) -> Int Source #
NFData Day # |
Instance details Defined in Data.Time.Calendar.Days Methods rnf :: Day -> () Source #
ParseTime Day # |
Instance details Defined in Data.Time.Format.Parse.Instances Methods substituteTimeSpecifier :: proxy Day -> TimeLocale -> Char -> Maybe String Source # parseTimeSpecifier :: proxy Day -> TimeLocale -> Maybe ParseNumericPadding -> Char -> ReadP String Source # buildTime :: TimeLocale -> [(Char, String)] -> Maybe Day Source #
FormatTime Day # |
Instance details Defined in Data.Time.Format.Format.Instances Methods formatCharacter :: Bool -> Char -> Maybe (FormatOptions -> Day -> String) Source #
ISO8601 Day # | `yyyy-mm-dd` (ISO 8601:2004(E) sec. 4.1.2.2 extended format)
Instance details Defined in Data.Time.Format.ISO8601 Methods iso8601Format :: Format Day Source #

addDays :: Integer -> Day -> Day Source #

diffDays :: Day -> Day -> Integer Source #

# Calendar Duration

data CalendarDiffDays Source #

Constructors

CalendarDiffDays |
Fields cdMonths :: Integer cdDays :: Integer

#### Instances

Instances details

Eq CalendarDiffDays # |
Instance details Defined in Data.Time.Calendar.CalendarDiffDays Methods (==) :: CalendarDiffDays -> CalendarDiffDays -> Bool # (/=) :: CalendarDiffDays -> CalendarDiffDays -> Bool #
Data CalendarDiffDays # | Since: time-1.9.2
Instance details Defined in Data.Time.Calendar.CalendarDiffDays Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CalendarDiffDays -> c CalendarDiffDays Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CalendarDiffDays Source # toConstr :: CalendarDiffDays -> Constr Source # dataTypeOf :: CalendarDiffDays -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CalendarDiffDays) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CalendarDiffDays) Source # gmapT :: (forall b. Data b => b -> b) -> CalendarDiffDays -> CalendarDiffDays Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CalendarDiffDays -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CalendarDiffDays -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CalendarDiffDays -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CalendarDiffDays -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CalendarDiffDays -> m CalendarDiffDays Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CalendarDiffDays -> m CalendarDiffDays Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CalendarDiffDays -> m CalendarDiffDays Source #
Show CalendarDiffDays # |
Instance details Defined in Data.Time.Calendar.CalendarDiffDays Methods showsPrec :: Int -> CalendarDiffDays -> ShowS Source # show :: CalendarDiffDays -> String Source # showList :: [CalendarDiffDays] -> ShowS Source #
Semigroup CalendarDiffDays # | Additive
Instance details Defined in Data.Time.Calendar.CalendarDiffDays Methods (<>) :: CalendarDiffDays -> CalendarDiffDays -> CalendarDiffDays Source # sconcat :: NonEmpty CalendarDiffDays -> CalendarDiffDays Source # stimes :: Integral b => b -> CalendarDiffDays -> CalendarDiffDays Source #
Monoid CalendarDiffDays # | Additive
Instance details Defined in Data.Time.Calendar.CalendarDiffDays Methods mempty :: CalendarDiffDays Source # mappend :: CalendarDiffDays -> CalendarDiffDays -> CalendarDiffDays Source # mconcat :: [CalendarDiffDays] -> CalendarDiffDays Source #
ParseTime CalendarDiffDays # |
Instance details Defined in Data.Time.Format.Parse.Instances Methods substituteTimeSpecifier :: proxy CalendarDiffDays -> TimeLocale -> Char -> Maybe String Source # parseTimeSpecifier :: proxy CalendarDiffDays -> TimeLocale -> Maybe ParseNumericPadding -> Char -> ReadP String Source # buildTime :: TimeLocale -> [(Char, String)] -> Maybe CalendarDiffDays Source #
FormatTime CalendarDiffDays # |
Instance details Defined in Data.Time.Format.Format.Instances Methods formatCharacter :: Bool -> Char -> Maybe (FormatOptions -> CalendarDiffDays -> String) Source #
ISO8601 CalendarDiffDays # | `PyYmMdD` (ISO 8601:2004(E) sec. 4.4.3.2)
Instance details Defined in Data.Time.Format.ISO8601 Methods iso8601Format :: Format CalendarDiffDays Source #

calendarDay :: CalendarDiffDays Source #

calendarWeek :: CalendarDiffDays Source #

calendarMonth :: CalendarDiffDays Source #

calendarYear :: CalendarDiffDays Source #

scaleCalendarDiffDays :: Integer -> CalendarDiffDays -> CalendarDiffDays Source #

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

# Gregorian calendar

toGregorian :: Day -> (Integer, Int, Int) Source #

Convert to proleptic Gregorian calendar. First element of result is year, second month number (1-12), third day (1-31).

fromGregorian :: Integer -> Int -> Int -> Day Source #

Convert from proleptic Gregorian calendar. First argument is year, second month number (1-12), third day (1-31). Invalid values will be clipped to the correct range, month first, then day.

fromGregorianValid :: Integer -> Int -> Int -> Maybe Day Source #

Convert from proleptic Gregorian calendar. First argument is year, second month number (1-12), third day (1-31). Invalid values will return Nothing

showGregorian :: Day -> String Source #

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

gregorianMonthLength :: Integer -> Int -> Int Source #

The number of days in a given month according to the proleptic Gregorian calendar. First argument is year, second is month.

addGregorianMonthsClip :: Integer -> Day -> Day Source #

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.

addGregorianMonthsRollOver :: Integer -> Day -> Day Source #

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.

addGregorianYearsClip :: Integer -> Day -> Day Source #

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.

addGregorianYearsRollOver :: Integer -> Day -> Day Source #

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.

addGregorianDurationClip :: CalendarDiffDays -> Day -> Day Source #

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

addGregorianDurationRollOver :: CalendarDiffDays -> Day -> Day Source #

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

diffGregorianDurationClip :: Day -> Day -> CalendarDiffDays Source #

Calendrical difference, with as many whole months as possible

diffGregorianDurationRollOver :: Day -> Day -> CalendarDiffDays Source #

Calendrical difference, with as many whole months as possible. Same as `diffGregorianDurationClip` for positive durations.

isLeapYear :: Integer -> Bool Source #

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

# Week

data DayOfWeek Source #

Constructors

Monday |
Tuesday |
Wednesday |
Thursday |
Friday |
Saturday |
Sunday |

#### Instances

Instances details

Enum DayOfWeek # | "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.
Instance details Defined in Data.Time.Calendar.Week Methods succ :: DayOfWeek -> DayOfWeek Source # pred :: DayOfWeek -> DayOfWeek Source # toEnum :: Int -> DayOfWeek Source # fromEnum :: DayOfWeek -> Int Source # enumFrom :: DayOfWeek -> [DayOfWeek] Source # enumFromThen :: DayOfWeek -> DayOfWeek -> [DayOfWeek] Source # enumFromTo :: DayOfWeek -> DayOfWeek -> [DayOfWeek] Source # enumFromThenTo :: DayOfWeek -> DayOfWeek -> DayOfWeek -> [DayOfWeek] Source #
Eq DayOfWeek # |
Instance details Defined in Data.Time.Calendar.Week Methods (==) :: DayOfWeek -> DayOfWeek -> Bool # (/=) :: DayOfWeek -> DayOfWeek -> Bool #
Read DayOfWeek # |
Instance details Defined in Data.Time.Calendar.Week Methods readsPrec :: Int -> ReadS DayOfWeek Source # readList :: ReadS [DayOfWeek] Source # readPrec :: ReadPrec DayOfWeek Source # readListPrec :: ReadPrec [DayOfWeek] Source #
Show DayOfWeek # |
Instance details Defined in Data.Time.Calendar.Week Methods showsPrec :: Int -> DayOfWeek -> ShowS Source # show :: DayOfWeek -> String Source # showList :: [DayOfWeek] -> ShowS Source #
FormatTime DayOfWeek # |
Instance details Defined in Data.Time.Format.Format.Instances Methods formatCharacter :: Bool -> Char -> Maybe (FormatOptions -> DayOfWeek -> String) Source #

dayOfWeek :: Day -> DayOfWeek Source #