-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Month, YearMonth, Quarter, YearQuarter types
--   
--   Month and Quarter enumerations and some basic function and instances.
@package months
@version 0.1


-- | <a>Month</a> data type.
module Data.Time.Month

-- | We explicitly enumerate month names. Using an <a>Int</a> is unsafe.
data Month
January :: Month
February :: Month
March :: Month
April :: Month
May :: Month
June :: Month
July :: Month
August :: Month
September :: Month
October :: Month
November :: Month
December :: Month

-- | A month in Julian/Gregorian calendar.
data YearMonth
YearMonth :: !Integer -> !Month -> YearMonth
[monthYear] :: YearMonth -> !Integer
[monthName] :: YearMonth -> !Month

-- | Extract <a>Month</a> from <a>Day</a>
--   
--   <pre>
--   &gt;&gt;&gt; dayToYearMonth (read "2017-02-03")
--   YearMonth 2017 February
--   </pre>
dayToYearMonth :: Day -> YearMonth

-- | First day of the month.
--   
--   <pre>
--   &gt;&gt;&gt; firstDayOfYearMonth $ YearMonth 2017 February
--   2017-02-01
--   </pre>
firstDayOfYearMonth :: YearMonth -> Day

-- | Last day of the month
--   
--   <pre>
--   &gt;&gt;&gt; lastDayOfYearMonth $ YearMonth 2017 February
--   2017-02-28
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; lastDayOfYearMonth $ YearMonth 2016 February
--   2016-02-29
--   </pre>
lastDayOfYearMonth :: YearMonth -> Day

-- | Day interval of month
--   
--   <pre>
--   &gt;&gt;&gt; yearMonthInterval $ YearMonth 2017 February
--   2017-02-01 ... 2017-02-28
--   </pre>
yearMonthInterval :: YearMonth -> Interval Day
yearMonthToText :: YearMonth -> Text
parseYearMonth :: Text -> Either String YearMonth
instance GHC.Generics.Generic Data.Time.Month.YearMonth
instance GHC.Classes.Ord Data.Time.Month.YearMonth
instance GHC.Classes.Eq Data.Time.Month.YearMonth
instance GHC.Enum.Bounded Data.Time.Month.Month
instance GHC.Generics.Generic Data.Time.Month.Month
instance GHC.Read.Read Data.Time.Month.Month
instance GHC.Show.Show Data.Time.Month.Month
instance GHC.Classes.Ord Data.Time.Month.Month
instance GHC.Classes.Eq Data.Time.Month.Month
instance GHC.Show.Show Data.Time.Month.YearMonth
instance Data.Hashable.Class.Hashable Data.Time.Month.YearMonth
instance Control.DeepSeq.NFData Data.Time.Month.YearMonth
instance GHC.Enum.Enum Data.Time.Month.YearMonth
instance Data.Csv.Conversion.ToField Data.Time.Month.YearMonth
instance Data.Csv.Conversion.FromField Data.Time.Month.YearMonth
instance Data.Aeson.Types.ToJSON.ToJSON Data.Time.Month.YearMonth
instance Data.Aeson.Types.FromJSON.FromJSON Data.Time.Month.YearMonth
instance Data.Aeson.Types.ToJSON.ToJSONKey Data.Time.Month.YearMonth
instance Data.Aeson.Types.FromJSON.FromJSONKey Data.Time.Month.YearMonth
instance Data.Swagger.Internal.Schema.ToSchema Data.Time.Month.YearMonth
instance Data.Swagger.Internal.ParamSchema.ToParamSchema Data.Time.Month.YearMonth
instance Web.Internal.HttpApiData.ToHttpApiData Data.Time.Month.YearMonth
instance Web.Internal.HttpApiData.FromHttpApiData Data.Time.Month.YearMonth
instance Lucid.Base.ToHtml Data.Time.Month.YearMonth
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Time.Month.YearMonth
instance Data.Hashable.Class.Hashable Data.Time.Month.Month
instance Control.DeepSeq.NFData Data.Time.Month.Month
instance GHC.Enum.Enum Data.Time.Month.Month
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Time.Month.Month


-- | <a>Quarter</a> data type.
module Data.Time.Quarter

