Data.HodaTime.CalendarDate

Documentation

data DayNth

Constructors

First

Second

Third

Fourth

Fifth

Last

SecondToLast

ThirdToLast

FourthToLast

Instances

Enum DayNth

Methods

succ :: DayNth -> DayNth

pred :: DayNth -> DayNth

toEnum :: Int -> DayNth

fromEnum :: DayNth -> Int

enumFrom :: DayNth -> [DayNth]

enumFromThen :: DayNth -> DayNth -> [DayNth]

enumFromTo :: DayNth -> DayNth -> [DayNth]

enumFromThenTo :: DayNth -> DayNth -> DayNth -> [DayNth]

Eq DayNth

Methods

(==) :: DayNth -> DayNth -> Bool

(/=) :: DayNth -> DayNth -> Bool

Show DayNth

Methods

showsPrec :: Int -> DayNth -> ShowS

show :: DayNth -> String

showList :: [DayNth] -> ShowS

type Year = Int

type WeekNumber = Int

type DayOfMonth = Int

data CalendarDate calendar

Represents a specific date within its calendar system, with no reference to any time zone or time of day. Note: We keep the date in 2 formats, redundantly. We depend on lazy evaluation to only produce the portion that is actually used

Instances

Eq (CalendarDate calendar)

Methods

(==) :: CalendarDate calendar -> CalendarDate calendar -> Bool

(/=) :: CalendarDate calendar -> CalendarDate calendar -> Bool

Ord (CalendarDate calendar)

Methods

compare :: CalendarDate calendar -> CalendarDate calendar -> Ordering

(<) :: CalendarDate calendar -> CalendarDate calendar -> Bool

(<=) :: CalendarDate calendar -> CalendarDate calendar -> Bool

(>) :: CalendarDate calendar -> CalendarDate calendar -> Bool

(>=) :: CalendarDate calendar -> CalendarDate calendar -> Bool

max :: CalendarDate calendar -> CalendarDate calendar -> CalendarDate calendar

min :: CalendarDate calendar -> CalendarDate calendar -> CalendarDate calendar

Show (CalendarDate calendar)

Methods

showsPrec :: Int -> CalendarDate calendar -> ShowS

show :: CalendarDate calendar -> String

showList :: [CalendarDate calendar] -> ShowS

IsCalendar cal => HasDate (CalendarDate cal)

Associated Types

type DoW (CalendarDate cal) :: *

type MoY (CalendarDate cal) :: *

Methods

day :: Functor f => (DayOfMonth -> f DayOfMonth) -> CalendarDate cal -> f (CalendarDate cal)

month :: CalendarDate cal -> MoY (CalendarDate cal)

monthl :: Functor f => (Int -> f Int) -> CalendarDate cal -> f (CalendarDate cal)

year :: Functor f => (Year -> f Year) -> CalendarDate cal -> f (CalendarDate cal)

dayOfWeek :: CalendarDate cal -> DoW (CalendarDate cal)

next :: Int -> DoW (CalendarDate cal) -> CalendarDate cal -> CalendarDate cal

previous :: Int -> DoW (CalendarDate cal) -> CalendarDate cal -> CalendarDate cal

type DoW (CalendarDate cal)

type DoW (CalendarDate cal) = DayOfWeek cal

type MoY (CalendarDate cal)

type MoY (CalendarDate cal) = Month cal

class HasDate d where

Minimal complete definition

day, month, monthl, year, dayOfWeek, next, previous

Associated Types

type DoW d

type MoY d

Methods

day :: Functor f => (DayOfMonth -> f DayOfMonth) -> d -> f d

Lens for the day component of a HasDate. Please note that days are not clamped: if you add e.g. 400 days then the month and year will roll

month :: d -> MoY d

Accessor for the Month component of a HasDate.

monthl :: Functor f => (Int -> f Int) -> d -> f d

Lens for interacting with the month component of a HasDate. Please note that we convert the month to an Int so meaningful math can be done on it. Also please note that the day will be unaffected except in the case of "end of month" days which may clamp. Note that this clamping will only occur as a final step, so that

>>> modify (+ 2) monthl $ Gregorian.calendarDate 31 January 2000
CalendarDate 31 March 2000

and not 29th of March as would happen with some libraries.

year :: Functor f => (Year -> f Year) -> d -> f d

Lens for the year component of a HasDate. Please note that the rest of the date is left as is, with two exceptions: Feb 29 will clamp to 28 in a non-leapyear and if the new year is earlier than the earliest supported year it will clamp back to that year

dayOfWeek :: d -> DoW d

next :: Int -> DoW d -> d -> d

previous :: Int -> DoW d -> d -> d

Instances

IsCalendar cal => HasDate (CalendarDateTime cal)

Associated Types

type DoW (CalendarDateTime cal) :: *

type MoY (CalendarDateTime cal) :: *

Methods

day :: Functor f => (DayOfMonth -> f DayOfMonth) -> CalendarDateTime cal -> f (CalendarDateTime cal)

month :: CalendarDateTime cal -> MoY (CalendarDateTime cal)

monthl :: Functor f => (Int -> f Int) -> CalendarDateTime cal -> f (CalendarDateTime cal)

year :: Functor f => (Year -> f Year) -> CalendarDateTime cal -> f (CalendarDateTime cal)

dayOfWeek :: CalendarDateTime cal -> DoW (CalendarDateTime cal)

next :: Int -> DoW (CalendarDateTime cal) -> CalendarDateTime cal -> CalendarDateTime cal

previous :: Int -> DoW (CalendarDateTime cal) -> CalendarDateTime cal -> CalendarDateTime cal

IsCalendar cal => HasDate (CalendarDate cal)

Associated Types

type DoW (CalendarDate cal) :: *

type MoY (CalendarDate cal) :: *

Methods

day :: Functor f => (DayOfMonth -> f DayOfMonth) -> CalendarDate cal -> f (CalendarDate cal)

month :: CalendarDate cal -> MoY (CalendarDate cal)

monthl :: Functor f => (Int -> f Int) -> CalendarDate cal -> f (CalendarDate cal)

year :: Functor f => (Year -> f Year) -> CalendarDate cal -> f (CalendarDate cal)

dayOfWeek :: CalendarDate cal -> DoW (CalendarDate cal)

next :: Int -> DoW (CalendarDate cal) -> CalendarDate cal -> CalendarDate cal

previous :: Int -> DoW (CalendarDate cal) -> CalendarDate cal -> CalendarDate cal