Data.Hourglass

hourglass-0.2.10: simple performant time related library

License | BSD-style
Maintainer | Vincent Hanquez <vincent@snarc.org>
Stability | experimental
Portability | unknown
Safe Haskell | None
Language | Haskell2010

Data.Hourglass

Contents

- Generic time classes
- Elapsed time
- Generic conversion
- Date and Time
- Arithmetic
- Parsing and Printing
  - Format strings
  - Common built-in formats
  - Format methods
- Local time
  - Local time type
  - Local time creation and manipulation
- Calendar misc functions

Description

Types and methods for time manipulation.

The most basic type for time representation is Elapsed, which represent a number of elapsed seconds since the unix epoch.

Every other defined types can be convert to and from Elapsed type:

    timeGetElapsed (Date 1 2 3) :: Elapsed
    timeFromElapsed 123         :: DateTime

Local time is represented by any other time types (Elapsed, Date, DateTime, ..), but augmented by a Timezone offset in minutes.

    localTime (Date 2014 May 4) 600 -- local time at UTC+10 of May 4th 2014

Synopsis

- class Timeable t => Time t where
  - timeFromElapsedP :: ElapsedP -> t
  - timeFromElapsed :: Elapsed -> t
- class Timeable t where
  - timeGetElapsedP :: t -> ElapsedP
  - timeGetElapsed :: t -> Elapsed
  - timeGetNanoSeconds :: t -> NanoSeconds
- newtype Elapsed = Elapsed Seconds
- data ElapsedP = ElapsedP !Elapsed !NanoSeconds
- timeConvert :: (Timeable t1, Time t2) => t1 -> t2
- timeGetDate :: Timeable t => t -> Date
- timeGetDateTimeOfDay :: Timeable t => t -> DateTime
- timeGetTimeOfDay :: Timeable t => t -> TimeOfDay
- data Duration = Duration {
  - durationHours :: !Hours
  - durationMinutes :: !Minutes
  - durationSeconds :: !Seconds
  - durationNs :: !NanoSeconds
  }
- data Period = Period {
  - periodYears :: !Int
  - periodMonths :: !Int
  - periodDays :: !Int
  }
- class TimeInterval i where
  - toSeconds :: i -> Seconds
  - fromSeconds :: Seconds -> (i, Seconds)
- timeAdd :: (Time t, TimeInterval ti) => t -> ti -> t
- timeDiff :: (Timeable t1, Timeable t2) => t1 -> t2 -> Seconds
- timeDiffP :: (Timeable t1, Timeable t2) => t1 -> t2 -> (Seconds, NanoSeconds)
- dateAddPeriod :: Date -> Period -> Date
- module Data.Hourglass.Types
- data TimeFormatElem
  - = Format_Year2
  - | Format_Year4
  - | Format_Year
  - | Format_Month
  - | Format_Month2
  - | Format_MonthName_Short
  - | Format_DayYear
  - | Format_Day
  - | Format_Day2
  - | Format_Hour
  - | Format_Minute
  - | Format_Second
  - | Format_UnixSecond
  - | Format_MilliSecond
  - | Format_MicroSecond
  - | Format_NanoSecond
  - | Format_Precision Int
  - | Format_TimezoneName
  - | Format_TzHM_Colon
  - | Format_TzHM
  - | Format_Tz_Offset
  - | Format_Spaces
  - | Format_Text Char
  - | Format_Fct TimeFormatFct
- data TimeFormatFct = TimeFormatFct {
  - timeFormatFctName :: String
  - timeFormatParse :: DateTime -> String -> Either String (DateTime, String)
  - timeFormatPrint :: DateTime -> String
  }
- newtype TimeFormatString = TimeFormatString [TimeFormatElem]
- class TimeFormat format where
  - toFormat :: format -> TimeFormatString
- data ISO8601_Date = ISO8601_Date
- data ISO8601_DateAndTime = ISO8601_DateAndTime
- timePrint :: (TimeFormat format, Timeable t) => format -> t -> String
- timeParse :: TimeFormat format => format -> String -> Maybe DateTime
- timeParseE :: TimeFormat format => format -> String -> Either (TimeFormatElem, String) (DateTime, String)
- localTimePrint :: (TimeFormat format, Timeable t) => format -> LocalTime t -> String
- localTimeParse :: TimeFormat format => format -> String -> Maybe (LocalTime DateTime)
- localTimeParseE :: TimeFormat format => format -> String -> Either (TimeFormatElem, String) (LocalTime DateTime, String)
- data LocalTime t
- localTime :: Time t => TimezoneOffset -> t -> LocalTime t
- localTimeUnwrap :: LocalTime t -> t
- localTimeToGlobal :: Time t => LocalTime t -> t
- localTimeFromGlobal :: Time t => t -> LocalTime t
- localTimeGetTimezone :: LocalTime t -> TimezoneOffset
- localTimeSetTimezone :: Time t => TimezoneOffset -> LocalTime t -> LocalTime t
- localTimeConvert :: (Time t1, Time t2) => LocalTime t1 -> LocalTime t2
- class Timezone tz where
  - timezoneOffset :: tz -> Int
  - timezoneName :: tz -> String
