| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Chronos
Contents
Description
Chronos is a performance-oriented time library for Haskell, with a straightforward API. The main differences between this and the time library are:
- Chronos uses machine integers where possible. This means that time-related arithmetic should be faster, with the drawback that the types are incapable of representing times that are very far in the future or the past (because Chronos provides nanosecond, rather than picosecond, resolution). For most users, this is not a hindrance.
- Chronos provides 'ToJSON'/'FromJSON' instances for serialisation.
- Chronos provides
Unboxinstances for working with unboxed vectors. - Chronos provides
Priminstances for working with byte arrays/primitive arrays. - Chronos uses normal non-overloaded haskell functions for
encoding and decoding time. It provides attoparsec parsers for both
TextandByteString. Additionally, Chronos provides functions for encoding time toTextorByteString. The http://hackage.haskell.org/package/time time> library accomplishes these with the Data.Time.Format module, which uses UNIX-style datetime format strings. The approach taken by Chronos is faster and catches more mistakes at compile time, at the cost of being less expressive.
Synopsis
- now :: IO Time
- today :: IO Day
- tomorrow :: IO Day
- yesterday :: IO Day
- epoch :: Time
- stopwatch :: IO a -> IO (Timespan, a)
- stopwatch_ :: IO a -> IO Timespan
- stopwatchWith :: Clock -> IO a -> IO (Timespan, a)
- stopwatchWith_ :: Clock -> IO a -> IO Timespan
- datetimeFromYmdhms :: Int -> Int -> Int -> Int -> Int -> Int -> Datetime
- timeFromYmdhms :: Int -> Int -> Int -> Int -> Int -> Int -> Time
- timeToDatetime :: Time -> Datetime
- datetimeToTime :: Datetime -> Time
- timeToOffsetDatetime :: Offset -> Time -> OffsetDatetime
- offsetDatetimeToTime :: OffsetDatetime -> Time
- timeToDayTruncate :: Time -> Day
- dayToTimeMidnight :: Day -> Time
- dayToDate :: Day -> Date
- dateToDay :: Date -> Day
- dayToOrdinalDate :: Day -> OrdinalDate
- ordinalDateToDay :: OrdinalDate -> Day
- monthDateToDayOfYear :: Bool -> MonthDate -> DayOfYear
- dayOfYearToMonthDay :: Bool -> DayOfYear -> MonthDate
- second :: Timespan
- minute :: Timespan
- hour :: Timespan
- day :: Timespan
- week :: Timespan
- buildDayOfWeekMatch :: a -> a -> a -> a -> a -> a -> a -> DayOfWeekMatch a
- buildMonthMatch :: a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> MonthMatch a
- buildUnboxedMonthMatch :: Unbox a => a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> UnboxedMonthMatch a
- caseDayOfWeek :: DayOfWeekMatch a -> DayOfWeek -> a
- caseMonth :: MonthMatch a -> Month -> a
- caseUnboxedMonth :: Unbox a => UnboxedMonthMatch a -> Month -> a
- w3c :: DatetimeFormat
- slash :: DatetimeFormat
- hyphen :: DatetimeFormat
- compact :: DatetimeFormat
- january :: Month
- february :: Month
- march :: Month
- april :: Month
- may :: Month
- june :: Month
- july :: Month
- august :: Month
- september :: Month
- october :: Month
- november :: Month
- december :: Month
- sunday :: DayOfWeek
- monday :: DayOfWeek
- tuesday :: DayOfWeek
- wednesday :: DayOfWeek
- thursday :: DayOfWeek
- friday :: DayOfWeek
- saturday :: DayOfWeek
- daysInMonth :: Bool -> Month -> Int
- isLeapYear :: Year -> Bool
- observedOffsets :: Vector Offset
- builder_Ymd :: Maybe Char -> Date -> Builder
- builder_Dmy :: Maybe Char -> Date -> Builder
- builder_HMS :: SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
- parser_Ymd :: Maybe Char -> Parser Date
- parser_Mdy :: Maybe Char -> Parser Date
- parser_Dmy :: Maybe Char -> Parser Date
- builderUtf8_Ymd :: Maybe Char -> Date -> Builder
- parserUtf8_Ymd :: Maybe Char -> Parser Date
- builder_IMS_p :: MeridiemLocale Text -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
- builder_IMSp :: MeridiemLocale Text -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
- parser_HMS :: Maybe Char -> Parser TimeOfDay
- parser_HMS_opt_S :: Maybe Char -> Parser TimeOfDay
- builderUtf8_HMS :: SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
- builderUtf8_IMS_p :: MeridiemLocale ByteString -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
- builderUtf8_IMSp :: MeridiemLocale ByteString -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder
- parserUtf8_HMS :: Maybe Char -> Parser TimeOfDay
- parserUtf8_HMS_opt_S :: Maybe Char -> Parser TimeOfDay
- zeptoUtf8_HMS :: Maybe Char -> Parser TimeOfDay
- builder_DmyHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builder_DmyIMSp :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builder_DmyIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builder_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builder_YmdIMSp :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builder_YmdIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builderW3C :: Datetime -> Builder
- encode_DmyHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Text
- encode_DmyIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Text
- encode_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Text
- encode_YmdIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Text
- parser_DmyHMS :: DatetimeFormat -> Parser Datetime
- parser_YmdHMS :: DatetimeFormat -> Parser Datetime
- parser_YmdHMS_opt_S :: DatetimeFormat -> Parser Datetime
- parser_DmyHMS_opt_S :: DatetimeFormat -> Parser Datetime
- decode_DmyHMS :: DatetimeFormat -> Text -> Maybe Datetime
- decode_YmdHMS :: DatetimeFormat -> Text -> Maybe Datetime
- decode_YmdHMS_opt_S :: DatetimeFormat -> Text -> Maybe Datetime
- decode_DmyHMS_opt_S :: DatetimeFormat -> Text -> Maybe Datetime
- encodeUtf8_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> ByteString
- encodeUtf8_YmdIMS_p :: MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> Datetime -> ByteString
- builderUtf8_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builderUtf8_YmdIMSp :: MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builderUtf8_YmdIMS_p :: MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder
- builderUtf8W3C :: Datetime -> Builder
- decodeUtf8_YmdHMS :: DatetimeFormat -> ByteString -> Maybe Datetime
- decodeUtf8_YmdHMS_opt_S :: DatetimeFormat -> ByteString -> Maybe Datetime
- parserUtf8_YmdHMS :: DatetimeFormat -> Parser Datetime
- parserUtf8_YmdHMS_opt_S :: DatetimeFormat -> Parser Datetime
- zeptoUtf8_YmdHMS :: DatetimeFormat -> Parser Datetime
- encode_YmdHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Text
- encode_DmyHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Text
- builder_YmdHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder
- builder_DmyHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder
- parser_YmdHMSz :: OffsetFormat -> DatetimeFormat -> Parser OffsetDatetime
- parser_DmyHMSz :: OffsetFormat -> DatetimeFormat -> Parser OffsetDatetime
- builder_YmdIMS_p_z :: OffsetFormat -> MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder
- builder_DmyIMS_p_z :: OffsetFormat -> MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder
- builderW3Cz :: OffsetDatetime -> Builder
- builderUtf8_YmdHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder
- parserUtf8_YmdHMSz :: OffsetFormat -> DatetimeFormat -> Parser OffsetDatetime
- builderUtf8_YmdIMS_p_z :: OffsetFormat -> MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder
- builderUtf8W3Cz :: OffsetDatetime -> Builder
- encodeOffset :: OffsetFormat -> Offset -> Text
- builderOffset :: OffsetFormat -> Offset -> Builder
- decodeOffset :: OffsetFormat -> Text -> Maybe Offset
- parserOffset :: OffsetFormat -> Parser Offset
- encodeOffsetUtf8 :: OffsetFormat -> Offset -> ByteString
- builderOffsetUtf8 :: OffsetFormat -> Offset -> Builder
- decodeOffsetUtf8 :: OffsetFormat -> ByteString -> Maybe Offset
- parserOffsetUtf8 :: OffsetFormat -> Parser Offset
- encodeTimespan :: SubsecondPrecision -> Timespan -> Text
- builderTimespan :: SubsecondPrecision -> Timespan -> Builder
- encodeTimespanUtf8 :: SubsecondPrecision -> Timespan -> ByteString
- builderTimespanUtf8 :: SubsecondPrecision -> Timespan -> Builder
- within :: Time -> TimeInterval -> Bool
- timeIntervalToTimespan :: TimeInterval -> Timespan
- whole :: TimeInterval
- singleton :: Time -> TimeInterval
- lowerBound :: TimeInterval -> Time
- upperBound :: TimeInterval -> Time
- width :: TimeInterval -> Timespan
- timeIntervalBuilder :: Time -> Time -> TimeInterval
- (...) :: Time -> Time -> TimeInterval
- newtype Day = Day {}
- newtype DayOfWeek = DayOfWeek {
- getDayOfWeek :: Int
- newtype DayOfMonth = DayOfMonth {
- getDayOfMonth :: Int
- newtype DayOfYear = DayOfYear {
- getDayOfYear :: Int
- newtype Month = Month {}
- newtype Year = Year {}
- newtype Offset = Offset {}
- newtype Time = Time {}
- newtype DayOfWeekMatch a = DayOfWeekMatch {
- getDayOfWeekMatch :: Vector a
- newtype MonthMatch a = MonthMatch {
- getMonthMatch :: Vector a
- newtype UnboxedMonthMatch a = UnboxedMonthMatch {}
- newtype Timespan = Timespan {
- getTimespan :: Int64
- data SubsecondPrecision
- data Date = Date {}
- data OrdinalDate = OrdinalDate {}
- data MonthDate = MonthDate {}
- data Datetime = Datetime {
- datetimeDate :: !Date
- datetimeTime :: !TimeOfDay
- data OffsetDatetime = OffsetDatetime {}
- data TimeOfDay = TimeOfDay {
- timeOfDayHour :: !Int
- timeOfDayMinute :: !Int
- timeOfDayNanoseconds :: !Int64
- data DatetimeFormat = DatetimeFormat {}
- data OffsetFormat
- data DatetimeLocale a = DatetimeLocale {}
- data MeridiemLocale a = MeridiemLocale {
- meridiemLocaleAm :: !a
- meridiemLocalePm :: !a
- data TimeInterval = TimeInterval !Time !Time
Functions
Current
Duration
stopwatch :: IO a -> IO (Timespan, a) Source #
Measures the time it takes to run an action and evaluate its result to WHNF. This measurement uses a monotonic clock instead of the standard system clock.
stopwatch_ :: IO a -> IO Timespan Source #
Measures the time it takes to run an action. The result is discarded. This measurement uses a monotonic clock instead of the standard system clock.
stopwatchWith :: Clock -> IO a -> IO (Timespan, a) Source #
Variant of stopwatch that accepts a clock type. Users
need to import System.Clock from the clock package
in order to provide the clock type.
stopwatchWith_ :: Clock -> IO a -> IO Timespan Source #
Variant of stopwatch_ that accepts a clock type.
Construction
Construct a Datetime from year, month, day, hour, minute, second:
>>>datetimeFromYmdhms 2014 2 26 17 58 52Datetime {datetimeDate = Date {dateYear = Year {getYear = 2014}, dateMonth = Month {getMonth = 1}, dateDay = DayOfMonth {getDayOfMonth = 26}}, datetimeTime = TimeOfDay {timeOfDayHour = 17, timeOfDayMinute = 58, timeOfDayNanoseconds = 52000000000}}
Construct a Time from year, month, day, hour, minute, second:
>>>timeFromYmdhms 2014 2 26 17 58 52Time {getTime = 1393437532000000000}
Conversion
timeToDatetime :: Time -> Datetime Source #
datetimeToTime :: Datetime -> Time Source #
timeToOffsetDatetime :: Offset -> Time -> OffsetDatetime Source #
Convert Time to OffsetDatetime by providing an Offset.
offsetDatetimeToTime :: OffsetDatetime -> Time Source #
Convert OffsetDatetime to Time.
timeToDayTruncate :: Time -> Day Source #
Convert Time to Day. This function is lossy; consequently, it
does not roundtrip with dayToTimeMidnight.
dayToOrdinalDate :: Day -> OrdinalDate Source #
Convert a Day to an OrdinalDate.
ordinalDateToDay :: OrdinalDate -> Day Source #
Convert an OrdinalDate to a Day.
Build Timespan
Matching
buildDayOfWeekMatch :: a -> a -> a -> a -> a -> a -> a -> DayOfWeekMatch a Source #
Build a DayOfWeekMatch from seven (7) values.
buildMonthMatch :: a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> MonthMatch a Source #
Build a MonthMatch from twelve (12) values.
buildUnboxedMonthMatch :: Unbox a => a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> a -> UnboxedMonthMatch a Source #
Build an UnboxedMonthMatch from twelve (12) values.
caseDayOfWeek :: DayOfWeekMatch a -> DayOfWeek -> a Source #
Match a DayOfWeek against a DayOfWeekMatch.
caseMonth :: MonthMatch a -> Month -> a Source #
Match a Month against a MonthMatch.
caseUnboxedMonth :: Unbox a => UnboxedMonthMatch a -> Month -> a Source #
Match a Month against an UnboxedMonthMatch.
Format
The formats provided is this module are language-agnostic. To find meridiem formats and month formats, look in a language-specific module.
w3c :: DatetimeFormat Source #
The W3C DatetimeFormat.
>>>encode_YmdHMS SubsecondPrecisionAuto w3c (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"2014-02-26T17:58:52"
\(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS w3c (encode_YmdHMS s w3c dt))
slash :: DatetimeFormat Source #
A DatetimeFormat that separates the members of
the Date by slashes.
>>>encode_YmdHMS SubsecondPrecisionAuto slash (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"2014/02/26 17:58:52"
\(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS slash (encode_YmdHMS s slash dt))
hyphen :: DatetimeFormat Source #
A DatetimeFormat that separates the members of
the Date by hyphens.
>>>encode_YmdHMS SubsecondPrecisionAuto hyphen (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"2014-02-26 17:58:52"
\(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS hyphen (encode_YmdHMS s hyphen dt))
compact :: DatetimeFormat Source #
A DatetimeFormat with no separators, except for a
T between the Date and Time.
>>>encode_YmdHMS SubsecondPrecisionAuto compact (timeToDatetime (timeFromYmdhms 2014 2 26 17 58 52))"20140226T175852"
\(s :: SubsecondPrecision) (dt :: Datetime) -> isJust (decode_YmdHMS compact (encode_YmdHMS s compact dt))
Months
Days of Week
Utility
Return the number of days in a given month.
isLeapYear :: Year -> Bool Source #
observedOffsets :: Vector Offset Source #
All UTC time offsets. See List of UTC time offsets.
Textual Conversion
Date
Text
builder_HMS :: SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder Source #
Given a SubsecondPrecision and a separator, construct a
Text Builder corresponding to an Hour/Minute/Second
encoding.
parser_Ymd :: Maybe Char -> Parser Date Source #
Parse a Year/Month/Day-encoded Date that uses the
given separator.
parser_Mdy :: Maybe Char -> Parser Date Source #
Parse a Month/Day/Year-encoded Date that uses the
given separator.
parser_Dmy :: Maybe Char -> Parser Date Source #
Parse a Day/Month/Year-encoded Date that uses the
given separator.
UTF-8 ByteString
builderUtf8_Ymd :: Maybe Char -> Date -> Builder Source #
Given a Date and a separator, construct a ByteString Builder
corresponding to a Day/Month/Year encoding.
parserUtf8_Ymd :: Maybe Char -> Parser Date Source #
Parse a Year/Month/Day-encoded Date that uses the
given separator.
Time of Day
Text
builder_IMS_p :: MeridiemLocale Text -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision, and a separator,
construct a Text Builder according to an IMS encoding.
This differs from builder_IMSp in that their is a space
between the seconds and locale.
builder_IMSp :: MeridiemLocale Text -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision, and a separator,
construct a Text Builder according to an IMS encoding.
parser_HMS :: Maybe Char -> Parser TimeOfDay Source #
Parse an Hour/Minute/Second-encoded TimeOfDay that uses
the given separator.
parser_HMS_opt_S :: Maybe Char -> Parser TimeOfDay Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
UTF-8 ByteString
builderUtf8_HMS :: SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder Source #
Given a SubsecondPrecision and a separator, construct a ByteString Builder corresponding to an Hour/Month/Second encoding of the given TimeOfDay.
builderUtf8_IMS_p :: MeridiemLocale ByteString -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision, and a separator, construct a ByteString Builder corresponding to an IMS encoding of the given TimeOfDay. This differs from builderUtf8_IMSp in that
there is a space between the seconds and locale.
builderUtf8_IMSp :: MeridiemLocale ByteString -> SubsecondPrecision -> Maybe Char -> TimeOfDay -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision, and a separator, construct a ByteString Builder corresponding to an IMS encoding of the given TimeOfDay.
parserUtf8_HMS :: Maybe Char -> Parser TimeOfDay Source #
Parse an Hour/Minute/Second-encoded TimeOfDay that uses
the given separator.
parserUtf8_HMS_opt_S :: Maybe Char -> Parser TimeOfDay Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
zeptoUtf8_HMS :: Maybe Char -> Parser TimeOfDay Source #
Parse a TimeOfDay that was encoded using
the given separator.
Datetime
Text
builder_DmyHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a SubsecondPrecision and a DatetimeFormat, construct a
Text Builder corresponding to a
Day/Month/Year,Hour/Minute/Second encoding of the given Datetime.
builder_DmyIMSp :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision,
and a DatetimeFormat, construct a Text Builder
corresponding to a Day/Month/Year,IMS encoding of the given
Datetime.
builder_DmyIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision,
and a DatetimeFormat, construct a Text Builder
corresponding to a Day/Month/Year,IMS encoding of the given
Datetime. This differs from builder_DmyIMSp in that
it adds a space between the locale and seconds.
builder_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a SubsecondPrecision and a DatetimeFormat, construct
a Text Builder corresponding to a
Year/Month/Day,Hour/Minute/Second encoding of the given Datetime.
builder_YmdIMSp :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision, and a
DatetimeFormat, construct a Text Builder that
corresponds to a Year/Month/Day,IMS encoding of the
given Datetime.
builder_YmdIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a MeridiemLocale, a SubsecondPrecision, and a
DatetimeFormat, construct a Text Builder that
corresponds to a Year/Month/Day,IMS encoding of the
given Datetime. This inserts a space between the locale
and seconds.
builderW3C :: Datetime -> Builder Source #
encode_DmyHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Text Source #
Given a SubsecondPrecision and DatetimeFormat, construct
Text that corresponds to a Day/Month/Year,Hour/Minute/Second
encoding of the given Datetime.
encode_DmyIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Text Source #
Given a MeridiemLocale, a SubsecondPrecision, and a
DatetimeFormat, construct Text that corresponds to a
Day/Month/Year,IMS encoding of the given Datetime. This
inserts a space between the locale and seconds.
encode_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Text Source #
Given a SubsecondPrecision and DatetimeFormat, construct
Text that corresponds to a Year/Month/Day,Hour/Minute/Second
encoding of the given Datetime.
encode_YmdIMS_p :: MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Text Source #
Given a MeridiemLocale, a SubsecondPrecision, and a
DatetimeFormat, construct Text that corresponds to a
Year/Month/Day,IMS encoding of the given Datetime. This
inserts a space between the locale and seconds.
parser_DmyHMS :: DatetimeFormat -> Parser Datetime Source #
Parse a Day/Month/Year,Hour/Minute/Second-encoded Datetime
that was encoded with the given DatetimeFormat.
parser_YmdHMS :: DatetimeFormat -> Parser Datetime Source #
Parses a Year/Month/Day,Hour/Minute/Second-encoded Datetime
that was encoded using the given DatetimeFormat.
parser_YmdHMS_opt_S :: DatetimeFormat -> Parser Datetime Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
parser_DmyHMS_opt_S :: DatetimeFormat -> Parser Datetime Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
decode_DmyHMS :: DatetimeFormat -> Text -> Maybe Datetime Source #
Decode a Day/Month/Year,Hour/Minute/Second-encoded Datetime
from Text that was encoded with the given DatetimeFormat.
decode_YmdHMS :: DatetimeFormat -> Text -> Maybe Datetime Source #
Decode a Year/Month/Day,Hour/Minute/Second-encoded Datetime
from Text that was encoded with the given DatetimeFormat.
decode_YmdHMS_opt_S :: DatetimeFormat -> Text -> Maybe Datetime Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
decode_DmyHMS_opt_S :: DatetimeFormat -> Text -> Maybe Datetime Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
UTF-8 ByteString
encodeUtf8_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> ByteString Source #
Given a SubsecondPrecision and a DatetimeFormat, construct
a ByteString corresponding to a Year/Month/Day,Hour/Minute/Second
encoding of the given Datetime.
encodeUtf8_YmdIMS_p :: MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> Datetime -> ByteString Source #
Given a MeridiemLocale, a SubsecondPrecision, and a DatetimeFormat,
construct a ByteString corresponding to a Year/Month/Day,IMS encoding
of the given Datetime. This inserts a space between the locale and
seconds.
builderUtf8_YmdHMS :: SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a SubsecondPrecision and a DatetimeFormat, construct
a ByteString Builder corresponding to a
Year/Month/Day,Hour/Minute/Second encoding of the
given Datetime.
builderUtf8_YmdIMSp :: MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a SubsecondPrecision and a DatetimeFormat, construct
a ByteString Builder corresponding to a
Year/Month/Day,IMS encoding of the given Datetime.
builderUtf8_YmdIMS_p :: MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> Datetime -> Builder Source #
Given a SubsecondPrecision and a DatetimeFormat, construct
a ByteString Builder corresponding to a
Year/Month/Day,IMS encoding of the given Datetime. This inserts
a space between the locale and seconds.
builderUtf8W3C :: Datetime -> Builder Source #
Construct a ByteString Builder corresponding to
a W3C encoding of the given Datetime.
decodeUtf8_YmdHMS :: DatetimeFormat -> ByteString -> Maybe Datetime Source #
Decode a Year/Month/Day,Hour/Minute/Second-encoded Datetime from
a ByteString.
decodeUtf8_YmdHMS_opt_S :: DatetimeFormat -> ByteString -> Maybe Datetime Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
parserUtf8_YmdHMS :: DatetimeFormat -> Parser Datetime Source #
Parse a Year/Month/Day,Hour/Minute/Second-encoded Datetime that was
encoded using the given DatetimeFormat.
parserUtf8_YmdHMS_opt_S :: DatetimeFormat -> Parser Datetime Source #
Parses text that is formatted as either of the following:
%H:%M
%H:%M:%S
That is, the seconds and subseconds part is optional. If it is
not provided, it is assumed to be zero. This format shows up
in Google Chrome's datetime-local inputs.
zeptoUtf8_YmdHMS :: DatetimeFormat -> Parser Datetime Source #
Parse a Datetime that was encoded using the
given DatetimeFormat.
Offset Datetime
Text
encode_YmdHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Text Source #
Given an OffsetFormat, a SubsecondPrecision,
and a DatetimeFormat, construct Text corresponding to
the Year/Month/Day,Hour/Minute/Second-encoding of
the given OffsetDatetime.
encode_DmyHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Text Source #
Given an OffsetFormat, a SubsecondPrecision, and a
DatetimeFormat, construct Text corresponding to the
Day/Month/Year,Hour/Minute/Second encoding of the given
OffsetDatetime.
builder_YmdHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder Source #
Given an OffsetFormat, a SubsecondPrecision, and
a DatetimeFormat, construct a Text Builder
corresponding to a Year/Month/Day,Hour/Minute/Second encoding
of the given OffsetDatetime.
builder_DmyHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder Source #
Given an OffsetFormat, a SubsecondPrecision, and a
DatetimeFormat, construct a Text Builder corresponding
to the Day/Month/Year,Hour/Minute/Second-encoding of
the given OffsetDatetime.
parser_YmdHMSz :: OffsetFormat -> DatetimeFormat -> Parser OffsetDatetime Source #
Parse a Year/Month/Day,Hour/Minute/Second-encoded OffsetDatetime
that was encoded using the given OffsetFormat
and DatetimeFormat.
parser_DmyHMSz :: OffsetFormat -> DatetimeFormat -> Parser OffsetDatetime Source #
Parse a Day/Month/Year,Hour/Minute/Second-encoded OffsetDatetime
that was encoded using the given OffsetFormat
and DatetimeFormat.
builder_YmdIMS_p_z :: OffsetFormat -> MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder Source #
Given an OffsetFormat, a MeridiemLocale, a
SubsecondPrecision, and DatetimeFormat, construct a
Text Builder corresponding to a Year/Month/Day,IMS-encoding
of the given OffsetDatetime.
builder_DmyIMS_p_z :: OffsetFormat -> MeridiemLocale Text -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder Source #
Given an OffsetFormat, a MeridiemLocale, a
SubsecondPrecision, and a DatetimeFormat, construct a Text
Builder corresponding to the Day/Month/Year,IMS encoding
of the given OffsetDatetime.
builderW3Cz :: OffsetDatetime -> Builder Source #
Construct a Text Builder corresponding to the w3c-formatting
of the given OffsetDatetime.
UTF-8 ByteString
builderUtf8_YmdHMSz :: OffsetFormat -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder Source #
Given an OffsetFormat, a SubsecondPrecision, and a
DatetimeFormat, construct a ByteString Builder
corresponding to the Year/Month/Day,Hour/Minute/Second
encoding of the given OffsetDatetime.
parserUtf8_YmdHMSz :: OffsetFormat -> DatetimeFormat -> Parser OffsetDatetime Source #
Parse a Year/Month/Day,Hour/Minute/Second-encoded OffsetDatetime
that was encoded using the given OffsetFormat and
DatetimeFormat.
builderUtf8_YmdIMS_p_z :: OffsetFormat -> MeridiemLocale ByteString -> SubsecondPrecision -> DatetimeFormat -> OffsetDatetime -> Builder Source #
Given an OffsetFormat, a 'MeridiemLocale, a SubsecondPrecision,
and a DatetimeFormat, construct a ByteString Builder
corresponding to a Year/Month/Day,IMS-encoded OffsetDatetime.
builderUtf8W3Cz :: OffsetDatetime -> Builder Source #
Construct a ByteString Builder corresponding to the W3C
encoding of the given Datetime.
Offset
Text
encodeOffset :: OffsetFormat -> Offset -> Text Source #
Encode an Offset to Text using the given OffsetFormat.
builderOffset :: OffsetFormat -> Offset -> Builder Source #
Construct a Builder corresponding to the given Offset
encoded using the given OffsetFormat.
decodeOffset :: OffsetFormat -> Text -> Maybe Offset Source #
Decode an Offset from Text that was encoded
using the given OffsetFormat.
parserOffset :: OffsetFormat -> Parser Offset Source #
Parse an Offset that was encoded using the given OffsetFormat.
UTF-8 ByteString
encodeOffsetUtf8 :: OffsetFormat -> Offset -> ByteString Source #
Encode an Offset as a ByteString using the given OffsetFormat.
builderOffsetUtf8 :: OffsetFormat -> Offset -> Builder Source #
Construct a ByteString Builder corresponding to the
encoding of an Offset using the given OffsetFormat.
decodeOffsetUtf8 :: OffsetFormat -> ByteString -> Maybe Offset Source #
Decode an Offset from a ByteString that was encoded using the given
OffsetFormat.
parserOffsetUtf8 :: OffsetFormat -> Parser Offset Source #
Parse an Offset that was encoded using the given
OffsetFormat.
Timespan
Text
encodeTimespan :: SubsecondPrecision -> Timespan -> Text Source #
Encode a Timespan as Text using the given SubsecondPrecision.
builderTimespan :: SubsecondPrecision -> Timespan -> Builder Source #
Construct a Text Builder corresponding to an encoding
of the given Timespan using the given SubsecondPrecision.
UTF-8 ByteString
encodeTimespanUtf8 :: SubsecondPrecision -> Timespan -> ByteString Source #
Given a SubsecondPrecision, construct a ByteString corresponding
to an encoding of the given Timespan.
builderTimespanUtf8 :: SubsecondPrecision -> Timespan -> Builder Source #
Given a SubsecondPrecision, construct a ByteString Builder
corresponding to an encoding of the given Timespan.
TimeInterval
within :: Time -> TimeInterval -> Bool Source #
Is the given Time within the TimeInterval?
timeIntervalToTimespan :: TimeInterval -> Timespan Source #
Convert a TimeInterval to a Timespan. This is equivalent to width.
whole :: TimeInterval Source #
The TimeInterval that covers the entire range of Times that Chronos supports.
\(t :: Time) -> within t whole
singleton :: Time -> TimeInterval Source #
The singleton (degenerate) TimeInterval.
lowerBound :: TimeInterval -> Time Source #
Get the lower bound of the TimeInterval.
upperBound :: TimeInterval -> Time Source #
Get the upper bound of the TimeInterval.
width :: TimeInterval -> Timespan Source #
The width of the TimeInterval. This is equivalent to timeIntervalToTimespan.
timeIntervalBuilder :: Time -> Time -> TimeInterval Source #
A smart constructor for TimeInterval. In general, you should prefer using this
over the TimeInterval constructor, since it maintains the invariant that
lowerBound interval <= upperBound interval
(...) :: Time -> Time -> TimeInterval infix 3 Source #
An infix timeIntervalBuilder.
Types
A day represented as the modified Julian date, the number of days since midnight on November 17, 1858.
Instances
| Enum Day Source # | |
| Eq Day Source # | |
| Ord Day Source # | |
| Read Day Source # | |
| Show Day Source # | |
| Hashable Day Source # | |
| ToJSON Day Source # | |
| FromJSON Day Source # | |
| Storable Day Source # | |
Defined in Chronos | |
| Prim Day Source # | |
Defined in Chronos Methods alignment# :: Day -> Int# # indexByteArray# :: ByteArray# -> Int# -> Day # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, Day#) # writeByteArray# :: MutableByteArray# s -> Int# -> Day -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> Day -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> Day # readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, Day#) # writeOffAddr# :: Addr# -> Int# -> Day -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> Day -> State# s -> State# s # | |
| Torsor Day Int Source # | |
The day of the week.
Constructors
| DayOfWeek | |
Fields
| |
Instances
| Eq DayOfWeek Source # | |
| Ord DayOfWeek Source # | |
| Read DayOfWeek Source # | |
| Show DayOfWeek Source # | |
| Hashable DayOfWeek Source # | |
newtype DayOfMonth Source #
The day of the month.
Constructors
| DayOfMonth | |
Fields
| |
Instances
The day of the year.
Constructors
| DayOfYear | |
Fields
| |
Instances
| Eq DayOfYear Source # | |
| Ord DayOfYear Source # | |
| Read DayOfYear Source # | |
| Show DayOfYear Source # | |
| Prim DayOfYear Source # | |
Defined in Chronos Methods sizeOf# :: DayOfYear -> Int# # alignment# :: DayOfYear -> Int# # indexByteArray# :: ByteArray# -> Int# -> DayOfYear # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, DayOfYear#) # writeByteArray# :: MutableByteArray# s -> Int# -> DayOfYear -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> DayOfYear -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> DayOfYear # readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, DayOfYear#) # writeOffAddr# :: Addr# -> Int# -> DayOfYear -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> DayOfYear -> State# s -> State# s # | |
The month of the year.
Instances
The number of years elapsed since the beginning of the Common Era.
A UTC offset.
POSIX time with nanosecond resolution.
Instances
| Bounded Time Source # | |
| Eq Time Source # | |
| Ord Time Source # | |
| Read Time Source # | |
| Show Time Source # | |
| Hashable Time Source # | |
| ToJSON Time Source # | |
| FromJSON Time Source # | |
| Storable Time Source # | |
Defined in Chronos | |
| Prim Time Source # | |
Defined in Chronos Methods alignment# :: Time -> Int# # indexByteArray# :: ByteArray# -> Int# -> Time # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, Time#) # writeByteArray# :: MutableByteArray# s -> Int# -> Time -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> Time -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> Time # readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, Time#) # writeOffAddr# :: Addr# -> Int# -> Time -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> Time -> State# s -> State# s # | |
| Torsor Time Timespan Source # | |
newtype DayOfWeekMatch a Source #
Match a DayOfWeek. By match, we mean that a DayOfWeekMatch
is a mapping from the integer value of a DayOfWeek to some value
of type a. You should construct a DayOfWeekMatch with
buildDayOfWeekMatch, and match it using caseDayOfWeek.
Constructors
| DayOfWeekMatch | |
Fields
| |
newtype MonthMatch a Source #
Match a Month. By match, we mean that a MonthMatch is
a mapping from the integer value of a Month to some value of
type a. You should construct a MonthMatch with
buildMonthMatch, and match it using caseMonth.
Constructors
| MonthMatch | |
Fields
| |
newtype UnboxedMonthMatch a Source #
Like MonthMatch, but the matched value can have an instance of
Unbox.
Constructors
| UnboxedMonthMatch | |
Fields | |
A timespan. This is represented internally as a number of nanoseconds.
Constructors
| Timespan | |
Fields
| |
Instances
data SubsecondPrecision Source #
The precision used when encoding seconds to a human-readable format.
Constructors
| SubsecondPrecisionAuto | Rounds to second, millisecond, microsecond, or nanosecond |
| SubsecondPrecisionFixed !Int | Specify number of places after decimal |
Instances
A date as represented by the Gregorian calendar.
data OrdinalDate Source #
An OrdinalDate is a Year and the number of days elapsed
since the Year began.
Constructors
| OrdinalDate | |
Fields | |
Instances
A month and the day of the month. This does not actually represent a specific date, since this recurs every year.
Constructors
| MonthDate | |
Fields
| |
Instances
| Eq MonthDate Source # | |
| Ord MonthDate Source # | |
| Read MonthDate Source # | |
| Show MonthDate Source # | |
Constructors
| Datetime | |
Fields
| |
data OffsetDatetime Source #
Constructors
| OffsetDatetime | |
Fields | |
Instances
| Eq OffsetDatetime Source # | |
Defined in Chronos Methods (==) :: OffsetDatetime -> OffsetDatetime -> Bool # (/=) :: OffsetDatetime -> OffsetDatetime -> Bool # | |
| Ord OffsetDatetime Source # | |
Defined in Chronos Methods compare :: OffsetDatetime -> OffsetDatetime -> Ordering # (<) :: OffsetDatetime -> OffsetDatetime -> Bool # (<=) :: OffsetDatetime -> OffsetDatetime -> Bool # (>) :: OffsetDatetime -> OffsetDatetime -> Bool # (>=) :: OffsetDatetime -> OffsetDatetime -> Bool # max :: OffsetDatetime -> OffsetDatetime -> OffsetDatetime # min :: OffsetDatetime -> OffsetDatetime -> OffsetDatetime # | |
| Read OffsetDatetime Source # | |
Defined in Chronos Methods readsPrec :: Int -> ReadS OffsetDatetime # readList :: ReadS [OffsetDatetime] # | |
| Show OffsetDatetime Source # | |
Defined in Chronos Methods showsPrec :: Int -> OffsetDatetime -> ShowS # show :: OffsetDatetime -> String # showList :: [OffsetDatetime] -> ShowS # | |
A time of day with nanosecond resolution.
Constructors
| TimeOfDay | |
Fields
| |
Instances
| Eq TimeOfDay Source # | |
| Ord TimeOfDay Source # | |
| Read TimeOfDay Source # | |
| Show TimeOfDay Source # | |
data DatetimeFormat Source #
The format of a Datetime. In particular
this provides separators for parts of the Datetime
and nothing else.
Constructors
| DatetimeFormat | |
Fields
| |
Instances
| Eq DatetimeFormat Source # | |
Defined in Chronos Methods (==) :: DatetimeFormat -> DatetimeFormat -> Bool # (/=) :: DatetimeFormat -> DatetimeFormat -> Bool # | |
| Ord DatetimeFormat Source # | |
Defined in Chronos Methods compare :: DatetimeFormat -> DatetimeFormat -> Ordering # (<) :: DatetimeFormat -> DatetimeFormat -> Bool # (<=) :: DatetimeFormat -> DatetimeFormat -> Bool # (>) :: DatetimeFormat -> DatetimeFormat -> Bool # (>=) :: DatetimeFormat -> DatetimeFormat -> Bool # max :: DatetimeFormat -> DatetimeFormat -> DatetimeFormat # min :: DatetimeFormat -> DatetimeFormat -> DatetimeFormat # | |
| Read DatetimeFormat Source # | |
Defined in Chronos Methods readsPrec :: Int -> ReadS DatetimeFormat # readList :: ReadS [DatetimeFormat] # | |
| Show DatetimeFormat Source # | |
Defined in Chronos Methods showsPrec :: Int -> DatetimeFormat -> ShowS # show :: DatetimeFormat -> String # showList :: [DatetimeFormat] -> ShowS # | |
data OffsetFormat Source #
Formatting settings for a timezone offset.
Constructors
| OffsetFormatColonOff |
|
| OffsetFormatColonOn |
|
| OffsetFormatSecondsPrecision |
|
| OffsetFormatColonAuto |
|
Instances
data DatetimeLocale a Source #
Locale-specific formatting for weekdays and months. The
type variable will likely be instantiated to Text
or ByteString.
Constructors
| DatetimeLocale | |
Fields
| |
data MeridiemLocale a Source #
Locale-specific formatting for AM and PM.
Constructors
| MeridiemLocale | |
Fields
| |
Instances
data TimeInterval Source #
A TimeInterval represents a start and end time.
It can sometimes be more ergonomic than the Torsor API when
you only care about whether or not a Time is within a certain range.
To construct a TimeInterval, it is best to use timeIntervalBuilder,
which maintains the invariant that lowerBound interval <= upperBound intervalTimeIntervals assume this invariant).
Constructors
| TimeInterval !Time !Time |
Instances
| Bounded TimeInterval Source # | |
Defined in Chronos | |
| Eq TimeInterval Source # | |
Defined in Chronos | |
| Ord TimeInterval Source # | |
Defined in Chronos Methods compare :: TimeInterval -> TimeInterval -> Ordering # (<) :: TimeInterval -> TimeInterval -> Bool # (<=) :: TimeInterval -> TimeInterval -> Bool # (>) :: TimeInterval -> TimeInterval -> Bool # (>=) :: TimeInterval -> TimeInterval -> Bool # max :: TimeInterval -> TimeInterval -> TimeInterval # min :: TimeInterval -> TimeInterval -> TimeInterval # | |
| Read TimeInterval Source # | |
Defined in Chronos Methods readsPrec :: Int -> ReadS TimeInterval # readList :: ReadS [TimeInterval] # | |
| Show TimeInterval Source # | |
Defined in Chronos Methods showsPrec :: Int -> TimeInterval -> ShowS # show :: TimeInterval -> String # showList :: [TimeInterval] -> ShowS # | |