-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | A time library -- -- Time, clocks and calendars @package time @version 1.11 -- | ISO 8601 Ordinal Date format module Data.Time.Calendar.OrdinalDate -- | The Modified Julian Day is a standard count of days, with zero being -- the day 1858-11-17. data Day -- | Year of Common Era. type Year = Integer -- | Day of year, in range 1 (January 1st) to 366. December 31st is 365 in -- a common year, 366 in a leap year. type DayOfYear = Int -- | Week of year, by various reckonings, generally in range 0-53 depending -- on reckoning type WeekOfYear = Int -- | Bidirectional abstract constructor for ISO 8601 Ordinal Date format. -- Invalid day numbers will be clipped to the correct range (1 to 365 or -- 366). pattern YearDay :: Year -> DayOfYear -> Day -- | Convert to ISO 8601 Ordinal Date format. toOrdinalDate :: Day -> (Year, DayOfYear) -- | Convert from ISO 8601 Ordinal Date format. Invalid day numbers will be -- clipped to the correct range (1 to 365 or 366). fromOrdinalDate :: Year -> DayOfYear -> Day -- | Convert from ISO 8601 Ordinal Date format. Invalid day numbers return -- Nothing fromOrdinalDateValid :: Year -> DayOfYear -> Maybe Day -- | Show in ISO 8601 Ordinal Date format (yyyy-ddd) showOrdinalDate :: Day -> String -- | Is this year a leap year according to the proleptic Gregorian -- calendar? isLeapYear :: Year -> Bool -- | Get the number of the Monday-starting week in the year and the day of -- the week. The first Monday is the first day of week 1, any earlier -- days in the year are week 0 (as %W in formatTime). -- Monday is 1, Sunday is 7 (as %u in formatTime). mondayStartWeek :: Day -> (WeekOfYear, Int) -- | Get the number of the Sunday-starting week in the year and the day of -- the week. The first Sunday is the first day of week 1, any earlier -- days in the year are week 0 (as %U in formatTime). -- Sunday is 0, Saturday is 6 (as %w in formatTime). sundayStartWeek :: Day -> (WeekOfYear, Int) -- | The inverse of mondayStartWeek. Get a Day given the -- year, the number of the Monday-starting week, and the day of the week. -- The first Monday is the first day of week 1, any earlier days in the -- year are week 0 (as %W in formatTime). fromMondayStartWeek :: Year -> WeekOfYear -> Int -> Day fromMondayStartWeekValid :: Year -> WeekOfYear -> Int -> Maybe Day -- | The inverse of sundayStartWeek. Get a Day given the year -- and the number of the day of a Sunday-starting week. The first Sunday -- is the first day of week 1, any earlier days in the year are week 0 -- (as %U in formatTime). fromSundayStartWeek :: Year -> WeekOfYear -> Int -> Day fromSundayStartWeekValid :: Year -> WeekOfYear -> Int -> Maybe Day module Data.Time.Calendar.MonthDay -- | Month of year, in range 1 (January) to 12 (December). type MonthOfYear = Int -- | Day of month, in range 1 to 31. type DayOfMonth = Int -- | Day of year, in range 1 (January 1st) to 366. December 31st is 365 in -- a common year, 366 in a leap year. type DayOfYear = Int -- | Convert month and day in the Gregorian or Julian calendars to day of -- year. First arg is leap year flag. monthAndDayToDayOfYear :: Bool -> MonthOfYear -> DayOfMonth -> DayOfYear -- | Convert month and day in the Gregorian or Julian calendars to day of -- year. First arg is leap year flag. monthAndDayToDayOfYearValid :: Bool -> MonthOfYear -> DayOfMonth -> Maybe DayOfYear -- | Convert day of year in the Gregorian or Julian calendars to month and -- day. First arg is leap year flag. dayOfYearToMonthAndDay :: Bool -> DayOfYear -> (MonthOfYear, DayOfMonth) -- | The length of a given month in the Gregorian or Julian calendars. -- First arg is leap year flag. monthLength :: Bool -> MonthOfYear -> DayOfMonth module Data.Time.Calendar.Julian -- | Year of Common Era. type Year = Integer -- | Month of year, in range 1 (January) to 12 (December). type MonthOfYear = Int -- | Day of month, in range 1 to 31. type DayOfMonth = Int -- | Day of year, in range 1 (January 1st) to 366. December 31st is 365 in -- a common year, 366 in a leap year. type DayOfYear = Int -- | Convert to proleptic Julian year and day format. toJulianYearAndDay :: Day -> (Year, DayOfYear) -- | Convert from proleptic Julian year and day format. Invalid day numbers -- will be clipped to the correct range (1 to 365 or 366). fromJulianYearAndDay :: Year -> DayOfYear -> Day -- | Convert from proleptic Julian year and day format. Invalid day numbers -- will return Nothing fromJulianYearAndDayValid :: Year -> DayOfYear -> Maybe Day -- | Show in proleptic Julian year and day format (yyyy-ddd) showJulianYearAndDay :: Day -> String -- | Is this year a leap year according to the proleptic Julian calendar? isJulianLeapYear :: Year -> Bool -- | Convert to proleptic Julian calendar. toJulian :: Day -> (Year, MonthOfYear, DayOfMonth) -- | Convert from proleptic Julian calendar. Invalid values will be clipped -- to the correct range, month first, then day. fromJulian :: Year -> MonthOfYear -> DayOfMonth -> Day -- | Bidirectional abstract constructor for the proleptic Julian calendar. -- Invalid values will be clipped to the correct range, month first, then -- day. pattern JulianYearMonthDay :: Year -> MonthOfYear -> DayOfMonth -> Day -- | Convert from proleptic Julian calendar. Invalid values will return -- Nothing. fromJulianValid :: Year -> MonthOfYear -> DayOfMonth -> Maybe Day -- | Show in ISO 8601 format (yyyy-mm-dd) showJulian :: Day -> String -- | The number of days in a given month according to the proleptic Julian -- calendar. julianMonthLength :: Year -> MonthOfYear -> DayOfMonth -- | 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. addJulianMonthsClip :: 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. addJulianMonthsRollOver :: 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. addJulianYearsClip :: 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. addJulianYearsRollOver :: Integer -> Day -> Day -- | Add months (clipped to last day), then add days addJulianDurationClip :: CalendarDiffDays -> Day -> Day -- | Add months (rolling over to next month), then add days addJulianDurationRollOver :: CalendarDiffDays -> Day -> Day -- | Calendrical difference, with as many whole months as possible diffJulianDurationClip :: Day -> Day -> CalendarDiffDays -- | Calendrical difference, with as many whole months as possible. Same as -- diffJulianDurationClip for positive durations. diffJulianDurationRollOver :: Day -> Day -> CalendarDiffDays -- | An absolute count of common calendar months. module Data.Time.Calendar.Month -- | An absolute count of common calendar months. Number is equal to -- (year * 12) + (monthOfYear - 1). newtype Month MkMonth :: Integer -> Month addMonths :: Integer -> Month -> Month diffMonths :: Month -> Month -> Integer -- | Bidirectional abstract constructor. Invalid months of year will be -- clipped to the correct range. pattern YearMonth :: Year -> MonthOfYear -> Month fromYearMonthValid :: Year -> MonthOfYear -> Maybe Month -- | Bidirectional abstract constructor. Invalid days of month will be -- clipped to the correct range. pattern MonthDay :: Month -> DayOfMonth -> Day fromMonthDayValid :: Month -> DayOfMonth -> Maybe Day instance Data.Data.Data Data.Time.Calendar.Month.Month instance GHC.Classes.Ord Data.Time.Calendar.Month.Month instance GHC.Classes.Eq Data.Time.Calendar.Month.Month instance GHC.Show.Show Data.Time.Calendar.Month.Month instance GHC.Read.Read Data.Time.Calendar.Month.Month -- | Year quarters. module Data.Time.Calendar.Quarter -- | Quarters of each year. Each quarter corresponds to three months. data QuarterOfYear Q1 :: QuarterOfYear Q2 :: QuarterOfYear Q3 :: QuarterOfYear Q4 :: QuarterOfYear addQuarters :: Integer -> Quarter -> Quarter diffQuarters :: Quarter -> Quarter -> Integer -- | An absolute count of year quarters. Number is equal to (year * 4) -- + (quarterOfYear - 1). newtype Quarter MkQuarter :: Integer -> Quarter -- | Bidirectional abstract constructor. pattern YearQuarter :: Year -> QuarterOfYear -> Quarter monthOfYearQuarter :: MonthOfYear -> QuarterOfYear monthQuarter :: Month -> Quarter dayQuarter :: Day -> Quarter instance Data.Data.Data Data.Time.Calendar.Quarter.Quarter instance GHC.Classes.Ord Data.Time.Calendar.Quarter.Quarter instance GHC.Classes.Eq Data.Time.Calendar.Quarter.Quarter instance GHC.Show.Show Data.Time.Calendar.Quarter.QuarterOfYear instance GHC.Read.Read Data.Time.Calendar.Quarter.QuarterOfYear instance Data.Data.Data Data.Time.Calendar.Quarter.QuarterOfYear instance GHC.Classes.Ord Data.Time.Calendar.Quarter.QuarterOfYear instance GHC.Classes.Eq Data.Time.Calendar.Quarter.QuarterOfYear instance GHC.Show.Show Data.Time.Calendar.Quarter.Quarter instance GHC.Read.Read Data.Time.Calendar.Quarter.Quarter instance GHC.Enum.Enum Data.Time.Calendar.Quarter.QuarterOfYear instance GHC.Enum.Bounded Data.Time.Calendar.Quarter.QuarterOfYear -- | Week-based calendars module Data.Time.Calendar.WeekDate -- | Year of Common Era. type Year = Integer -- | Week of year, by various reckonings, generally in range 0-53 depending -- on reckoning type WeekOfYear = Int data DayOfWeek Monday :: DayOfWeek Tuesday :: DayOfWeek Wednesday :: DayOfWeek Thursday :: DayOfWeek Friday :: DayOfWeek Saturday :: DayOfWeek Sunday :: DayOfWeek dayOfWeek :: Day -> DayOfWeek data FirstWeekType -- | first week is the first whole week of the year FirstWholeWeek :: FirstWeekType -- | first week is the first week with four days in the year FirstMostWeek :: FirstWeekType -- | Convert to the given kind of "week calendar". Note that the year -- number matches the weeks, and so is not always the same as the -- Gregorian year number. toWeekCalendar :: FirstWeekType -> DayOfWeek -> Day -> (Year, WeekOfYear, DayOfWeek) -- | Convert from the given kind of "week calendar". Invalid week and day -- values will be clipped to the correct range. fromWeekCalendar :: FirstWeekType -> DayOfWeek -> Year -> WeekOfYear -> DayOfWeek -> Day -- | Convert from the given kind of "week calendar". Invalid week and day -- values will return Nothing. fromWeekCalendarValid :: FirstWeekType -> DayOfWeek -> Year -> WeekOfYear -> DayOfWeek -> Maybe Day -- | Convert to ISO 8601 Week Date format. First element of result is year, -- second week number (1-53), third day of week (1 for Monday to 7 for -- Sunday). Note that "Week" years are not quite the same as Gregorian -- years, as the first day of the year is always a Monday. The first week -- of a year is the first week to contain at least four days in the -- corresponding Gregorian year. toWeekDate :: Day -> (Year, WeekOfYear, Int) -- | Convert from ISO 8601 Week Date format. First argument is year, second -- week number (1-52 or 53), third day of week (1 for Monday to 7 for -- Sunday). Invalid week and day values will be clipped to the correct -- range. fromWeekDate :: Year -> WeekOfYear -> Int -> Day -- | Bidirectional abstract constructor for ISO 8601 Week Date format. -- Invalid week values will be clipped to the correct range. pattern YearWeekDay :: Year -> WeekOfYear -> DayOfWeek -> Day -- | Convert from ISO 8601 Week Date format. First argument is year, second -- week number (1-52 or 53), third day of week (1 for Monday to 7 for -- Sunday). Invalid week and day values will return Nothing. fromWeekDateValid :: Year -> WeekOfYear -> Int -> Maybe Day -- | Show in ISO 8601 Week Date format as yyyy-Www-d (e.g. "2006-W46-3"). showWeekDate :: Day -> String instance GHC.Classes.Eq Data.Time.Calendar.WeekDate.FirstWeekType -- | Fast access to the system clock. module Data.Time.Clock.System -- | The day of the epoch of SystemTime, 1970-01-01 systemEpochDay :: Day -- | SystemTime is time returned by system clock functions. Its -- semantics depends on the clock function, but the epoch is typically -- the beginning of 1970. Note that systemNanoseconds of 1E9 to -- 2E9-1 can be used to represent leap seconds. data SystemTime MkSystemTime :: {-# UNPACK #-} !Int64 -> {-# UNPACK #-} !Word32 -> SystemTime [systemSeconds] :: SystemTime -> {-# UNPACK #-} !Int64 [systemNanoseconds] :: SystemTime -> {-# UNPACK #-} !Word32 -- | Map leap-second values to the start of the following second. The -- resulting systemNanoseconds will always be in the range 0 to -- 1E9-1. truncateSystemTimeLeapSecond :: SystemTime -> SystemTime -- | Get the system time, epoch start of 1970 UTC, leap-seconds ignored. -- getSystemTime is typically much faster than -- getCurrentTime. getSystemTime :: IO SystemTime -- | Convert SystemTime to UTCTime, matching zero -- SystemTime to midnight of systemEpochDay UTC. systemToUTCTime :: SystemTime -> UTCTime -- | Convert UTCTime to SystemTime, matching zero -- SystemTime to midnight of systemEpochDay UTC. utcToSystemTime :: UTCTime -> SystemTime -- | Convert SystemTime to AbsoluteTime, matching zero -- SystemTime to midnight of systemEpochDay TAI. systemToTAITime :: SystemTime -> AbsoluteTime -- | POSIX time, if you need to deal with timestamps and the like. Most -- people won't need this module. -- -- You can use POSIXTime to obtain integer/word timestamps. For -- example: -- -- 
--   import Data.Time
--   import Data.Time.Clock.POSIX
--   import Data.Int
--   
--   nanosSinceEpoch :: UTCTime -> Int64
--   nanosSinceEpoch =
--       floor . (1e9 *) . nominalDiffTimeToSeconds . utcTimeToPOSIXSeconds
--   
--   main :: IO ()
--   main = do
--       u <- getCurrentTime
--       print $ nanosSinceEpoch u
--
module Data.Time.Clock.POSIX -- | 86400 nominal seconds in every day posixDayLength :: NominalDiffTime -- | POSIX time is the nominal time since 1970-01-01 00:00 UTC -- -- To convert from a CTime or System.Posix.EpochTime, use -- realToFrac. type POSIXTime = NominalDiffTime posixSecondsToUTCTime :: POSIXTime -> UTCTime utcTimeToPOSIXSeconds :: UTCTime -> POSIXTime -- | Get the current POSIX time from the system clock. getPOSIXTime :: IO POSIXTime -- | Get the current UTCTime from the system clock. getCurrentTime :: IO UTCTime systemToPOSIXTime :: SystemTime -> POSIXTime -- | The contents of this module is liable to change, or disappear -- entirely. Please let me know if you depend on anything here. module Data.Time.Format.Internal class FormatTime t formatCharacter :: FormatTime t => Bool -> Char -> Maybe (FormatOptions -> t -> String) -- | The class of types which can be parsed given a UNIX-style time format -- string. class ParseTime t substituteTimeSpecifier :: ParseTime t => Proxy t -> TimeLocale -> Char -> Maybe String -- | Get the string corresponding to the given format specifier. parseTimeSpecifier :: ParseTime t => Proxy t -> TimeLocale -> Maybe ParseNumericPadding -> Char -> ReadP String -- | Builds a time value from a parsed input string. If the input does not -- include all the information needed to construct a complete value, any -- missing parts should be taken from 1970-01-01 00:00:00 +0000 (which -- was a Thursday). In the absence of %C or %Y, century -- is 1969 - 2068. buildTime :: ParseTime t => TimeLocale -> [(Char, String)] -> Maybe t module Data.Time.Format class FormatTime t -- | 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): -- -- -- --