- data UTC = UTC
- newtype TimezoneMinutes = TimezoneMinutes Int
- isLeapYear :: Int -> Bool
- getWeekDay :: Date -> WeekDay
- getDayOfTheYear :: Date -> Int

# Generic time classes

class Timeable t => Time t where

Represent time types that can be created from other time types.

Every conversion happens throught ElapsedP or Elapsed types.

Minimal complete definition

timeFromElapsedP

Methods

timeFromElapsedP :: ElapsedP -> t

convert from a number of elapsed seconds and nanoseconds to another time representation

timeFromElapsed :: Elapsed -> t

convert from a number of elapsed seconds and nanoseconds to another time representation

defaults to timeFromElapsedP unless defined explicitely by an instance.

Instances

Time CTime |
Time DateTime |
Time Date |
Time ElapsedP |
Time Elapsed |
Epoch epoch => Time (ElapsedSinceP epoch) |
Epoch epoch => Time (ElapsedSince epoch) |

class Timeable t where

Timeable represent every type that can be made to look like time types.

- can be converted to ElapsedP and Elapsed
- optionally have a timezone associated
- have nanoseconds accessor (which can return 0 when the type is not more precise than seconds)

Minimal complete definition

timeGetElapsedP

Methods

timeGetElapsedP :: t -> ElapsedP

convert a time representation to the number of elapsed seconds and nanoseconds to a specific epoch

timeGetElapsed :: t -> Elapsed

convert a time representation to the number of elapsed seconds to a specific epoch.

defaults to timeGetElapsedP unless defined explicitely by an instance

timeGetNanoSeconds :: t -> NanoSeconds

return the number of optional nanoseconds.

If the underlaying type is not precise enough to record nanoseconds (or any variant between seconds and nanoseconds), 0 should be returned

defaults to `timeGetElapsedP` unless defined explicitely by an instance, for efficiency reason, it's a good idea to override this methods if you know the type is not more precise than Seconds.

Instances

Timeable CTime |
Timeable DateTime |
Timeable Date |
Timeable ElapsedP |
Timeable Elapsed |
Epoch epoch => Timeable (ElapsedSinceP epoch) |
Epoch epoch => Timeable (ElapsedSince epoch) |

# Elapsed time

newtype Elapsed

A number of seconds elapsed since the unix epoch.

Constructors

Elapsed Seconds |

Instances

Eq Elapsed |
Data Elapsed |
Num Elapsed |
Ord Elapsed |
Read Elapsed |
Show Elapsed |
NFData Elapsed |
Time Elapsed |
Timeable Elapsed |

data ElapsedP

A number of seconds and nanoseconds elapsed since the unix epoch.

Constructors

ElapsedP !Elapsed !NanoSeconds |

Instances

Eq ElapsedP |
Data ElapsedP |
Num ElapsedP |
Ord ElapsedP |
Read ElapsedP |
Real ElapsedP |
Show ElapsedP |
NFData ElapsedP |
Time ElapsedP |
Timeable ElapsedP |

# Generic conversion

timeConvert :: (Timeable t1, Time t2) => t1 -> t2

Convert one time representation into another one

The return type need to be infer by the context.

If the context cannot be infer through this, some specialized functions are available for built-in types:

- `timeGetDate`
- `timeGetDateTimeOfDay`
- `timeGetElapsed`, `timeGetElapsedP`

# Date and Time

timeGetDate :: Timeable t => t -> Date

Get the calendar Date (year-month-day) from a time representation

specialization of `timeConvert`

timeGetDateTimeOfDay :: Timeable t => t -> DateTime

Get the date and time of day from a time representation

specialization of `timeConvert`

timeGetTimeOfDay :: Timeable t => t -> TimeOfDay

Get the day time (hours:minutes:seconds) from a time representation

specialization of `timeConvert`

# Arithmetic

data Duration

An amount of time in terms of constant value like hours (3600 seconds), minutes (60 seconds), seconds and nanoseconds.

