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


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


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

-- | A <a>ZoneInfo</a> object's lifetime is bound to its <a>Olson</a>
--   parent. The pair includes the <a>Olson</a> parent to ensure that it is
--   not garbage collected while the <a>ZoneInfo</a> object is still in
--   use.
type ZoneInfo = (Olson, Ptr CZoneInfo)

-- | Create a new <a>Olson</a> context object. 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.
newOlson :: Maybe String -> IO Olson

-- | Obtain a <a>ZoneInfo</a> object based on the specified Olson
--   identifier or time-zone. If the zone-info database cannot be found, or
--   the time-zone not recognised, then an <a>IOError</a> will be thrown.
--   Calls to this function must be serialised across multiple threads.
getZoneInfo :: Olson -> String -> IO ZoneInfo

-- | <a>ZoneInfo</a> for the UTC time-zone.
utcZoneInfo :: Olson -> 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