Sophie: ghc-MissingH-devel-1.1.0.3-2.fc14 i686

ghc-MissingH-devel-1.1.0.3-2.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>System.Time.Utils</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_System-Time-Utils.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>MissingH-1.1.0.3: Large utility library</TD
><TD CLASS="topbut"
><A HREF="src/System-Time-Utils.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>System.Time.Utils</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>provisional</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>John Goerzen &lt;jgoerzen@complete.org&gt; </TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>This module provides various Haskell utilities for dealing with times and
dates.
</P
><P
>Written by John Goerzen, jgoerzen@complete.org
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3Atimelocal"
>timelocal</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Atimegm"
>timegm</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtimeDiffToSecs"
>timeDiffToSecs</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ATimeDiff"
>TimeDiff</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aepoch"
>epoch</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ACalendarTime"
>CalendarTime</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AepochToClockTime"
>epochToClockTime</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AReal"
>Real</A
> a =&gt; a -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3AClockTime"
>ClockTime</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AclockTimeToEpoch"
>clockTimeToEpoch</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3ANum"
>Num</A
> a =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3AClockTime"
>ClockTime</A
> -&gt; a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArenderSecs"
>renderSecs</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArenderTD"
>renderTD</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ATimeDiff"
>TimeDiff</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:timelocal"
><A NAME="v%3Atimelocal"
></A
></A
><B
>timelocal</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#timelocal"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Converts the specified CalendarTime (see System.Time) to 
seconds-since-epoch format.
</P
><P
>The input CalendarTime is assumed to be the time as given in your local
timezone.  All timezone and DST fields in the object are ignored.
</P
><P
>This behavior is equivolent to the timelocal() and mktime() functions that
C programmers are accustomed to.
</P
><P
>Please note that the behavior for this function during the hour immediately
before or after a DST switchover may produce a result with a different hour
than you expect.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:timegm"
><A NAME="v%3Atimegm"
></A
></A
><B
>timegm</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#timegm"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Converts the specified CalendarTime (see System.Time) to seconds-since-epoch time.
</P
><P
>This conversion does respect the timezone specified on the input object.
If you want a conversion from UTC, specify ctTZ = 0 and ctIsDST = False.
</P
><P
>When called like that, the behavior is equivolent to the GNU C function
timegm().  Unlike the C library, Haskell's CalendarTime supports
timezone information, so if such information is specified, it will impact
the result.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:timeDiffToSecs"
><A NAME="v%3AtimeDiffToSecs"
></A
></A
><B
>timeDiffToSecs</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ATimeDiff"
>TimeDiff</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#timeDiffToSecs"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Converts the given timeDiff to the number of seconds it represents. 
</P
><P
>Uses the same algorithm as normalizeTimeDiff in GHC. 
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:epoch"
><A NAME="v%3Aepoch"
></A
></A
><B
>epoch</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ACalendarTime"
>CalendarTime</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#epoch"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>January 1, 1970, midnight, UTC, represented as a CalendarTime. 
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:epochToClockTime"
><A NAME="v%3AepochToClockTime"
></A
></A
><B
>epochToClockTime</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AReal"
>Real</A
> a =&gt; a -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3AClockTime"
>ClockTime</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#epochToClockTime"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Converts an Epoch time represented with an arbitrary Real to a ClockTime.
This input could be a CTime from Foreign.C.Types or an EpochTime from
System.Posix.Types. 
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:clockTimeToEpoch"
><A NAME="v%3AclockTimeToEpoch"
></A
></A
><B
>clockTimeToEpoch</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3ANum"
>Num</A
> a =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3AClockTime"
>ClockTime</A
> -&gt; a</TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#clockTimeToEpoch"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Converts a ClockTime to something represented with an arbitrary Real.
The result could be treated as a CTime from Foreign.C.Types or EpochTime from
System.Posix.Types.  The inverse of <TT
><A HREF="System-Time-Utils.html#v%3AepochToClockTime"
>epochToClockTime</A
></TT
>.
</P
><P
>Fractions of a second are not preserved by this function. 
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:renderSecs"
><A NAME="v%3ArenderSecs"
></A
></A
><B
>renderSecs</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#renderSecs"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Render a number of seconds as a human-readable amount.  Shows the two
most significant places.  For instance:
</P
><PRE
>renderSecs 121 = &quot;2m1s&quot;
</PRE
><P
>See also <TT
><A HREF="System-Time-Utils.html#v%3ArenderTD"
>renderTD</A
></TT
> for a function that works on a TimeDiff.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:renderTD"
><A NAME="v%3ArenderTD"
></A
></A
><B
>renderTD</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/haskell98-1.0.1.1/Time.html#t%3ATimeDiff"
>TimeDiff</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Time-Utils.html#renderTD"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Like <TT
><A HREF="System-Time-Utils.html#v%3ArenderSecs"
>renderSecs</A
></TT
>, but takes a TimeDiff instead of an integer second
count. 
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>