hodatime-0.2.1.1: A fully featured date/time library based on Nodatime

Safe HaskellSafe
LanguageHaskell2010

Data.HodaTime.CalendarDateTime

Contents

Synopsis

Types

type Year = Int Source #

data CalendarDate calendar Source #

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) Source # 

Methods

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

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

Ord (CalendarDate calendar) Source # 

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) Source # 

Methods

showsPrec :: Int -> CalendarDate calendar -> ShowS #

show :: CalendarDate calendar -> String #

showList :: [CalendarDate calendar] -> ShowS #

IsCalendar cal => HasDate (CalendarDate cal) Source # 

Associated Types

type DoW (CalendarDate cal) :: * Source #

type MoY (CalendarDate cal) :: * Source #

type DoW (CalendarDate cal) Source # 
type DoW (CalendarDate cal) = DayOfWeek cal
type MoY (CalendarDate cal) Source # 
type MoY (CalendarDate cal) = Month cal

data CalendarDateTime calendar Source #

Represents a specific date and time within its calendar system. NOTE: a CalendarDateTime does *not* represent a specific time on the global time line because e.g. "10.March.2006 4pm" is a different instant in most time zones. Convert it to a ZonedDateTime first if you wish to convert to an instant (or use a convenience function).

Instances

Eq (CalendarDateTime calendar) Source # 

Methods

(==) :: CalendarDateTime calendar -> CalendarDateTime calendar -> Bool #

(/=) :: CalendarDateTime calendar -> CalendarDateTime calendar -> Bool #

Ord (CalendarDateTime calendar) Source # 

Methods

compare :: CalendarDateTime calendar -> CalendarDateTime calendar -> Ordering #

(<) :: CalendarDateTime calendar -> CalendarDateTime calendar -> Bool #

(<=) :: CalendarDateTime calendar -> CalendarDateTime calendar -> Bool #

(>) :: CalendarDateTime calendar -> CalendarDateTime calendar -> Bool #

(>=) :: CalendarDateTime calendar -> CalendarDateTime calendar -> Bool #

max :: CalendarDateTime calendar -> CalendarDateTime calendar -> CalendarDateTime calendar #

min :: CalendarDateTime calendar -> CalendarDateTime calendar -> CalendarDateTime calendar #

Show (CalendarDateTime calendar) Source # 

Methods

showsPrec :: Int -> CalendarDateTime calendar -> ShowS #

show :: CalendarDateTime calendar -> String #

showList :: [CalendarDateTime calendar] -> ShowS #

IsCalendar cal => HasDate (CalendarDateTime cal) Source # 
IsCalendar cal => HasLocalTime (CalendarDateTime cal) Source # 
type DoW (CalendarDateTime cal) Source # 
type DoW (CalendarDateTime cal) = DayOfWeek cal
type MoY (CalendarDateTime cal) Source # 
type MoY (CalendarDateTime cal) = Month cal

class IsCalendar cal where Source #

Minimal complete definition

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

Associated Types

type Date cal Source #

data DayOfWeek cal Source #

data Month cal Source #

Methods

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

month' :: CalendarDate cal -> Month cal Source #

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

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

dayOfWeek' :: CalendarDate cal -> DayOfWeek cal Source #

next' :: Int -> DayOfWeek cal -> CalendarDate cal -> CalendarDate cal Source #

previous' :: Int -> DayOfWeek cal -> CalendarDate cal -> CalendarDate cal Source #

class HasDate d where Source #

Minimal complete definition

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

Associated Types

type DoW d Source #

type MoY d Source #

Methods

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

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 Source #

Accessor for the Month component of a HasDate.

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

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 Source #

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 Source #

next :: Int -> DoW d -> d -> d Source #

previous :: Int -> DoW d -> d -> d Source #

Instances

IsCalendar cal => HasDate (CalendarDateTime cal) Source # 
IsCalendar cal => HasDate (CalendarDate cal) Source # 

Associated Types

type DoW (CalendarDate cal) :: * Source #

type MoY (CalendarDate cal) :: * Source #

data LocalTime Source #

Represents a specific time of day with no reference to any calendar, date or time zone.

Constructors

atStartOfDay :: CalendarDate cal -> CalendarDateTime cal Source #

Returns the first valid time in the day specified by CalendarDate within the given TimeZone