<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<ocamldoc with-contents="true">
<title>Stog library reference documentation : Stog_date</title><contents><div class="ocamldoc-page">
<div class="navbar"><a class="pre" href="Stog_graph.html" title="Stog_graph">Previous</a>
 <a class="up" href="index.html" title="Index">Up</a>
 <a class="post" href="Stog_types.html" title="Stog_types">Next</a>
</div>
<h1>Module <a href="type_Stog_date.html">Stog_date</a></h1>
<pre><span class="keyword">module</span> Stog_date: <code class="code">sig</code> <a href="Stog_date.html">..</a> <code class="code">end</code></pre><div class="info">
Support for common date/time parsing and formatting.
Many routines refer to the epoch, which for Unix is
00:00:00 UTC, January 1, 1970.<br/>
</div>
<hr width="100%"/>
<pre><code><span id="TYPEt"><span class="keyword">type</span> t</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.year">year</span> :<code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >complete year</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.month">month</span> :<code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >1..12</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.day">day</span> :<code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >1..31</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.hour">hour</span> :<code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.minute">minute</span> :<code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.second">second</span> :<code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.zone">zone</span> :<code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >in minutes; 60 = UTC+0100</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code>  </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.week_day">week_day</span> :<code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >0 = sunday; -1 if not given</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<pre><span id="VALlocalzone"><span class="keyword">val</span> localzone</span> : <code class="type">int</code></pre><pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">?zone:int -> float -> <a href="Stog_date.html#TYPEt">t</a></code></pre><div class="info">
Convert the time (seconds since the epoch) to a date/time record<br/>
</div>
<pre><span id="VALparse"><span class="keyword">val</span> parse</span> : <code class="type">string -> <a href="Stog_date.html#TYPEt">t</a></code></pre><div class="info">
Parse a string and return a date/time record<br/>
</div>
<pre><span id="VALsince_epoch"><span class="keyword">val</span> since_epoch</span> : <code class="type"><a href="Stog_date.html#TYPEt">t</a> -> float</code></pre><div class="info">
Convert a date/time record into the time (seconds since the epoch)<br/>
</div>
<pre><span id="VALparse_epoch"><span class="keyword">val</span> parse_epoch</span> : <code class="type">string -> float</code></pre><div class="info">
Parse a string and return the time (seconds since the epoch<br/>
</div>
<pre><span id="VALformat_to"><span class="keyword">val</span> format_to</span> : <code class="type">Buffer.t -> fmt:string -> <a href="Stog_date.html#TYPEt">t</a> -> unit</code></pre><pre><span id="VALformat"><span class="keyword">val</span> format</span> : <code class="type">fmt:string -> <a href="Stog_date.html#TYPEt">t</a> -> string</code></pre><pre><span id="VALmk_mail_date"><span class="keyword">val</span> mk_mail_date</span> : <code class="type">?zone:int -> float -> string</code></pre><pre><span id="VALmk_usenet_date"><span class="keyword">val</span> mk_usenet_date</span> : <code class="type">?zone:int -> float -> string</code></pre></div></contents></ocamldoc>