Constructors

Duration |
Fields durationHours :: !Hours number of hours durationMinutes :: !Minutes number of minutes durationSeconds :: !Seconds number of seconds durationNs :: !NanoSeconds number of nanoseconds

Instances

Eq Duration |
Data Duration |
Ord Duration |
Read Duration |
Show Duration |
Monoid Duration |
NFData Duration |
TimeInterval Duration |

data Period

An amount of conceptual calendar time in terms of years, months and days.

This allow calendar manipulation, representing things like days and months irrespective on how long those are related to timezone and daylight changes.

See `Duration` for the time-based equivalent to this class.

Constructors

Period |
Fields periodYears :: !Int periodMonths :: !Int periodDays :: !Int

Instances

Eq Period |
Data Period |
Ord Period |
Read Period |
Show Period |
Monoid Period |
NFData Period |

class TimeInterval i where

Represent any time interval that has an equivalent value to a number of seconds.

Methods

toSeconds :: i -> Seconds

fromSeconds :: Seconds -> (i, Seconds)

Instances

TimeInterval Hours |
TimeInterval Minutes |
TimeInterval Seconds |
TimeInterval NanoSeconds |
TimeInterval Duration |

timeAdd :: (Time t, TimeInterval ti) => t -> ti -> t

add some time interval to a time representation and returns this new time representation

example:

    t1 `timeAdd` mempty { durationHours = 12 }

timeDiff :: (Timeable t1, Timeable t2) => t1 -> t2 -> Seconds

Get the difference in seconds between two time representation

effectively:

    t2 `timeDiff` t1 = t2 - t1

timeDiffP :: (Timeable t1, Timeable t2) => t1 -> t2 -> (Seconds, NanoSeconds)

Get the difference in seconds and nanoseconds between two time representation

effectively:

    @t2 `timeDiffP` t1 = t2 - t1

dateAddPeriod :: Date -> Period -> Date

add a period of time to a date

module Data.Hourglass.Types

# Parsing and Printing

## Format strings

data TimeFormatElem

All the various formatter that can be part of a time format string

Constructors

Format_Year2 | 2 digit years (70 is 1970, 69 is 2069)
Format_Year4 | 4 digits years
Format_Year | any digits years
Format_Month | months (1 to 12)
Format_Month2 | months padded to 2 chars (01 to 12)
Format_MonthName_Short | name of the month short (`Jan`, `Feb` ..)
Format_DayYear | day of the year (1 to 365, 366 for leap years)
Format_Day | day of the month (1 to 31)
Format_Day2 | day of the month (01 to 31)
Format_Hour | hours (0 to 23)
Format_Minute | minutes (0 to 59)
Format_Second | seconds (0 to 59, 60 for leap seconds)
Format_UnixSecond | number of seconds since 1 jan 1970. unix epoch.
Format_MilliSecond | Milliseconds (000 to 999)
Format_MicroSecond | MicroSeconds (000000 to 999999)
Format_NanoSecond | NanoSeconds (000000000 to 999999999)
Format_Precision Int | sub seconds display with a precision of N digits. with N between 1 and 9
Format_TimezoneName | timezone name (e.g. GMT, PST). not implemented yet | Format_TimezoneOffset -- ^ timeoffset offset (+02:00)
Format_TzHM_Colon | timeoffset offset with colon (+02:00)
Format_TzHM | timeoffset offset (+0200)
Format_Tz_Offset | timeoffset in minutes
Format_Spaces | one or many space-like chars
Format_Text Char | a verbatim char
Format_Fct TimeFormatFct |

Instances

Eq TimeFormatElem |
Show TimeFormatElem |
TimeFormat [TimeFormatElem] |

data TimeFormatFct

A generic format function composed of a parser and a printer.

Constructors

TimeFormatFct |
Fields timeFormatFctName :: String timeFormatParse :: DateTime -> String -> Either String (DateTime, String) timeFormatPrint :: DateTime -> String

Instances

Eq TimeFormatFct |
Show TimeFormatFct |

newtype TimeFormatString

A time format string, composed of list of `TimeFormatElem`

Constructors

TimeFormatString [TimeFormatElem] |

Instances

Eq TimeFormatString |
Show TimeFormatString |
TimeFormat TimeFormatString |

class TimeFormat format where

A generic class for anything that can be considered a Time Format string.

Methods

toFormat :: format -> TimeFormatString

Instances

TimeFormat String |
TimeFormat ISO8601_DateAndTime |
TimeFormat ISO8601_Date |
TimeFormat TimeFormatString |
TimeFormat [TimeFormatElem] |