-- | We explicitly enumerate quarter names. Using an <a>Int</a> is unsafe.
data Quarter
Q1 :: Quarter
Q2 :: Quarter
Q3 :: Quarter
Q4 :: Quarter

-- | A quarter in Julian/Gregorian calendar.
data YearQuarter
YearQuarter :: !Integer -> !Quarter -> YearQuarter
[quarterYear] :: YearQuarter -> !Integer
[quarterName] :: YearQuarter -> !Quarter

-- | Extract <a>Quarter</a> from <a>Day</a>
--   
--   <pre>
--   &gt;&gt;&gt; dayToYearQuarter (read "2017-02-03")
--   YearQuarter 2017 Q1
--   </pre>
dayToYearQuarter :: Day -> YearQuarter

-- | First day of the quarter.
--   
--   <pre>
--   &gt;&gt;&gt; firstDayOfYearQuarter $ YearQuarter 2017 Q3
--   2017-07-01
--   </pre>
firstDayOfYearQuarter :: YearQuarter -> Day

-- | Last day of the quarter
--   
--   <pre>
--   &gt;&gt;&gt; lastDayOfYearQuarter $ YearQuarter 2017 Q1
--   2017-03-31
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; lastDayOfYearQuarter $ YearQuarter 2016 Q2
--   2016-06-30
--   </pre>
lastDayOfYearQuarter :: YearQuarter -> Day

-- | Day interval of month
--   
--   <pre>
--   &gt;&gt;&gt; yearQuarterInterval $ YearQuarter 2017 Q2
--   2017-04-01 ... 2017-06-30
--   </pre>
yearQuarterInterval :: YearQuarter -> Interval Day
yearQuarterToText :: YearQuarter -> Text
parseYearQuarter :: Text -> Either String YearQuarter
instance GHC.Generics.Generic Data.Time.Quarter.YearQuarter
instance GHC.Classes.Ord Data.Time.Quarter.YearQuarter
instance GHC.Classes.Eq Data.Time.Quarter.YearQuarter
instance GHC.Enum.Bounded Data.Time.Quarter.Quarter
instance GHC.Generics.Generic Data.Time.Quarter.Quarter
instance GHC.Read.Read Data.Time.Quarter.Quarter
instance GHC.Show.Show Data.Time.Quarter.Quarter
instance GHC.Classes.Ord Data.Time.Quarter.Quarter
instance GHC.Classes.Eq Data.Time.Quarter.Quarter
instance GHC.Show.Show Data.Time.Quarter.YearQuarter
instance Data.Hashable.Class.Hashable Data.Time.Quarter.YearQuarter
instance Control.DeepSeq.NFData Data.Time.Quarter.YearQuarter
instance GHC.Enum.Enum Data.Time.Quarter.YearQuarter
instance Data.Csv.Conversion.ToField Data.Time.Quarter.YearQuarter
instance Data.Csv.Conversion.FromField Data.Time.Quarter.YearQuarter
instance Data.Aeson.Types.ToJSON.ToJSON Data.Time.Quarter.YearQuarter
instance Data.Aeson.Types.FromJSON.FromJSON Data.Time.Quarter.YearQuarter
instance Data.Aeson.Types.ToJSON.ToJSONKey Data.Time.Quarter.YearQuarter
instance Data.Aeson.Types.FromJSON.FromJSONKey Data.Time.Quarter.YearQuarter
instance Data.Swagger.Internal.Schema.ToSchema Data.Time.Quarter.YearQuarter
instance Data.Swagger.Internal.ParamSchema.ToParamSchema Data.Time.Quarter.YearQuarter
instance Web.Internal.HttpApiData.ToHttpApiData Data.Time.Quarter.YearQuarter
instance Web.Internal.HttpApiData.FromHttpApiData Data.Time.Quarter.YearQuarter
instance Lucid.Base.ToHtml Data.Time.Quarter.YearQuarter
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Time.Quarter.YearQuarter
instance Data.Hashable.Class.Hashable Data.Time.Quarter.Quarter
instance Control.DeepSeq.NFData Data.Time.Quarter.Quarter
instance GHC.Enum.Enum Data.Time.Quarter.Quarter
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Time.Quarter.Quarter