Safe Haskell	Trustworthy
Language	Haskell2010

Data.Time.Month

Contents

Types
Conversion with Day
Conversions with Text

Description

Month data type.

Synopsis

data Month
- = January
- | February
- | March
- | April
- | May
- | June
- | July
- | August
- | September
- | October
- | November
- | December
data YearMonth = YearMonth {
- monthYear :: !Integer
- monthName :: !Month
}
dayToYearMonth :: Day -> YearMonth
firstDayOfYearMonth :: YearMonth -> Day
lastDayOfYearMonth :: YearMonth -> Day
yearMonthInterval :: YearMonth -> Interval Day
yearMonthToText :: YearMonth -> Text
parseYearMonth :: Text -> Either String YearMonth

Types

data Month Source #

We explicitly enumerate month names. Using an Int is unsafe.

Constructors

January
February
March
April
May
June
July
August
September
October
November
December

Instances

Bounded Month Source #
Instance details Defined in Data.Time.Month Methods minBound :: Month # maxBound :: Month #
Enum Month Source #
Instance details Defined in Data.Time.Month Methods succ :: Month -> Month # pred :: Month -> Month # toEnum :: Int -> Month # fromEnum :: Month -> Int # enumFrom :: Month -> [Month] # enumFromThen :: Month -> Month -> [Month] # enumFromTo :: Month -> Month -> [Month] # enumFromThenTo :: Month -> Month -> Month -> [Month] #
Eq Month Source #
Instance details Defined in Data.Time.Month Methods (==) :: Month -> Month -> Bool # (/=) :: Month -> Month -> Bool #
Ord Month Source #
Instance details Defined in Data.Time.Month Methods compare :: Month -> Month -> Ordering # (<) :: Month -> Month -> Bool # (<=) :: Month -> Month -> Bool # (>) :: Month -> Month -> Bool # (>=) :: Month -> Month -> Bool # max :: Month -> Month -> Month # min :: Month -> Month -> Month #
Read Month Source #
Instance details Defined in Data.Time.Month Methods readsPrec :: Int -> ReadS Month # readList :: ReadS [Month] # readPrec :: ReadPrec Month # readListPrec :: ReadPrec [Month] #
Show Month Source #
Instance details Defined in Data.Time.Month Methods showsPrec :: Int -> Month -> ShowS # show :: Month -> String # showList :: [Month] -> ShowS #
Generic Month Source #
Instance details Defined in Data.Time.Month Associated Types type Rep Month :: Type -> Type # Methods from :: Month -> Rep Month x # to :: Rep Month x -> Month #
Arbitrary Month Source #
Instance details Defined in Data.Time.Month Methods arbitrary :: Gen Month # shrink :: Month -> [Month] #
Hashable Month Source #
Instance details Defined in Data.Time.Month Methods hashWithSalt :: Int -> Month -> Int # hash :: Month -> Int #
NFData Month Source #
Instance details Defined in Data.Time.Month Methods rnf :: Month -> () #
type Rep Month Source #
Instance details Defined in Data.Time.Month type Rep Month = D1 (MetaData "Month" "Data.Time.Month" "months-0.1-8UF2elrWYufCYn2Iw3nBtN" False) (((C1 (MetaCons "January" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "February" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "March" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "April" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "May" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "June" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "July" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "August" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "September" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "October" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "November" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "December" PrefixI False) (U1 :: Type -> Type)))))

data YearMonth Source #

A month in Julian/Gregorian calendar.

Constructors

YearMonth
Fields monthYear :: !Integer monthName :: !Month

Instances

