<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Time.Format</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Time-Format.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">time-1.4: A time library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Data.Time.Format</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">UNIX-style formatting
</a></li><li><a href="#g:2">UNIX-style parsing
</a></li></ul></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">type</span> <a href="#t:NumericPadOption">NumericPadOption</a> = <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a></li><li class="src short"><span class="keyword">class</span> <a href="#t:FormatTime">FormatTime</a> t <span class="keyword">where</span><ul class="subs"><li><a href="#v:formatCharacter">formatCharacter</a> :: <a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Data-Time-Format.html#t:NumericPadOption">NumericPadOption</a> -> t -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)</li></ul></li><li class="src short"><a href="#v:formatTime">formatTime</a> :: <a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> t => <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> t -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:parseTime">parseTime</a> :: <a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> t => <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> t</li><li class="src short"><a href="#v:readTime">readTime</a> :: <a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> t => <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> t</li><li class="src short"><a href="#v:readsTime">readsTime</a> :: <a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> t => <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> t</li><li class="src short"><span class="keyword">class</span> <a href="#t:ParseTime">ParseTime</a> t <span class="keyword">where</span><ul class="subs"><li><a href="#v:buildTime">buildTime</a> :: <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> [(<a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a>, <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)] -> t</li></ul></li></ul></div><div id="interface"><h1 id="g:1">UNIX-style formatting
</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:NumericPadOption" class="def">NumericPadOption</a> = <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a></p></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:FormatTime" class="def">FormatTime</a> t <span class="keyword">where</span></p><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:formatCharacter" class="def">formatCharacter</a> :: <a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Data-Time-Format.html#t:NumericPadOption">NumericPadOption</a> -> t -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)</p></div><div class="subs instances"><p id="control.i:FormatTime" class="caption collapser" onclick="toggleSection('i:FormatTime')">Instances</p><div id="section.i:FormatTime" class="show"><table><tr><td class="src"><a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> <a href="Data-Time-Calendar.html#t:Day">Day</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> <a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> <a href="Data-Time-LocalTime.html#t:TimeZone">TimeZone</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> <a href="Data-Time-LocalTime.html#t:TimeOfDay">TimeOfDay</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> <a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> <a href="Data-Time-LocalTime.html#t:LocalTime">LocalTime</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:formatTime" class="def">formatTime</a> :: <a href="Data-Time-Format.html#t:FormatTime">FormatTime</a> t => <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> t -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></p><div class="doc"><p>Substitute various time-related information for each %-code in the string, as per <code><a href="Data-Time-Format.html#v:formatCharacter">formatCharacter</a></code>.
</p><p>For all types (note these three are done here, not by <code><a href="Data-Time-Format.html#v:formatCharacter">formatCharacter</a></code>):
</p><dl><dt><code>%%</code></dt><dd> <code>%</code>
</dd><dt><code>%t</code></dt><dd> tab
</dd><dt><code>%n</code></dt><dd> newline
</dd></dl><p>glibc-style modifiers can be used before the letter (here marked as <code>z</code>):
</p><dl><dt><code>%-z</code></dt><dd> no padding
</dd><dt><code>%_z</code></dt><dd> pad with spaces
</dd><dt><code>%0z</code></dt><dd> pad with zeros
</dd><dt><code>%^z</code></dt><dd> convert to upper case
</dd><dt><code>%#z</code></dt><dd> convert to lower case (consistently, unlike glibc)
</dd></dl><p>For <code><a href="Data-Time-LocalTime.html#t:TimeZone">TimeZone</a></code> (and <code><a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></code> and <code><a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></code>):
</p><dl><dt><code>%z</code></dt><dd> timezone offset in the format <code>-HHMM</code>.
</dd><dt><code>%Z</code></dt><dd> timezone name
</dd></dl><p>For <code><a href="Data-Time-LocalTime.html#t:LocalTime">LocalTime</a></code> (and <code><a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></code> and <code><a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></code>):
</p><dl><dt><code>%c</code></dt><dd> as <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:dateTimeFmt">dateTimeFmt</a></code> <code>locale</code> (e.g. <code>%a %b %e %H:%M:%S %Z %Y</code>)
</dd></dl><p>For <code><a href="Data-Time-LocalTime.html#t:TimeOfDay">TimeOfDay</a></code> (and <code><a href="Data-Time-LocalTime.html#t:LocalTime">LocalTime</a></code> and <code><a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></code> and <code><a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></code>):
</p><dl><dt><code>%R</code></dt><dd> same as <code>%H:%M</code>
</dd><dt><code>%T</code></dt><dd> same as <code>%H:%M:%S</code>
</dd><dt><code>%X</code></dt><dd> as <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:timeFmt">timeFmt</a></code> <code>locale</code> (e.g. <code>%H:%M:%S</code>)
</dd><dt><code>%r</code></dt><dd> as <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:time12Fmt">time12Fmt</a></code> <code>locale</code> (e.g. <code>%I:%M:%S %p</code>)
</dd><dt><code>%P</code></dt><dd> day half from (<code><a href="../old-locale-1.0.0.4/System-Locale.html#v:amPm">amPm</a></code> <code>locale</code>), converted to lowercase, <code>am</code>, <code>pm</code>
</dd><dt><code>%p</code></dt><dd> day half from (<code><a href="../old-locale-1.0.0.4/System-Locale.html#v:amPm">amPm</a></code> <code>locale</code>), <code>AM</code>, <code>PM</code>
</dd><dt><code>%H</code></dt><dd> hour, 24-hour, leading 0 as needed, <code>00</code> - <code>23</code>
</dd><dt><code>%I</code></dt><dd> hour, 12-hour, leading 0 as needed, <code>01</code> - <code>12</code>
</dd><dt><code>%k</code></dt><dd> hour, 24-hour, leading space as needed, <code> 0</code> - <code>23</code>
</dd><dt><code>%l</code></dt><dd> hour, 12-hour, leading space as needed, <code> 1</code> - <code>12</code>
</dd><dt><code>%M</code></dt><dd> minute, <code>00</code> - <code>59</code>
</dd><dt><code>%S</code></dt><dd> second, without decimal part, <code>00</code> - <code>60</code>
</dd><dt><code>%q</code></dt><dd> picosecond, including trailing zeros, <code>000000000000</code> - <code>999999999999</code>.
</dd><dt><code>%Q</code></dt><dd> decimal point and up to 12 second decimals, without trailing zeros.
For a whole number of seconds, <code>%Q</code> produces the empty string.
</dd></dl><p>For <code><a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></code> and <code><a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></code>:
</p><dl><dt><code>%s</code></dt><dd> number of whole seconds since the Unix epoch. For times before
the Unix epoch, this is a negative number. Note that in <code>%s.%q</code> and <code>%s%Q</code>
the decimals are positive, not negative. For example, 0.9 seconds
before the Unix epoch is formatted as <code>-1.1</code> with <code>%s%Q</code>.
</dd></dl><p>For <code><a href="Data-Time-Calendar.html#t:Day">Day</a></code> (and <code><a href="Data-Time-LocalTime.html#t:LocalTime">LocalTime</a></code> and <code><a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></code> and <code><a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></code>):
</p><dl><dt><code>%D</code></dt><dd> same as <code>%m/%d/%y</code>
</dd><dt><code>%F</code></dt><dd> same as <code>%Y-%m-%d</code>
</dd><dt><code>%x</code></dt><dd> as <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:dateFmt">dateFmt</a></code> <code>locale</code> (e.g. <code>%m/%d/%y</code>)
</dd><dt><code>%Y</code></dt><dd> year
</dd><dt><code>%y</code></dt><dd> last two digits of year, <code>00</code> - <code>99</code>
</dd><dt><code>%C</code></dt><dd> century (being the first two digits of the year), <code>00</code> - <code>99</code>
</dd><dt><code>%B</code></dt><dd> month name, long form (<code><a href="../base-4.5.1.0/Data-Tuple.html#v:fst">fst</a></code> from <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:months">months</a></code> <code>locale</code>), <code>January</code> - <code>December</code>
</dd><dt><code>%b</code>, <code>%h</code></dt><dd> month name, short form (<code><a href="../base-4.5.1.0/Data-Tuple.html#v:snd">snd</a></code> from <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:months">months</a></code> <code>locale</code>), <code>Jan</code> - <code>Dec</code>
</dd><dt><code>%m</code></dt><dd> month of year, leading 0 as needed, <code>01</code> - <code>12</code>
</dd><dt><code>%d</code></dt><dd> day of month, leading 0 as needed, <code>01</code> - <code>31</code>
</dd><dt><code>%e</code></dt><dd> day of month, leading space as needed, <code> 1</code> - <code>31</code>
</dd><dt><code>%j</code></dt><dd> day of year for Ordinal Date format, <code>001</code> - <code>366</code>
</dd><dt><code>%G</code></dt><dd> year for Week Date format
</dd><dt><code>%g</code></dt><dd> last two digits of year for Week Date format, <code>00</code> - <code>99</code>
</dd><dt><code>%f</code></dt><dd> century (first two digits of year) for Week Date format, <code>00</code> - <code>99</code>
</dd><dt><code>%V</code></dt><dd> week for Week Date format, <code>01</code> - <code>53</code>
</dd><dt><code>%u</code></dt><dd> day for Week Date format, <code>1</code> - <code>7</code>
</dd><dt><code>%a</code></dt><dd> day of week, short form (<code><a href="../base-4.5.1.0/Data-Tuple.html#v:snd">snd</a></code> from <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:wDays">wDays</a></code> <code>locale</code>), <code>Sun</code> - <code>Sat</code>
</dd><dt><code>%A</code></dt><dd> day of week, long form (<code><a href="../base-4.5.1.0/Data-Tuple.html#v:fst">fst</a></code> from <code><a href="../old-locale-1.0.0.4/System-Locale.html#v:wDays">wDays</a></code> <code>locale</code>), <code>Sunday</code> - <code>Saturday</code>
</dd><dt><code>%U</code></dt><dd> week number of year, where weeks start on Sunday (as <code><a href="Data-Time-Calendar-OrdinalDate.html#v:sundayStartWeek">sundayStartWeek</a></code>), <code>00</code> - <code>53</code>
</dd><dt><code>%w</code></dt><dd> day of week number, <code>0</code> (= Sunday) - <code>6</code> (= Saturday)
</dd><dt><code>%W</code></dt><dd> week number of year, where weeks start on Monday (as <code><a href="Data-Time-Calendar-OrdinalDate.html#v:mondayStartWeek">mondayStartWeek</a></code>), <code>00</code> - <code>53</code>
</dd></dl></div></div><h1 id="g:2">UNIX-style parsing
</h1><div class="top"><p class="src"><a name="v:parseTime" class="def">parseTime</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> t</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a></td><td class="doc"><p>Time locale.
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Format string.
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Input string.
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> t</td><td class="doc"><p>The time value, or <code><a href="../base-4.5.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the input could
not be parsed using the given format.
</p></td></tr></table></div><div class="doc"><p>Parses a time value given a format string.
Supports the same %-codes as <code>formatTime</code>, including <code>%-</code>, <code>%_</code> and <code>%0</code> modifiers.
Leading and trailing whitespace is accepted. Case is not significant.
Some variations in the input are accepted:
</p><dl><dt><code>%z</code></dt><dd> accepts any of <code>-HHMM</code> or <code>-HH:MM</code>.
</dd><dt><code>%Z</code></dt><dd> accepts any string of letters, or any of the formats accepted by <code>%z</code>.
</dd></dl></div></div><div class="top"><p class="src"><a name="v:readTime" class="def">readTime</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> t</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a></td><td class="doc"><p>Time locale.
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Format string.
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Input string.
</p></td></tr><tr><td class="src">-> t</td><td class="doc"><p>The time value.
</p></td></tr></table></div><div class="doc"><p>Parse a time value given a format string. Fails if the input could
not be parsed using the given format. See <code><a href="Data-Time-Format.html#v:parseTime">parseTime</a></code> for details.
</p></div></div><div class="top"><p class="src"><a name="v:readsTime" class="def">readsTime</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> t</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a></td><td class="doc"><p>Time locale.
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Format string
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Text-ParserCombinators-ReadP.html#t:ReadS">ReadS</a> t</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Parse a time value given a format string. See <code><a href="Data-Time-Format.html#v:parseTime">parseTime</a></code> for details.
</p></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:ParseTime" class="def">ParseTime</a> t <span class="keyword">where</span></p><div class="doc"><p>The class of types which can be parsed given a UNIX-style time format
string.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:buildTime" class="def">buildTime</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="../old-locale-1.0.0.4/System-Locale.html#t:TimeLocale">TimeLocale</a></td><td class="doc"><p>The time locale.
</p></td></tr><tr><td class="src">-> [(<a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a>, <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)]</td><td class="doc"><p>Pairs of format characters and the
corresponding part of the input.
</p></td></tr><tr><td class="src">-> t</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Builds a time value from a parsed input string.
If the input does not include all the information needed to
construct a complete value, any missing parts should be taken
from 1970-01-01 00:00:00 +0000 (which was a Thursday).
In the absence of <code>%C</code> or <code>%Y</code>, century is 1969 - 2068.
</p></div></div><div class="subs instances"><p id="control.i:ParseTime" class="caption collapser" onclick="toggleSection('i:ParseTime')">Instances</p><div id="section.i:ParseTime" class="show"><table><tr><td class="src"><a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> <a href="Data-Time-Calendar.html#t:Day">Day</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> <a href="Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> <a href="Data-Time-LocalTime.html#t:TimeZone">TimeZone</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> <a href="Data-Time-LocalTime.html#t:TimeOfDay">TimeOfDay</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> <a href="Data-Time-LocalTime.html#t:ZonedTime">ZonedTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Time-Format.html#t:ParseTime">ParseTime</a> <a href="Data-Time-LocalTime.html#t:LocalTime">LocalTime</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
4165
