Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Thyme.Calendar.WeekdayOfMonth

Description

Calendar date reckoned by year, month-of-year, and n-th day-of-week.

Synopsis

type Year = Int
type Month = Int
type DayOfWeek = Int
pattern MV_WeekdayOfMonth :: (MVector s Int) -> MVector s WeekdayOfMonth
pattern V_WeekdayOfMonth :: (Vector Int) -> Vector WeekdayOfMonth
data WeekdayOfMonth = WeekdayOfMonth {
- womYear :: !Year
- womMonth :: !Month
- womNth :: !Int
- womDayOfWeek :: !DayOfWeek
}
_womYear :: Lens' WeekdayOfMonth Year
_womMonth :: Lens' WeekdayOfMonth Month
_womNth :: Lens' WeekdayOfMonth Int
_womDayOfWeek :: Lens' WeekdayOfMonth DayOfWeek
weekdayOfMonth :: Iso' Day WeekdayOfMonth
weekdayOfMonthValid :: WeekdayOfMonth -> Maybe Day

Documentation

type Year = Int Source #

Calendar year.

type Month = Int Source #

Calendar month. January = 1

type DayOfWeek = Int Source #

Day of the week.

0: Sunday for SundayWeek
1…6: Monday…Saturday
7: Sunday for WeekDate, MondayWeek, and WeekdayOfMonth

pattern MV_WeekdayOfMonth :: (MVector s Int) -> MVector s WeekdayOfMonth Source #

pattern V_WeekdayOfMonth :: (Vector Int) -> Vector WeekdayOfMonth Source #

data WeekdayOfMonth Source #

Calendar date with year, month-of-year, and n-th day-of-week.

Constructors

WeekdayOfMonth
Fields womYear :: !Year Calendar year. womMonth :: !Month Month of year. womNth :: !Int N-th `DayOfWeek`. Range ±1–5; negative means the N-th last `DayOfWeek` of the month. womDayOfWeek :: !DayOfWeek Day of week. 1 = Monday, 7 = Sunday, like ISO 8601 `WeekDate`.

Instances

Instances details

