Safe Haskell | Trustworthy |
---|---|

Language | Haskell2010 |

## Synopsis

- type Year = Integer
- type WeekOfYear = Int
- data DayOfWeek
- dayOfWeek :: Day -> DayOfWeek
- data FirstWeekType
- toWeekCalendar :: FirstWeekType -> DayOfWeek -> Day -> (Year, WeekOfYear, DayOfWeek)
- fromWeekCalendar :: FirstWeekType -> DayOfWeek -> Year -> WeekOfYear -> DayOfWeek -> Day
- fromWeekCalendarValid :: FirstWeekType -> DayOfWeek -> Year -> WeekOfYear -> DayOfWeek -> Maybe Day
- toWeekDate :: Day -> (Integer, Int, Int)
- fromWeekDate :: Integer -> Int -> Int -> Day
- pattern YearWeekDay :: Year -> WeekOfYear -> DayOfWeek -> Day
- fromWeekDateValid :: Integer -> Int -> Int -> Maybe Day
- showWeekDate :: Day -> String

# Documentation

type WeekOfYear = Int Source #

Week of year, by various reckonings, generally in range 0-53 depending on reckoning

#### Instances

Enum DayOfWeek | "Circular", so for example |

Defined in Data.Time.Calendar.Week succ :: DayOfWeek -> DayOfWeek # pred :: DayOfWeek -> DayOfWeek # fromEnum :: DayOfWeek -> Int # enumFrom :: DayOfWeek -> [DayOfWeek] # enumFromThen :: DayOfWeek -> DayOfWeek -> [DayOfWeek] # enumFromTo :: DayOfWeek -> DayOfWeek -> [DayOfWeek] # enumFromThenTo :: DayOfWeek -> DayOfWeek -> DayOfWeek -> [DayOfWeek] # | |

Eq DayOfWeek | |

Data DayOfWeek Source # | |

Defined in Data.Time.Orphans gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DayOfWeek -> c DayOfWeek # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DayOfWeek # toConstr :: DayOfWeek -> Constr # dataTypeOf :: DayOfWeek -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DayOfWeek) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DayOfWeek) # gmapT :: (forall b. Data b => b -> b) -> DayOfWeek -> DayOfWeek # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DayOfWeek -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DayOfWeek -> r # gmapQ :: (forall d. Data d => d -> u) -> DayOfWeek -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DayOfWeek -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DayOfWeek -> m DayOfWeek # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DayOfWeek -> m DayOfWeek # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DayOfWeek -> m DayOfWeek # | |

Ord DayOfWeek Source # | |

Defined in Data.Time.Orphans | |

Read DayOfWeek | |

Show DayOfWeek | |

NFData DayOfWeek Source # | |

Defined in Data.Time.Orphans | |

Hashable DayOfWeek Source # | |

Defined in Data.Time.Orphans |

data FirstWeekType Source #

FirstWholeWeek | first week is the first whole week of the year |

FirstMostWeek | first week is the first week with four days in the year |

#### Instances

Eq FirstWeekType Source # | |

Defined in Data.Time.Calendar.WeekDate.Compat (==) :: FirstWeekType -> FirstWeekType -> Bool # (/=) :: FirstWeekType -> FirstWeekType -> Bool # |

:: FirstWeekType | how to reckon the first week of the year |

-> DayOfWeek | the first day of each week |

-> Day | |

-> (Year, WeekOfYear, DayOfWeek) |

:: FirstWeekType | how to reckon the first week of the year |

-> DayOfWeek | the first day of each week |

-> Year | |

-> WeekOfYear | |

-> DayOfWeek | |

-> Day |

Convert from the given kind of "week calendar". Invalid week and day values will be clipped to the correct range.

fromWeekCalendarValid Source #

:: FirstWeekType | how to reckon the first week of the year |

-> DayOfWeek | the first day of each week |

-> Year | |

-> WeekOfYear | |

-> DayOfWeek | |

-> Maybe Day |

Convert from the given kind of "week calendar". Invalid week and day values will return Nothing.

# ISO 8601 Week Date format

toWeekDate :: Day -> (Integer, Int, Int) #

Convert to ISO 8601 Week Date format. First element of result is year, second week number (1-53), third day of week (1 for Monday to 7 for Sunday). Note that "Week" years are not quite the same as Gregorian years, as the first day of the year is always a Monday. The first week of a year is the first week to contain at least four days in the corresponding Gregorian year.

fromWeekDate :: Integer -> Int -> Int -> Day #

Convert from ISO 8601 Week Date format. First argument is year, second week number (1-52 or 53), third day of week (1 for Monday to 7 for Sunday). Invalid week and day values will be clipped to the correct range.

pattern YearWeekDay :: Year -> WeekOfYear -> DayOfWeek -> Day Source #

Bidirectional abstract constructor for ISO 8601 Week Date format. Invalid week values will be clipped to the correct range.

fromWeekDateValid :: Integer -> Int -> Int -> Maybe Day #

Convert from ISO 8601 Week Date format. First argument is year, second week number (1-52 or 53), third day of week (1 for Monday to 7 for Sunday). Invalid week and day values will return Nothing.

showWeekDate :: Day -> String #

Show in ISO 8601 Week Date format as yyyy-Www-d (e.g. "2006-W46-3").