Enum YearMonth Source #
Instance details Defined in Data.Time.Month Methods succ :: YearMonth -> YearMonth # pred :: YearMonth -> YearMonth # toEnum :: Int -> YearMonth # fromEnum :: YearMonth -> Int # enumFrom :: YearMonth -> [YearMonth] # enumFromThen :: YearMonth -> YearMonth -> [YearMonth] # enumFromTo :: YearMonth -> YearMonth -> [YearMonth] # enumFromThenTo :: YearMonth -> YearMonth -> YearMonth -> [YearMonth] #
Eq YearMonth Source #
Instance details Defined in Data.Time.Month Methods (==) :: YearMonth -> YearMonth -> Bool # (/=) :: YearMonth -> YearMonth -> Bool #
Ord YearMonth Source #
Instance details Defined in Data.Time.Month Methods compare :: YearMonth -> YearMonth -> Ordering # (<) :: YearMonth -> YearMonth -> Bool # (<=) :: YearMonth -> YearMonth -> Bool # (>) :: YearMonth -> YearMonth -> Bool # (>=) :: YearMonth -> YearMonth -> Bool # max :: YearMonth -> YearMonth -> YearMonth # min :: YearMonth -> YearMonth -> YearMonth #
Show YearMonth Source #	Doesn't print field names.
Instance details Defined in Data.Time.Month Methods showsPrec :: Int -> YearMonth -> ShowS # show :: YearMonth -> String # showList :: [YearMonth] -> ShowS #
Generic YearMonth Source #
Instance details Defined in Data.Time.Month Associated Types type Rep YearMonth :: Type -> Type # Methods from :: YearMonth -> Rep YearMonth x # to :: Rep YearMonth x -> YearMonth #
Arbitrary YearMonth Source #
Instance details Defined in Data.Time.Month Methods arbitrary :: Gen YearMonth # shrink :: YearMonth -> [YearMonth] #
Hashable YearMonth Source #
Instance details Defined in Data.Time.Month Methods hashWithSalt :: Int -> YearMonth -> Int # hash :: YearMonth -> Int #
ToJSON YearMonth Source #	TODO: use builder if we really want speed
Instance details Defined in Data.Time.Month Methods toJSON :: YearMonth -> Value # toEncoding :: YearMonth -> Encoding # toJSONList :: [YearMonth] -> Value # toEncodingList :: [YearMonth] -> Encoding #
ToJSONKey YearMonth Source #
Instance details Defined in Data.Time.Month Methods toJSONKey :: ToJSONKeyFunction YearMonth # toJSONKeyList :: ToJSONKeyFunction [YearMonth] #
FromJSON YearMonth Source #
Instance details Defined in Data.Time.Month Methods parseJSON :: Value -> Parser YearMonth # parseJSONList :: Value -> Parser [YearMonth] #
FromJSONKey YearMonth Source #
Instance details Defined in Data.Time.Month Methods fromJSONKey :: FromJSONKeyFunction YearMonth # fromJSONKeyList :: FromJSONKeyFunction [YearMonth] #
FromField YearMonth Source #
Instance details Defined in Data.Time.Month Methods parseField :: Field -> Parser YearMonth #
ToField YearMonth Source #
Instance details Defined in Data.Time.Month Methods toField :: YearMonth -> Field #
NFData YearMonth Source #
Instance details Defined in Data.Time.Month Methods rnf :: YearMonth -> () #
ToHttpApiData YearMonth Source #
Instance details Defined in Data.Time.Month Methods toUrlPiece :: YearMonth -> Text # toEncodedUrlPiece :: YearMonth -> Builder # toHeader :: YearMonth -> ByteString # toQueryParam :: YearMonth -> Text #
FromHttpApiData YearMonth Source #
Instance details Defined in Data.Time.Month Methods parseUrlPiece :: Text -> Either Text YearMonth # parseHeader :: ByteString -> Either Text YearMonth # parseQueryParam :: Text -> Either Text YearMonth #
ToHtml YearMonth Source #
Instance details Defined in Data.Time.Month Methods toHtml :: Monad m => YearMonth -> HtmlT m () # toHtmlRaw :: Monad m => YearMonth -> HtmlT m () #
ToSchema YearMonth Source #
Instance details Defined in Data.Time.Month Methods declareNamedSchema :: Proxy YearMonth -> Declare (Definitions Schema) NamedSchema #
ToParamSchema YearMonth Source #	Format `"month"` corresponds to `yyyy-mm` format.
Instance details Defined in Data.Time.Month Methods toParamSchema :: Proxy YearMonth -> ParamSchema t #
type Rep YearMonth Source #
Instance details Defined in Data.Time.Month type Rep YearMonth = D1 (MetaData "YearMonth" "Data.Time.Month" "months-0.1-8UF2elrWYufCYn2Iw3nBtN" False) (C1 (MetaCons "YearMonth" PrefixI True) (S1 (MetaSel (Just "monthYear") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer) :*: S1 (MetaSel (Just "monthName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Month)))

Conversion with Day

dayToYearMonth :: Day -> YearMonth Source #

Extract Month from Day

>>> dayToYearMonth (read "2017-02-03")
YearMonth 2017 February

firstDayOfYearMonth :: YearMonth -> Day Source #

First day of the month.

>>> firstDayOfYearMonth $ YearMonth 2017 February
2017-02-01

lastDayOfYearMonth :: YearMonth -> Day Source #

Last day of the month

>>> lastDayOfYearMonth $ YearMonth 2017 February
2017-02-28

>>> lastDayOfYearMonth $ YearMonth 2016 February
2016-02-29

yearMonthInterval :: YearMonth -> Interval Day Source #

Day interval of month

>>> yearMonthInterval $ YearMonth 2017 February
2017-02-01 ... 2017-02-28

Conversions with Text

yearMonthToText :: YearMonth -> Text Source #

parseYearMonth :: Text -> Either String YearMonth Source #