Arbitrary WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods arbitrary :: Gen WeekdayOfMonth # shrink :: WeekdayOfMonth -> [WeekdayOfMonth] #
CoArbitrary WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods coarbitrary :: WeekdayOfMonth -> Gen b -> Gen b #
Data WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WeekdayOfMonth -> c WeekdayOfMonth # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WeekdayOfMonth # toConstr :: WeekdayOfMonth -> Constr # dataTypeOf :: WeekdayOfMonth -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c WeekdayOfMonth) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WeekdayOfMonth) # gmapT :: (forall b. Data b => b -> b) -> WeekdayOfMonth -> WeekdayOfMonth # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WeekdayOfMonth -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WeekdayOfMonth -> r # gmapQ :: (forall d. Data d => d -> u) -> WeekdayOfMonth -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> WeekdayOfMonth -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> WeekdayOfMonth -> m WeekdayOfMonth # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WeekdayOfMonth -> m WeekdayOfMonth # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WeekdayOfMonth -> m WeekdayOfMonth #
Bounded WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods minBound :: WeekdayOfMonth # maxBound :: WeekdayOfMonth #
Generic WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Associated Types type Rep WeekdayOfMonth :: Type -> Type # Methods from :: WeekdayOfMonth -> Rep WeekdayOfMonth x # to :: Rep WeekdayOfMonth x -> WeekdayOfMonth #
Show WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods showsPrec :: Int -> WeekdayOfMonth -> ShowS # show :: WeekdayOfMonth -> String # showList :: [WeekdayOfMonth] -> ShowS #
NFData WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods rnf :: WeekdayOfMonth -> () #
Eq WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods (==) :: WeekdayOfMonth -> WeekdayOfMonth -> Bool # (/=) :: WeekdayOfMonth -> WeekdayOfMonth -> Bool #
Ord WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods compare :: WeekdayOfMonth -> WeekdayOfMonth -> Ordering # (<) :: WeekdayOfMonth -> WeekdayOfMonth -> Bool # (<=) :: WeekdayOfMonth -> WeekdayOfMonth -> Bool # (>) :: WeekdayOfMonth -> WeekdayOfMonth -> Bool # (>=) :: WeekdayOfMonth -> WeekdayOfMonth -> Bool # max :: WeekdayOfMonth -> WeekdayOfMonth -> WeekdayOfMonth # min :: WeekdayOfMonth -> WeekdayOfMonth -> WeekdayOfMonth #
Hashable WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods hashWithSalt :: Int -> WeekdayOfMonth -> Int # hash :: WeekdayOfMonth -> Int #
Random WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods randomR :: RandomGen g => (WeekdayOfMonth, WeekdayOfMonth) -> g -> (WeekdayOfMonth, g) # random :: RandomGen g => g -> (WeekdayOfMonth, g) # randomRs :: RandomGen g => (WeekdayOfMonth, WeekdayOfMonth) -> g -> [WeekdayOfMonth] # randoms :: RandomGen g => g -> [WeekdayOfMonth] #
Unbox WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth
Vector Vector WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods basicUnsafeFreeze :: Mutable Vector s WeekdayOfMonth -> ST s (Vector WeekdayOfMonth) # basicUnsafeThaw :: Vector WeekdayOfMonth -> ST s (Mutable Vector s WeekdayOfMonth) # basicLength :: Vector WeekdayOfMonth -> Int # basicUnsafeSlice :: Int -> Int -> Vector WeekdayOfMonth -> Vector WeekdayOfMonth # basicUnsafeIndexM :: Vector WeekdayOfMonth -> Int -> Box WeekdayOfMonth # basicUnsafeCopy :: Mutable Vector s WeekdayOfMonth -> Vector WeekdayOfMonth -> ST s () # elemseq :: Vector WeekdayOfMonth -> WeekdayOfMonth -> b -> b #
MVector MVector WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth Methods basicLength :: MVector s WeekdayOfMonth -> Int # basicUnsafeSlice :: Int -> Int -> MVector s WeekdayOfMonth -> MVector s WeekdayOfMonth # basicOverlaps :: MVector s WeekdayOfMonth -> MVector s WeekdayOfMonth -> Bool # basicUnsafeNew :: Int -> ST s (MVector s WeekdayOfMonth) # basicInitialize :: MVector s WeekdayOfMonth -> ST s () # basicUnsafeReplicate :: Int -> WeekdayOfMonth -> ST s (MVector s WeekdayOfMonth) # basicUnsafeRead :: MVector s WeekdayOfMonth -> Int -> ST s WeekdayOfMonth # basicUnsafeWrite :: MVector s WeekdayOfMonth -> Int -> WeekdayOfMonth -> ST s () # basicClear :: MVector s WeekdayOfMonth -> ST s () # basicSet :: MVector s WeekdayOfMonth -> WeekdayOfMonth -> ST s () # basicUnsafeCopy :: MVector s WeekdayOfMonth -> MVector s WeekdayOfMonth -> ST s () # basicUnsafeMove :: MVector s WeekdayOfMonth -> MVector s WeekdayOfMonth -> ST s () # basicUnsafeGrow :: MVector s WeekdayOfMonth -> Int -> ST s (MVector s WeekdayOfMonth) #
type Rep WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth type Rep WeekdayOfMonth = D1 ('MetaData "WeekdayOfMonth" "Data.Thyme.Calendar.WeekdayOfMonth" "thyme-0.4-HyK6SfK4MlBKX4LjgMsZJ4" 'False) (C1 ('MetaCons "WeekdayOfMonth" 'PrefixI 'True) ((S1 ('MetaSel ('Just "womYear") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Year) :: S1 ('MetaSel ('Just "womMonth") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Month)) :: (S1 ('MetaSel ('Just "womNth") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "womDayOfWeek") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 DayOfWeek))))
newtype Vector WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth newtype Vector WeekdayOfMonth = V_WeekdayOfMonth (Vector Int)
newtype MVector s WeekdayOfMonth Source #
Instance details Defined in Data.Thyme.Calendar.WeekdayOfMonth newtype MVector s WeekdayOfMonth = MV_WeekdayOfMonth (MVector s Int)

_womYear :: Lens' WeekdayOfMonth Year Source #

_womMonth :: Lens' WeekdayOfMonth Month Source #

_womNth :: Lens' WeekdayOfMonth Int Source #

_womDayOfWeek :: Lens' WeekdayOfMonth DayOfWeek Source #

weekdayOfMonth :: Iso' Day WeekdayOfMonth Source #

Conversion between a Day and and WeekdayOfMonth.

This is a proper Iso if and only if all of the WeekdayOfMonth fields are valid and positive.

For example, the last Monday in January 2016 is also the fourth Monday:

> weekdayOfMonth # WeekdayOfMonth 2016 1 (-1) 1
2016-01-25
> YearMonthDay 2016 01 25 ^. from gregorian . weekdayOfMonth
WeekdayOfMonth {womYear = 2016, womMonth = 1, womNth = 4, womDayOfWeek = 1}

weekdayOfMonthValid :: WeekdayOfMonth -> Maybe Day Source #

Convert a WeekdayOfMonth to a Day. Returns Nothing for invalid input.

For example, the third Sunday of January 2016 is 2016-01-27, but there is no fifth Monday in January 2016.

> weekdayOfMonthValid (WeekdayOfMonth 2016 1 3 7)
Just 2016-01-17
> weekdayOfMonthValid (WeekdayOfMonth 2016 1 5 1)
Nothing