-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | ZoneInfo library.
--   
--   ZoneInfo library.
@package zoneinfo
@version 0.2


-- | Provides access to the Olson zone-info database, using an adapted
--   version of the Olson zone-info library.
module Data.Time.ZoneInfo
type ZoneInfo = ForeignPtr CZoneInfo

-- | Initialise the zone-info library. A path to the zone-info database may
--   be specified. Otherwise, the TZDIR environment variable, or a
--   reasonable default, will be used. An <a>IOError</a> will be thrown on
--   failure.
initZoneInfo :: Maybe String -> IO ()

-- | <a>ZoneInfo</a> for the UTC time-zone.
utcZoneInfo :: ZoneInfo

-- | Create new <a>ZoneInfo</a>, given a suitable Olson identifier or
--   time-zone specification. If the zone-info database cannot be found, or
--   the time-zone not recognised, then an <a>IOError</a> will be thrown.
newZoneInfo :: String -> IO ZoneInfo

-- | Returns the zone-name for either the standard or daylight saving zone,
--   depending on the <tt>isdst</tt> argument.
getZoneName :: ZoneInfo -> Bool -> IO (String)

-- | Returns the UTC offset for either the standard or daylight saving
--   zone, depending on the <tt>isdst</tt> argument.
getZoneMinutes :: ZoneInfo -> Bool -> IO Int

-- | Convert from <a>POSIXTime</a> to zoned <a>LocalTime</a>.
posixToZonedTime :: ZoneInfo -> POSIXTime -> IO ZonedTime

-- | Convert from <a>UTCTime</a> to zoned <a>LocalTime</a>.
utcToZonedTime' :: ZoneInfo -> UTCTime -> IO ZonedTime

-- | Convert <a>LocalTime</a> to a daylight saving adjusted pair.
localToPOSIXZoned :: ZoneInfo -> LocalTime -> IO (POSIXTime, ZonedTime)

-- | Convert <a>LocalTime</a> to a daylight saving adjusted pair.
localToUTCZoned :: ZoneInfo -> LocalTime -> IO (UTCTime, ZonedTime)

-- | Convert the <a>LocalTime</a> argument from the source to destination
--   <a>TimeZone</a>.
convertTimeZone :: ZoneInfo -> LocalTime -> ZoneInfo -> IO ZonedTime