<width>

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

<alternate>

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

<specifier>

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

TimeZone

-- -- For TimeZone (and ZonedTime and UTCTime): -- -- -- --

LocalTime

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

TimeOfDay

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

UTCTime and ZonedTime

-- -- For UTCTime and ZonedTime: -- -- -- --

DayOfWeek

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

Month

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

Day

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

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: -- -- -- --

CalendarDiffDays

-- -- For CalendarDiffDays (and CalendarDiffTime): -- -- -- --

CalendarDiffTime

-- -- For CalendarDiffTime: -- -- formatTime :: FormatTime t => TimeLocale -> String -> t -> String -- | 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: -- -- -- -- 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
--
parseTimeM :: (MonadFail m, ParseTime t) => Bool -> TimeLocale -> String -> String -> m t -- | Parses a time value given a list of pairs of format and input. -- Resulting value is constructed from all provided specifiers. parseTimeMultipleM :: (MonadFail m, ParseTime t) => Bool -> TimeLocale -> [(String, String)] -> m t -- | Parse a time value given a format string. Fails if the input could not -- be parsed using the given format. See parseTimeM for details. parseTimeOrError :: ParseTime t => Bool -> TimeLocale -> String -> String -> t -- | Parse a time value given a format string. See parseTimeM for -- details. readSTime :: ParseTime t => Bool -> TimeLocale -> String -> ReadS t -- | Parse a time value given a format string. See parseTimeM for -- details. readPTime :: ParseTime t => Bool -> TimeLocale -> String -> ReadP t -- | The class of types which can be parsed given a UNIX-style time format -- string. class ParseTime t data TimeLocale TimeLocale :: [(String, String)] -> [(String, String)] -> (String, String) -> String -> [TimeZone] -> TimeLocale -- | full and abbreviated week days, starting with Sunday [wDays] :: TimeLocale -> [(String, String)] -- | full and abbreviated months [months] :: TimeLocale -> [(String, String)] -- | AM/PM symbols [amPm] :: TimeLocale -> (String, String) -- | formatting strings -- | formatting strings -- | formatting strings -- | formatting strings [dateTimeFmt, dateFmt, timeFmt, time12Fmt] :: TimeLocale -> String -- | time zones known by name [knownTimeZones] :: TimeLocale -> [TimeZone] -- | Locale representing American usage. -- -- knownTimeZones contains only the ten time-zones mentioned in -- RFC 802 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. defaultTimeLocale :: TimeLocale -- | 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
--
-- | Deprecated: use Data.Time.Format.ISO8601 functions -- instead iso8601DateFormat :: Maybe String -> String -- | Format string according to RFC822. rfc822DateFormat :: String module Data.Time.LocalTime -- | A TimeZone is a whole number of minutes offset from UTC, together with -- a name and a "just for summer" flag. data TimeZone TimeZone :: Int -> Bool -> String -> TimeZone -- | The number of minutes offset from UTC. Positive means local time will -- be later in the day than UTC. [timeZoneMinutes] :: TimeZone -> Int -- | Is this time zone just persisting for the summer? [timeZoneSummerOnly] :: TimeZone -> Bool -- | The name of the zone, typically a three- or four-letter acronym. [timeZoneName] :: TimeZone -> String -- | Text representing the offset of this timezone, such as "-0800" or -- "+0400" (like %z in formatTime). timeZoneOffsetString :: TimeZone -> String -- | Text representing the offset of this timezone, such as "-0800" or -- "+0400" (like %z in formatTime), with arbitrary padding. timeZoneOffsetString' :: Maybe Char -> TimeZone -> String -- | Create a nameless non-summer timezone for this number of minutes. minutesToTimeZone :: Int -> TimeZone -- | Create a nameless non-summer timezone for this number of hours. hoursToTimeZone :: Int -> TimeZone -- | The UTC time zone. utc :: TimeZone -- | Get the local time-zone for a given time (varying as per summertime -- adjustments). getTimeZone :: UTCTime -> IO TimeZone -- | Get the current time-zone. getCurrentTimeZone :: IO TimeZone -- | Time of day as represented in hour, minute and second (with -- picoseconds), typically used to express local time of day. data TimeOfDay TimeOfDay :: Int -> Int -> Pico -> TimeOfDay -- | range 0 - 23 [todHour] :: TimeOfDay -> Int -- | range 0 - 59 [todMin] :: TimeOfDay -> Int -- | Note that 0 <= todSec < 61, accomodating leap seconds. -- Any local minute may have a leap second, since leap seconds happen in -- all zones simultaneously [todSec] :: TimeOfDay -> Pico -- | Hour zero midnight :: TimeOfDay -- | Hour twelve midday :: TimeOfDay makeTimeOfDayValid :: Int -> Int -> Pico -> Maybe TimeOfDay -- | 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. timeToDaysAndTimeOfDay :: NominalDiffTime -> (Integer, TimeOfDay) -- | Convert a count of days and a time of day since midnight into a period -- of time. daysAndTimeOfDayToTime :: Integer -> TimeOfDay -> NominalDiffTime -- | Convert a time of day in UTC to a time of day in some timezone, -- together with a day adjustment. utcToLocalTimeOfDay :: TimeZone -> TimeOfDay -> (Integer, TimeOfDay) -- | Convert a time of day in some timezone to a time of day in UTC, -- together with a day adjustment. localToUTCTimeOfDay :: TimeZone -> TimeOfDay -> (Integer, TimeOfDay) -- | Get the time of day given a time since midnight. Time more than 24h -- will be converted to leap-seconds. timeToTimeOfDay :: DiffTime -> TimeOfDay -- | Same as timeToTimeOfDay. pastMidnight :: DiffTime -> TimeOfDay -- | Get the time since midnight for a given time of day. timeOfDayToTime :: TimeOfDay -> DiffTime -- | Same as timeOfDayToTime. sinceMidnight :: TimeOfDay -> DiffTime -- | Get the time of day given the fraction of a day since midnight. dayFractionToTimeOfDay :: Rational -> TimeOfDay -- | Get the fraction of a day since midnight given a time of day. timeOfDayToDayFraction :: TimeOfDay -> Rational data CalendarDiffTime CalendarDiffTime :: Integer -> NominalDiffTime -> CalendarDiffTime [ctMonths] :: CalendarDiffTime -> Integer [ctTime] :: CalendarDiffTime -> NominalDiffTime calendarTimeDays :: CalendarDiffDays -> CalendarDiffTime calendarTimeTime :: NominalDiffTime -> CalendarDiffTime -- | Scale by a factor. Note that scaleCalendarDiffTime (-1) will -- not perfectly invert a duration, due to variable month lengths. scaleCalendarDiffTime :: Integer -> CalendarDiffTime -> CalendarDiffTime -- | 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. data LocalTime LocalTime :: Day -> TimeOfDay -> LocalTime [localDay] :: LocalTime -> Day [localTimeOfDay] :: LocalTime -> TimeOfDay -- | addLocalTime a b = a + b addLocalTime :: NominalDiffTime -> LocalTime -> LocalTime -- | diffLocalTime a b = a - b diffLocalTime :: LocalTime -> LocalTime -> NominalDiffTime -- | Get the local time of a UTC time in a time zone. utcToLocalTime :: TimeZone -> UTCTime -> LocalTime -- | Get the UTC time of a local time in a time zone. localTimeToUTC :: TimeZone -> LocalTime -> UTCTime -- | Get the local time of a UT1 time on a particular meridian (in degrees, -- positive is East). ut1ToLocalTime :: Rational -> UniversalTime -> LocalTime -- | Get the UT1 time of a local time on a particular meridian (in degrees, -- positive is East). localTimeToUT1 :: Rational -> LocalTime -> UniversalTime -- | 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. data ZonedTime ZonedTime :: LocalTime -> TimeZone -> ZonedTime [zonedTimeToLocalTime] :: ZonedTime -> LocalTime [zonedTimeZone] :: ZonedTime -> TimeZone utcToZonedTime :: TimeZone -> UTCTime -> ZonedTime zonedTimeToUTC :: ZonedTime -> UTCTime getZonedTime :: IO ZonedTime utcToLocalZonedTime :: UTCTime -> IO ZonedTime -- | Types and functions for UTC and UT1 module Data.Time.Clock -- | 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. newtype UniversalTime ModJulianDate :: Rational -> UniversalTime [getModJulianDate] :: UniversalTime -> Rational -- | 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. data DiffTime -- | Create a DiffTime which represents an integral number of -- seconds. secondsToDiffTime :: Integer -> DiffTime -- | Create a DiffTime from a number of picoseconds. picosecondsToDiffTime :: Integer -> DiffTime -- | Get the number of picoseconds in a DiffTime. diffTimeToPicoseconds :: DiffTime -> Integer -- | 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. data UTCTime UTCTime :: Day -> DiffTime -> UTCTime -- | the day [utctDay] :: UTCTime -> Day -- | the time from midnight, 0 <= t < 86401s (because of -- leap-seconds) [utctDayTime] :: UTCTime -> DiffTime -- | 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. data NominalDiffTime -- | Create a NominalDiffTime from a number of seconds. secondsToNominalDiffTime :: Pico -> NominalDiffTime -- | Get the seconds in a NominalDiffTime. nominalDiffTimeToSeconds :: NominalDiffTime -> Pico -- | One day in NominalDiffTime. nominalDay :: NominalDiffTime -- | addUTCTime a b = a + b addUTCTime :: NominalDiffTime -> UTCTime -> UTCTime -- | diffUTCTime a b = a - b diffUTCTime :: UTCTime -> UTCTime -> NominalDiffTime -- | Get the current UTCTime from the system clock. getCurrentTime :: IO UTCTime -- | The resolution of getSystemTime, getCurrentTime, -- getPOSIXTime. On UNIX systems this uses -- clock_getres, which may be wrong on WSL2. getTime_resolution :: DiffTime -- | TAI and leap-second maps for converting to UTC: most people won't need -- this module. module Data.Time.Clock.TAI -- | AbsoluteTime is TAI, time as measured by a clock. data AbsoluteTime -- | The epoch of TAI, which is 1858-11-17 00:00:00 TAI. taiEpoch :: AbsoluteTime -- | addAbsoluteTime a b = a + b addAbsoluteTime :: DiffTime -> AbsoluteTime -> AbsoluteTime -- | diffAbsoluteTime a b = a - b diffAbsoluteTime :: AbsoluteTime -> AbsoluteTime -> DiffTime taiNominalDayStart :: Day -> AbsoluteTime -- | TAI - UTC during this day. No table is provided, as any program -- compiled with it would become out of date in six months. type LeapSecondMap = Day -> Maybe Int utcDayLength :: LeapSecondMap -> Day -> Maybe DiffTime utcToTAITime :: LeapSecondMap -> UTCTime -> Maybe AbsoluteTime taiToUTCTime :: LeapSecondMap -> AbsoluteTime -> Maybe UTCTime -- | TAI clock, if it exists. Note that it is unlikely to be set correctly, -- without due care and attention. taiClock :: Maybe (DiffTime, IO AbsoluteTime) instance GHC.Show.Show Data.Time.Clock.Internal.AbsoluteTime.AbsoluteTime module Data.Time.Calendar -- | The Modified Julian Day is a standard count of days, with zero being -- the day 1858-11-17. newtype Day ModifiedJulianDay :: Integer -> Day [toModifiedJulianDay] :: Day -> Integer addDays :: Integer -> Day -> Day diffDays :: Day -> Day -> Integer data CalendarDiffDays CalendarDiffDays :: Integer -> Integer -> CalendarDiffDays [cdMonths] :: CalendarDiffDays -> Integer [cdDays] :: CalendarDiffDays -> Integer calendarDay :: CalendarDiffDays calendarWeek :: CalendarDiffDays calendarMonth :: CalendarDiffDays calendarYear :: CalendarDiffDays -- | Scale by a factor. Note that scaleCalendarDiffDays (-1) will -- not perfectly invert a duration, due to variable month lengths. scaleCalendarDiffDays :: Integer -> CalendarDiffDays -> CalendarDiffDays -- | Year of Common Era. type Year = Integer -- | Month of year, in range 1 (January) to 12 (December). type MonthOfYear = Int -- | Day of month, in range 1 to 31. type DayOfMonth = Int -- | Convert to proleptic Gregorian calendar. toGregorian :: Day -> (Year, MonthOfYear, DayOfMonth) -- | Convert from proleptic Gregorian calendar. Invalid values will be -- clipped to the correct range, month first, then day. fromGregorian :: 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. pattern YearMonthDay :: Year -> MonthOfYear -> DayOfMonth -> Day -- | Convert from proleptic Gregorian calendar. Invalid values will return -- Nothing fromGregorianValid :: Year -> MonthOfYear -> DayOfMonth -> Maybe Day -- | Show in ISO 8601 format (yyyy-mm-dd) showGregorian :: Day -> String -- | The number of days in a given month according to the proleptic -- Gregorian calendar. gregorianMonthLength :: Year -> MonthOfYear -> DayOfMonth -- | 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. addGregorianMonthsClip :: 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. addGregorianMonthsRollOver :: 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. addGregorianYearsClip :: 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. addGregorianYearsRollOver :: Integer -> Day -> Day -- | Add months (clipped to last day), then add days addGregorianDurationClip :: CalendarDiffDays -> Day -> Day -- | Add months (rolling over to next month), then add days addGregorianDurationRollOver :: CalendarDiffDays -> Day -> Day -- | Calendrical difference, with as many whole months as possible diffGregorianDurationClip :: Day -> Day -> CalendarDiffDays -- | Calendrical difference, with as many whole months as possible. Same as -- diffGregorianDurationClip for positive durations. diffGregorianDurationRollOver :: Day -> Day -> CalendarDiffDays -- | Is this year a leap year according to the proleptic Gregorian -- calendar? isLeapYear :: Year -> Bool data DayOfWeek Monday :: DayOfWeek Tuesday :: DayOfWeek Wednesday :: DayOfWeek Thursday :: DayOfWeek Friday :: DayOfWeek Saturday :: DayOfWeek Sunday :: DayOfWeek dayOfWeek :: Day -> DayOfWeek -- | dayOfWeekDiff a b = a - b in range 0 to 6. The number of days -- from b to the next a. dayOfWeekDiff :: DayOfWeek -> DayOfWeek -> Int -- | The first day-of-week on or after some day firstDayOfWeekOnAfter :: DayOfWeek -> Day -> Day module Data.Time.Calendar.Easter -- | The next Sunday strictly after a given day. sundayAfter :: Day -> Day -- | Given a year, find the Paschal full moon according to Orthodox -- Christian tradition orthodoxPaschalMoon :: Year -> Day -- | Given a year, find Easter according to Orthodox Christian tradition orthodoxEaster :: Year -> Day -- | Given a year, find the Paschal full moon according to the Gregorian -- method gregorianPaschalMoon :: Year -> Day -- | Given a year, find Easter according to the Gregorian method gregorianEaster :: Year -> Day -- |

