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


-- | Command-line option types for dates and times.
--   
--   Command-line option types for dates and times.
@package options-time
@version 1.0


-- | The <tt>options-time</tt> package provides <a>OptionType</a>
--   implementations and associated <tt>SimpleOption</tt> instances for
--   types related to dates and times.
module Options.Time

-- | Store an option as a <a>DiffTime</a>. The duration is specified in a
--   format such as <tt>"2h30m"</tt> for two hours and thirty minutes.
--   
--   Available units are:
--   
--   <ul>
--   <li>"h" for hours.</li>
--   <li>"m" for minutes.</li>
--   <li>"s" for seconds.</li>
--   <li>"ms" for milliseconds.</li>
--   <li>"us" or "µs" for microseconds.</li>
--   <li>"ns" for nanoseconds.</li>
--   <li>"ps" for picoseconds.</li>
--   </ul>
--   
--   Larger units are not available to avoid ambiguity when dealing with
--   daylight savings time.
optionType_duration :: OptionType DiffTime

-- | Store an option as a <a>Day</a>. Supported formats are:
--   
--   <ul>
--   <li>"YYYY-MM-DD"</li>
--   <li>"YYYYMMDD"</li>
--   <li>"YYYY-DDD"</li>
--   </ul>
optionType_date :: OptionType Day

-- | Store an option as a <a>TimeOfDay</a>. Supported formats are:
--   
--   <ul>
--   <li>"HH:MM"</li>
--   <li>"HH:MM:SS"</li>
--   <li>"HH:MM:SS.FFFF"</li>
--   </ul>
--   
--   For example, the value <tt>"10:11:12.5"</tt> is half a second past
--   10:11:12 AM.
optionType_time :: OptionType TimeOfDay

-- | Store an option as a <a>LocalTime</a>. Supported formats are a
--   combination of those for <a>optionType_date</a> and
--   <a>optionType_time</a>.
optionType_localTime :: OptionType LocalTime

-- | Store an option as a <a>UTCTime</a>. Supported formats are a
--   combination of those for <a>optionType_date</a> and
--   <a>optionType_time</a>.
optionType_utcTime :: OptionType UTCTime

-- | Store an option as a <a>ZonedTime</a>. Supported formats are a
--   combination of those for <a>optionType_date</a> and
--   <a>optionType_time</a>.
optionType_zonedTime :: OptionType ZonedTime
instance SimpleOptionType ZonedTime
instance SimpleOptionType UTCTime
instance SimpleOptionType LocalTime
instance SimpleOptionType TimeOfDay
instance SimpleOptionType Day
instance SimpleOptionType DiffTime