Data.HodaTime.ZonedDateTime

This is the module for ZonedDateTime. A ZonedDateTime is a universal time, it represents the same moment anywhere in the world and is completely unambiguous. Each instance of a ZonedDateTime corresponds to exactly one point on a continuous time line.

Types

data ZonedDateTime cal

A CalendarDateTime in a specific time zone. A ZonedDateTime is global and maps directly to a single Instant.

Instances

Eq (ZonedDateTime cal)

Methods

(==) :: ZonedDateTime cal -> ZonedDateTime cal -> Bool

(/=) :: ZonedDateTime cal -> ZonedDateTime cal -> Bool

Show (ZonedDateTime cal)

Methods

showsPrec :: Int -> ZonedDateTime cal -> ShowS

show :: ZonedDateTime cal -> String

showList :: [ZonedDateTime cal] -> ShowS

Constructors

fromCalendarDateTimeLeniently :: (IsCalendar cal, IsCalendarDateTime cal) => CalendarDateTime cal -> TimeZone -> ZonedDateTime cal

Returns the mapping of this CalendarDateTime within the given TimeZone, with "lenient" rules applied such that ambiguous values map to the earlier of the alternatives, and "skipped" values are shifted forward by the duration of the "gap".

fromCalendarDateTimeStrictly :: (MonadThrow m, IsCalendarDateTime cal) => CalendarDateTime cal -> TimeZone -> m (ZonedDateTime cal)

Returns the mapping of this CalendarDateTime within the given TimeZone, with "strict" rules applied such that ambiguous or skipped date times return the requested failure response (e.g. Nothing, Left, exception, etc.)

fromInstant :: IsCalendarDateTime cal => Instant -> TimeZone -> ZonedDateTime cal

Returns the ZonedDateTime represented by the passed Instant within the given TimeZone. This is always an unambiguous conversion.

Math

Conversion

toCalendarDateTime :: ZonedDateTime cal -> CalendarDateTime cal

Return the CalendarDateTime represented by this ZonedDateTime.

toCalendarDate :: ZonedDateTime cal -> CalendarDate cal

Return the CalendarDate represented by this ZonedDateTime.

toLocalTime :: ZonedDateTime cal -> LocalTime

Return the LocalTime represented by this ZonedDateTime.

Accessors

inDst :: ZonedDateTime cal -> Bool

Return a Bool specifying if this ZonedDateTime is currently in Daylight savings time.

zoneAbbreviation :: ZonedDateTime cal -> String

Return a String representing the abbreviation for the TimeZone this ZonedDateTime is currently in.

Special constructors

fromCalendarDateTimeAll :: IsCalendarDateTime cal => CalendarDateTime cal -> TimeZone -> [ZonedDateTime cal]

Return all ZonedDateTime entries for a specific CalendarDateTime in a TimeZone. Normally this would be one, but in the case that a time occurs twice in a zone (i.e. due to daylight savings time change) both would be returned. Also, if the time does not occur at all, an empty list will be returned. This method allows the user to choose exactly what to do in the case of ambigiuty.

resolve :: IsCalendarDateTime cal => (ZonedDateTime cal -> ZonedDateTime cal -> ZonedDateTime cal) -> (ZonedDateTime cal -> ZonedDateTime cal -> ZonedDateTime cal) -> CalendarDateTime cal -> TimeZone -> ZonedDateTime cal

Takes two functions to determine how to resolve a CalendarDateTime to a ZonedDateTime in the case of ambiguity or skipped times. The first function is for the ambigous case and is past the first matching ZonedDateTime, followed by the second match. The second function is for the case that the CalendarDateTime doesn't exist in the TimeZone (e.g. in a spring-forward situation, there will be a missing hour), the first ZonedDateTime will be the the last time before the gap and the second will be the first time after the gap.

Exceptions

data DateTimeDoesNotExistException

Constructors

DateTimeDoesNotExistException

Instances

Show DateTimeDoesNotExistException

Methods

showsPrec :: Int -> DateTimeDoesNotExistException -> ShowS

show :: DateTimeDoesNotExistException -> String

showList :: [DateTimeDoesNotExistException] -> ShowS

Exception DateTimeDoesNotExistException

Methods

toException :: DateTimeDoesNotExistException -> SomeException

fromException :: SomeException -> Maybe DateTimeDoesNotExistException

displayException :: DateTimeDoesNotExistException -> String

data DateTimeAmbiguousException

Constructors

DateTimeAmbiguousException

Instances

Show DateTimeAmbiguousException

Methods

showsPrec :: Int -> DateTimeAmbiguousException -> ShowS

show :: DateTimeAmbiguousException -> String

showList :: [DateTimeAmbiguousException] -> ShowS

Exception DateTimeAmbiguousException

Methods

toException :: DateTimeAmbiguousException -> SomeException

fromException :: SomeException -> Maybe DateTimeAmbiguousException

displayException :: DateTimeAmbiguousException -> String