## Common built-in formats

data ISO8601_Date

ISO8601 Date format string.

e.g. 2014-04-05

Constructors

ISO8601_Date |

Instances

Eq ISO8601_Date |
Show ISO8601_Date |
TimeFormat ISO8601_Date |

data ISO8601_DateAndTime

ISO8601 Date and Time format string.

e.g. 2014-04-05T17:25:04+00:00 2014-04-05T17:25:04Z

Constructors

ISO8601_DateAndTime |

Instances

Eq ISO8601_DateAndTime |
Show ISO8601_DateAndTime |
TimeFormat ISO8601_DateAndTime |

## Format methods

timePrint

Arguments

:: (TimeFormat format, Timeable t) |
=> format | the format to use for printing
-> t | the global time to print
-> String | the resulting string

Pretty print time to a string

The actual output is determined by the format used

timeParse :: TimeFormat format => format -> String -> Maybe DateTime

Just like `localTimeParse` but the time is automatically converted to global time.

timeParseE :: TimeFormat format => format -> String -> Either (TimeFormatElem, String) (DateTime, String)

like `localTimeParseE` but the time value is automatically converted to global time.

localTimePrint

Arguments

:: (TimeFormat format, Timeable t) |
=> format | the format to use for printing
-> LocalTime t | the local time to print
-> String | the resulting local time string

Pretty print local time to a string.

The actual output is determined by the format used.

localTimeParse

Arguments

:: TimeFormat format |
=> format | the format to use for parsing
-> String | the string to parse
-> Maybe (LocalTime DateTime) |

Try parsing a string as time using the format explicitely specified

Unparsed characters are ignored and the error handling is simplified

for more elaborate need use `localTimeParseE`.

localTimeParseE

Arguments

:: TimeFormat format |
=> format | the format to use for parsing
-> String | the string to parse
-> Either (TimeFormatElem, String) (LocalTime DateTime, String) |

Try parsing a string as time using the format explicitely specified

On failure, the parsing function returns the reason of the failure. If parsing is successful, return the date parsed with the remaining unparsed string

# Local time

## Local time type

data LocalTime t

Local time representation

this is a time representation augmented by a timezone to get back to a global time, the timezoneOffset needed to be added to the local time.

Instances

Functor LocalTime |
Eq t => Eq (LocalTime t) |
(Ord t, Time t) => Ord (LocalTime t) |
Show t => Show (LocalTime t) |

## Local time creation and manipulation

localTime :: Time t => TimezoneOffset -> t -> LocalTime t

Create a local time type from a timezone and a time type.

The time value is assumed to be local to the timezone offset set, so no transformation is done.

localTimeUnwrap :: LocalTime t -> t

unwrap the LocalTime value. the time value is local.

localTimeToGlobal :: Time t => LocalTime t -> t

Get back a global time value

localTimeFromGlobal :: Time t => t -> LocalTime t

create a local time value from a global one

localTimeGetTimezone :: LocalTime t -> TimezoneOffset

get the timezone associated with LocalTime

localTimeSetTimezone :: Time t => TimezoneOffset -> LocalTime t -> LocalTime t

Change the timezone, and adjust the local value to represent the new local value.

localTimeConvert :: (Time t1, Time t2) => LocalTime t1 -> LocalTime t2

convert the local time representation to another time representation determined by context.

class Timezone tz where

standard representation for timezone

Minimal complete definition

timezoneOffset

Methods

timezoneOffset :: tz -> Int

offset in minutes from UTC. valid values should be between -12*60 to +14*60

timezoneName :: tz -> String

the name of the timezone. by default will be +-HH:MM encoding.

Instances

Timezone UTC |
Timezone TimezoneMinutes |

data UTC

Universal Time Coordinated. The generic computer "timezone".

Constructors

UTC |

Instances

Eq UTC |
Ord UTC |
Show UTC |
Timezone UTC |

newtype TimezoneMinutes

Simple timezone containing the number of minutes difference with UTC.

Valid values should be between -12*60 to +14*60

Constructors

TimezoneMinutes Int |

Instances

Eq TimezoneMinutes |
Ord TimezoneMinutes |
Show TimezoneMinutes |
Timezone TimezoneMinutes |

# Calendar misc functions

isLeapYear :: Int -> Bool

Return if this year is a leap year (366 days) or not (365 days in a year)

getWeekDay :: Date -> WeekDay

Return the day of the week a specific date fall in

getDayOfTheYear :: Date -> Int

return the day of the year where Jan 1 is 0

between 0 and 364. 365 for leap years