Quick Start

-- -- Use these types for time regardless of location (not caring about -- leap-seconds): -- -- -- -- Use these types for the ways people refer to time and time -- differences: -- -- -- -- Use this for low-latency timing: -- -- -- -- These are less commonly needed: -- -- module Data.Time module Data.Time.Format.ISO8601 -- | A text format for a type data Format t -- | Show a value in the format, if representable formatShowM :: Format t -> t -> Maybe String -- | Show a value in the format, or error if unrepresentable formatShow :: Format t -> t -> String -- | Read a value in the format formatReadP :: Format t -> ReadP t -- | Parse a value in the format formatParseM :: MonadFail m => Format t -> String -> m t class ISO8601 t -- | The most commonly used ISO 8601 format for this type. iso8601Format :: ISO8601 t => Format t -- | Show in the most commonly used ISO 8601 format. iso8601Show :: ISO8601 t => t -> String -- | Parse the most commonly used ISO 8601 format. iso8601ParseM :: (MonadFail m, ISO8601 t) => String -> m t data FormatExtension -- | ISO 8601:2004(E) sec. 2.3.4. Use hyphens and colons. ExtendedFormat :: FormatExtension -- | ISO 8601:2004(E) sec. 2.3.3. Omit hyphens and colons. "The basic -- format should be avoided in plain text." BasicFormat :: FormatExtension -- | Read a value in either extended or basic format formatReadPExtension :: (FormatExtension -> Format t) -> ReadP t -- | Parse a value in either extended or basic format parseFormatExtension :: MonadFail m => (FormatExtension -> Format t) -> String -> m t -- | ISO 8601:2004(E) sec. 4.1.2.2 calendarFormat :: FormatExtension -> Format Day -- | ISO 8601:2004(E) sec. 4.1.2.3(a) yearMonthFormat :: Format (Integer, Int) -- | ISO 8601:2004(E) sec. 4.1.2.3(b) yearFormat :: Format Integer -- | ISO 8601:2004(E) sec. 4.1.2.3(c) centuryFormat :: Format Integer -- | ISO 8601:2004(E) sec. 4.1.2.4(a) expandedCalendarFormat :: Int -> FormatExtension -> Format Day -- | ISO 8601:2004(E) sec. 4.1.2.4(b) expandedYearMonthFormat :: Int -> Format (Integer, Int) -- | ISO 8601:2004(E) sec. 4.1.2.4(c) expandedYearFormat :: Int -> Format Integer -- | ISO 8601:2004(E) sec. 4.1.2.4(d) expandedCenturyFormat :: Int -> Format Integer -- | ISO 8601:2004(E) sec. 4.1.3.2 ordinalDateFormat :: FormatExtension -> Format Day -- | ISO 8601:2004(E) sec. 4.1.3.3 expandedOrdinalDateFormat :: Int -> FormatExtension -> Format Day -- | ISO 8601:2004(E) sec. 4.1.4.2 weekDateFormat :: FormatExtension -> Format Day -- | ISO 8601:2004(E) sec. 4.1.4.3 yearWeekFormat :: FormatExtension -> Format (Integer, Int) -- | ISO 8601:2004(E) sec. 4.1.4.2 expandedWeekDateFormat :: Int -> FormatExtension -> Format Day -- | ISO 8601:2004(E) sec. 4.1.4.3 expandedYearWeekFormat :: Int -> FormatExtension -> Format (Integer, Int) -- | ISO 8601:2004(E) sec. 4.2.2.2, 4.2.2.4(a) timeOfDayFormat :: FormatExtension -> Format TimeOfDay -- | ISO 8601:2004(E) sec. 4.2.2.3(a), 4.2.2.4(b) hourMinuteFormat :: FormatExtension -> Format TimeOfDay -- | ISO 8601:2004(E) sec. 4.2.2.3(b), 4.2.2.4(c) hourFormat :: Format TimeOfDay -- | ISO 8601:2004(E) sec. 4.2.2.5 withTimeDesignator :: Format t -> Format t -- | ISO 8601:2004(E) sec. 4.2.4 withUTCDesignator :: Format t -> Format t -- | ISO 8601:2004(E) sec. 4.2.5.1 timeOffsetFormat :: FormatExtension -> Format TimeZone -- | ISO 8601:2004(E) sec. 4.2.5.2 timeOfDayAndOffsetFormat :: FormatExtension -> Format (TimeOfDay, TimeZone) -- | ISO 8601:2004(E) sec. 4.3.2 localTimeFormat :: Format Day -> Format TimeOfDay -> Format LocalTime -- | ISO 8601:2004(E) sec. 4.3.2 zonedTimeFormat :: Format Day -> Format TimeOfDay -> FormatExtension -> Format ZonedTime -- | ISO 8601:2004(E) sec. 4.3.2 utcTimeFormat :: Format Day -> Format TimeOfDay -> Format UTCTime -- | ISO 8601:2004(E) sec. 4.3.3 dayAndTimeFormat :: Format Day -> Format time -> Format (Day, time) -- | ISO 8601:2004(E) sec. 4.3.3 timeAndOffsetFormat :: Format t -> FormatExtension -> Format (t, TimeZone) -- | ISO 8601:2004(E) sec. 4.4.3.2 durationDaysFormat :: Format CalendarDiffDays -- | ISO 8601:2004(E) sec. 4.4.3.2 durationTimeFormat :: Format CalendarDiffTime -- | ISO 8601:2004(E) sec. 4.4.3.3 alternativeDurationDaysFormat :: FormatExtension -> Format CalendarDiffDays -- | ISO 8601:2004(E) sec. 4.4.3.3 alternativeDurationTimeFormat :: FormatExtension -> Format CalendarDiffTime -- | ISO 8601:2004(E) sec. 4.4.4.1 intervalFormat :: Format a -> Format b -> Format (a, b) -- | ISO 8601:2004(E) sec. 4.5 recurringIntervalFormat :: Format a -> Format b -> Format (Int, a, b) instance Data.Time.Format.ISO8601.ISO8601 Data.Time.Calendar.Days.Day instance Data.Time.Format.ISO8601.ISO8601 Data.Time.LocalTime.Internal.TimeOfDay.TimeOfDay instance Data.Time.Format.ISO8601.ISO8601 Data.Time.LocalTime.Internal.TimeZone.TimeZone instance Data.Time.Format.ISO8601.ISO8601 Data.Time.LocalTime.Internal.LocalTime.LocalTime instance Data.Time.Format.ISO8601.ISO8601 Data.Time.LocalTime.Internal.ZonedTime.ZonedTime instance Data.Time.Format.ISO8601.ISO8601 Data.Time.Clock.Internal.UTCTime.UTCTime instance Data.Time.Format.ISO8601.ISO8601 Data.Time.Calendar.CalendarDiffDays.CalendarDiffDays instance Data.Time.Format.ISO8601.ISO8601 Data.Time.LocalTime.Internal.CalendarDiffTime.CalendarDiffTime instance Data.Fixed.HasResolution Data.Time.Format.ISO8601.E16 instance Data.Fixed.HasResolution Data.Time.Format.ISO8601.E14