Data.Formatter.DateTime

type Formatter = List FormatterCommand

A description of a string format for dates and times. Functions such as format and unformat use a Formatter such as (YearFull : MonthTwoDigits : DayOfMonthTwoDigits : Nil) in place of a format string such as "YYYYMMDD".

data FormatterCommand

One part of a DateTime Formatter. Use Placeholder for any static portion of the format, such as whitespace or separators - or :.

Constructors

• YearFull
• YearTwoDigits
• YearAbsolute
• MonthFull
• MonthShort
• MonthDigit
• MonthTwoDigits
• DayOfMonthTwoDigits
• DayOfMonth
• UnixTimestamp
• DayOfWeek
• DayOfWeekName
• DayOfWeekNameShort
• Hours24
• Hours12
• Meridiem
• MeridiemLowerCase
• Minutes
• MinutesTwoDigits
• Seconds
• SecondsTwoDigits
• Milliseconds
• MillisecondsShort
• MillisecondsTwoDigits
• Placeholder String

Instances

• Eq FormatterCommand
• Ord FormatterCommand
• Generic FormatterCommand _
• Show FormatterCommand

data Meridiem

Before or after noon (AM/PM)

Instances

• Eq Meridiem

printFormatter :: Formatter -> String

The format string representation of a Formatter.

show (Hours24 : MinutesTwoDigits : Nil) = "(Hours24 : MinutesTwoDigits : Nil)"

while printFormatter (Hours24 : MinutesTwoDigits : Nil) = "HHmm".

printFormatterCommand :: FormatterCommand -> String

parseFormatString :: String -> Either String Formatter

Attempt to parse a String as a Formatter.

format :: Formatter -> DateTime -> String

Format a DateTime according to the format defined in the given Formatter.

formatDateTime :: String -> DateTime -> Either String String

Format a DateTime according to the format defined in the given format string. If the format string is empty or contains a reserved character such as a single "H", will return a Left value. Note that any non-reserved Char is treated as a placeholder, so while "yyyy-MM-dd" might not produce the format you want (since "yyyy" isn't a recognized format), it will still return a Right value.

unformat :: Formatter -> String -> Either String DateTime

Attempt to parse a String as a DateTime according to the format defined in the given Formatter.

unformatDateTime :: String -> String -> Either String DateTime

Attempt to parse a String as a DateTime according to the format defined in the given format string. Returns a Left value if the given format string was empty, or if the date string fails to parse according to the format.

unformatParser :: forall m. Monad m => Formatter -> ParserT String m DateTime

A ParserT for Strings that parses a DateTime according to the format defined in the given Formatter.