-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | A pragmatic time and date library. -- @package utc @version 0.2.0.1 module Data.UTC -- | This class captures the behaviour of the Proleptic Gregorian -- Calendar. -- -- Without any exception the following holds: -- -- class Epoch t => IsDate t where addYears ys t = if isValidDate (year t + ys, month t, day t) then setYear (year t + ys) t else setYear (year t + ys) =<< setDay (day t - 1) t addMonths ms t = setDay 1 t >>= setYear y >>= setMonth m >>= setDay d where ym = (year t * monthsPerYear) + (month t - 1) + ms y = ym `div` monthsPerYear m = (ym `mod` monthsPerYear) + 1 d' = day t d | isValidDate (y, m, d') = d' | isValidDate (y, m, d' - 1) = d' - 1 | isValidDate (y, m, d' - 2) = d' - 2 | otherwise = d' - 3 addDays ds t = setDay 1 t >>= setYear y >>= setMonth m >>= setDay d where ds' = yearMonthDayToDays (year t, month t, day t) (y, m, d) = daysToYearMonthDay (ds' + ds) year :: IsDate t => t -> Integer month :: IsDate t => t -> Integer day :: IsDate t => t -> Integer setYear :: (IsDate t, MonadThrow m) => Integer -> t -> m t setMonth :: (IsDate t, MonadThrow m) => Integer -> t -> m t setDay :: (IsDate t, MonadThrow m) => Integer -> t -> m t addYears :: (IsDate t, MonadThrow m) => Integer -> t -> m t addMonths :: (IsDate t, MonadThrow m) => Integer -> t -> m t addDays :: (IsDate t, MonadThrow m) => Integer -> t -> m t -- | This class captures the concept of a 24-hour clock time during a day. class IsTime t where addHours h t = setHour hors t where h' = h + (hour t) hors = h' `mod` hoursPerDay addMinutes m t = setMinute mins t >>= addHours hors where m' = m + (minute t) mins = m' `mod` minsPerHour hors = m' `div` minsPerHour addSeconds s t = setSecond secs t >>= addMinutes mins where s' = s + (second t) secs = s' `mod` secsPerMinute mins = s' `div` secsPerMinute addSecondFractions f t | f == 0 = return t | f >= 0 = setSecondFraction frcs t >>= addSeconds secs | otherwise = setSecondFraction (frcs + 1.0) t >>= addSeconds (secs - 1) where f' = f + (secondFraction t) frcs = f' - (truncate f' % 1) secs = truncate f' hour :: IsTime t => t -> Integer minute :: IsTime t => t -> Integer second :: IsTime t => t -> Integer secondFraction :: IsTime t => t -> Rational setHour :: (IsTime t, MonadThrow m) => Integer -> t -> m t setMinute :: (IsTime t, MonadThrow m) => Integer -> t -> m t setSecond :: (IsTime t, MonadThrow m) => Integer -> t -> m t setSecondFraction :: (IsTime t, MonadThrow m) => Rational -> t -> m t addHours :: (IsTime t, MonadThrow m) => Integer -> t -> m t addMinutes :: (IsTime t, MonadThrow m) => Integer -> t -> m t addSeconds :: (IsTime t, MonadThrow m) => Integer -> t -> m t addSecondFractions :: (IsTime t, MonadThrow m) => Rational -> t -> m t -- | This class is for types that have a well-defined mapping to and from -- the Unix Time system (based on UTC). -- -- Beware: It is a common misconception that the Unix time in -- general counts SI seconds since 1970-01-01T00:00:00Z. There is -- a common definition that may be called Unix time based on UTC: -- In general, the second boundaries match with UTC, but in the event of -- a positive (or negative) leap second the Unix second has a duration of -- 2 (or 0) SI seconds. This library is in accordance with this -- definition. This definition can also be understood as "ignoring leap -- seconds" (a Unix day therefore always has 86400 Unix seconds). -- -- The concrete behaviour of your system clock is implementation -- dependant. class IsUnixTime t unixSeconds :: IsUnixTime t => t -> Rational fromUnixSeconds :: (IsUnixTime t, MonadThrow m) => Rational -> m t -- | The instant in time also known as the epoch: -- 1970-01-01T00:00:00Z class Epoch t epoch :: Epoch t => t -- | This class defines an interface for contexts that can be asked for a -- timestamp. -- -- Most users are likely to just need the IO instance, but you -- might think of other instances: -- -- class HasUnixTime m getUnixTime :: (HasUnixTime m, Monad m, IsUnixTime a) => m a -- | This type represents dates in the Proleptic Gregorian Calendar. -- -- -- -- 
--   > show (epoch :: Date)
--   1970-01-01
--
data Date -- | This type represents time instants during a day (00:00:00 - -- 23:59:59.999..) with arbitrary precision (uses Integer -- internally). -- -- -- -- 
--   > show (epoch :: Time)
--   00:00:00
--
data Time -- | A time representation based on a Date and the Time of -- the day. -- -- -- -- 
--   > show (epoch :: DateTime)
--   1970-01-01T00:00:00
--
data DateTime DateTime :: Date -> Time -> DateTime date :: DateTime -> Date time :: DateTime -> Time -- | This type is used to extend UTC time types by a local offset in -- seconds (positive or negative). -- -- Beware: A local offset is not a time zone. It is just a fix -- period of time. In contrast to a time zone this does not take summer -- or winter time into account. data Local time Local :: Maybe Rational -> time -> Local time -- | offset :: Local time -> Maybe Rational -- | The time to be interpreted as UTC+00:00 (Western -- European Time) utc :: Local time -> time -- | All non-total functions within this library throw a -- UtcException exception within a MonadThrow context. Use -- MonadCatch to specifically catch this exception. -- -- The String contains information that might be useful for -- debugging, but its specific form is undefined and must not be relied -- on. data UtcException UtcException :: String -> UtcException class Rfc3339Parser a parseRfc3339 :: (Rfc3339Parser a, MonadThrow m, IsDate t, IsTime t, Epoch t) => a -> m (Local t) -- | 
--   setYear 1987 (epoch :: DateTime) 
--     >>= setMonth 7 
--     >>= setDay 10 
--     >>= setHour 12 
--     >>= setMinute 4 
--     >>= return . (flip Local) (Just 0) 
--     >>= renderRfc3339 :: Maybe String
--   > Just "1987-07-10T12:04:00Z"
--
class Rfc3339Renderer string renderRfc3339 :: (Rfc3339Renderer string, MonadThrow m, IsDate t, IsTime t, Epoch t) => Local t -> m string class Iso8601Renderer string renderIso8601CalendarDate :: (Iso8601Renderer string, MonadThrow m, IsDate t) => t -> m string renderIso8601CalendarDate' :: (Iso8601Renderer string, MonadThrow m, IsDate t) => t -> m string renderIso8601TimeHms :: (Iso8601Renderer string, MonadThrow m, IsTime t) => t -> m string renderIso8601TimeHms' :: (Iso8601Renderer string, MonadThrow m, IsTime t) => t -> m string renderIso8601TimeHm :: (Iso8601Renderer string, MonadThrow m, IsTime t) => t -> m string renderIso8601TimeHm' :: (Iso8601Renderer string, MonadThrow m, IsTime t) => t -> m string