Skip to content

Commit 2bc977f

Browse files
author
Jack Tang
committed
Release 0.3.0
1 parent 7c34d74 commit 2bc977f

File tree

2 files changed

+72
-17
lines changed

2 files changed

+72
-17
lines changed

docs/index.html

Lines changed: 71 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,16 @@ <h1 class="title">timestamp</h1>
100100
<li>
101101
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
102102
<ul class="simple simple-toc-section">
103-
<li><a class="reference" href="#TimestampInvalidFormatException"
104-
title="TimestampInvalidFormatException = object of TimestampException"><wbr />Timestamp<wbr />Invalid<wbr />Format<wbr />Exception<span class="attachedType"></span></a></li>
105-
<li><a class="reference" href="#TimestampOutOfRangeException"
106-
title="TimestampOutOfRangeException = object of TimestampException"><wbr />Timestamp<wbr />Out<wbr />Of<wbr />Range<wbr />Exception<span class="attachedType"></span></a></li>
103+
<li><a class="reference" href="#TimestampError"
104+
title="TimestampError = object of CatchableError"><wbr />Timestamp<wbr />Error<span class="attachedType"></span></a></li>
105+
<li><a class="reference" href="#TimestampInvalidFormatError"
106+
title="TimestampInvalidFormatError = object of TimestampError"><wbr />Timestamp<wbr />Invalid<wbr />Format<wbr />Error<span class="attachedType"></span></a></li>
107+
<li><a class="reference" href="#TimestampOutOfRangeError"
108+
title="TimestampOutOfRangeError = object of TimestampError"><wbr />Timestamp<wbr />Out<wbr />Of<wbr />Range<wbr />Error<span class="attachedType"></span></a></li>
109+
<li><a class="reference" href="#TimespanError"
110+
title="TimespanError = object of CatchableError"><wbr />Timespan<wbr />Error<span class="attachedType"></span></a></li>
111+
<li><a class="reference" href="#TimespanInvalidFormatError"
112+
title="TimespanInvalidFormatError = object of TimespanError"><wbr />Timespan<wbr />Invalid<wbr />Format<wbr />Error<span class="attachedType"></span></a></li>
107113
<li><a class="reference" href="#Timespan"
108114
title="Timespan = distinct int64"><wbr />Timespan<span class="attachedType"></span></a></li>
109115
<li><a class="reference" href="#Timestamp"
@@ -148,7 +154,9 @@ <h1 class="title">timestamp</h1>
148154
<li><a class="reference" href="#%2A%2CT%2CTimespan"
149155
title="`*`[T: SomeInteger](n: T; span: Timespan): Timespan"><wbr />`*`<span class="attachedType">Timespan</span></a></li>
150156
<li><a class="reference" href="#div%2CTimespan%2CT"
151-
title="`div`[T: SomeInteger](span: Timespan; n: T)"><wbr />`div`<span class="attachedType">Timespan</span></a></li>
157+
title="`div`[T: SomeInteger](span: Timespan; n: T): Timespan"><wbr />`div`<span class="attachedType">Timespan</span></a></li>
158+
<li><a class="reference" href="#div%2CTimespan%2CTimespan"
159+
title="`div`(a, b: Timespan): int64"><wbr />`div`<span class="attachedType">Timespan</span></a></li>
152160
<li><a class="reference" href="#%2B%2CTimespan%2CTimespan"
153161
title="`+`(a, b: Timespan): Timespan"><wbr />`+`<span class="attachedType">Timespan</span></a></li>
154162
<li><a class="reference" href="#-%2CTimespan%2CTimespan"
@@ -226,6 +234,10 @@ <h1 class="title">timestamp</h1>
226234
title="toTimestamp(t: Time): Timestamp"><wbr />to<wbr />Timestamp<span class="attachedType">Timestamp</span></a></li>
227235
<li><a class="reference" href="#toTimestamp%2CDateTime"
228236
title="toTimestamp(t: DateTime): Timestamp"><wbr />to<wbr />Timestamp<span class="attachedType">Timestamp</span></a></li>
237+
<li><a class="reference" href="#%24%2CTimespan"
238+
title="`$`(t: Timespan): string"><wbr />`$`<span class="attachedType">Timespan</span></a></li>
239+
<li><a class="reference" href="#parseTimespan%2Cstring"
240+
title="parseTimespan(s: string): Timespan"><wbr />parse<wbr />Timespan<span class="attachedType">Timespan</span></a></li>
229241

230242
</ul>
231243
</li>
@@ -240,15 +252,36 @@ <h1 class="title">timestamp</h1>
240252
<div class="section" id="7">
241253
<h1><a class="toc-backref" href="#7">Types</a></h1>
242254
<dl class="item">
243-
<a id="TimestampInvalidFormatException"></a>
244-
<dt><pre><a href="timestamp.html#TimestampInvalidFormatException"><span class="Identifier">TimestampInvalidFormatException</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">TimestampException</span></pre></dt>
255+
<a id="TimestampError"></a>
256+
<dt><pre><a href="timestamp.html#TimestampError"><span class="Identifier">TimestampError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span></pre></dt>
245257
<dd>
246258

247259

248260

249261
</dd>
250-
<a id="TimestampOutOfRangeException"></a>
251-
<dt><pre><a href="timestamp.html#TimestampOutOfRangeException"><span class="Identifier">TimestampOutOfRangeException</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">TimestampException</span></pre></dt>
262+
<a id="TimestampInvalidFormatError"></a>
263+
<dt><pre><a href="timestamp.html#TimestampInvalidFormatError"><span class="Identifier">TimestampInvalidFormatError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="timestamp.html#TimestampError"><span class="Identifier">TimestampError</span></a></pre></dt>
264+
<dd>
265+
266+
267+
268+
</dd>
269+
<a id="TimestampOutOfRangeError"></a>
270+
<dt><pre><a href="timestamp.html#TimestampOutOfRangeError"><span class="Identifier">TimestampOutOfRangeError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="timestamp.html#TimestampError"><span class="Identifier">TimestampError</span></a></pre></dt>
271+
<dd>
272+
273+
274+
275+
</dd>
276+
<a id="TimespanError"></a>
277+
<dt><pre><a href="timestamp.html#TimespanError"><span class="Identifier">TimespanError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">CatchableError</span></pre></dt>
278+
<dd>
279+
280+
281+
282+
</dd>
283+
<a id="TimespanInvalidFormatError"></a>
284+
<dt><pre><a href="timestamp.html#TimespanInvalidFormatError"><span class="Identifier">TimespanInvalidFormatError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="timestamp.html#TimespanError"><span class="Identifier">TimespanError</span></a></pre></dt>
252285
<dd>
253286

254287

@@ -372,7 +405,14 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
372405

373406
</dd>
374407
<a id="div,Timespan,T"></a>
375-
<dt><pre><span class="Keyword">proc</span> <a href="#div%2CTimespan%2CT"><span class="Identifier">`div`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeInteger</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">span</span><span class="Other">:</span> <a href="timestamp.html#Timespan"><span class="Identifier">Timespan</span></a><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span></span><span class="Other">.}</span></span></pre></dt>
408+
<dt><pre><span class="Keyword">proc</span> <a href="#div%2CTimespan%2CT"><span class="Identifier">`div`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeInteger</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">span</span><span class="Other">:</span> <a href="timestamp.html#Timespan"><span class="Identifier">Timespan</span></a><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timespan"><span class="Identifier">Timespan</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span></span><span class="Other">.}</span></span></pre></dt>
409+
<dd>
410+
411+
412+
413+
</dd>
414+
<a id="div,Timespan,Timespan"></a>
415+
<dt><pre><span class="Keyword">proc</span> <a href="#div%2CTimespan%2CTimespan"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="timestamp.html#Timespan"><span class="Identifier">Timespan</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
376416
<dd>
377417

378418

@@ -428,14 +468,14 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
428468

429469
</dd>
430470
<a id="systemRealTime"></a>
431-
<dt><pre><span class="Keyword">proc</span> <a href="#systemRealTime"><span class="Identifier">systemRealTime</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimestampException</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
471+
<dt><pre><span class="Keyword">proc</span> <a href="#systemRealTime"><span class="Identifier">systemRealTime</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimestampError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
432472
<dd>
433473

434474
create a timestamp with current system time
435475

436476
</dd>
437477
<a id="initTimestamp"></a>
438-
<dt><pre><span class="Keyword">proc</span> <a href="#initTimestamp"><span class="Identifier">initTimestamp</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimestampException</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
478+
<dt><pre><span class="Keyword">proc</span> <a href="#initTimestamp"><span class="Identifier">initTimestamp</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimestampError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
439479
<dd>
440480

441481

@@ -563,8 +603,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
563603

564604
</dd>
565605
<a id="parseZulu,string"></a>
566-
<dt><pre><span class="Keyword">proc</span> <a href="#parseZulu%2Cstring"><span class="Identifier">parseZulu</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimestampInvalidFormatException</span><span class="Other">,</span>
567-
<span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">TimestampOutOfRangeException</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
606+
<dt><pre><span class="Keyword">proc</span> <a href="#parseZulu%2Cstring"><span class="Identifier">parseZulu</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimestampInvalidFormatError</span><span class="Other">,</span>
607+
<span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">TimestampOutOfRangeError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
568608
<dd>
569609

570610
<p>The following format are supported.</p>
@@ -653,7 +693,22 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
653693
<dt><pre><span class="Keyword">proc</span> <a href="#toTimestamp%2CDateTime"><span class="Identifier">toTimestamp</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">DateTime</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timestamp"><span class="Identifier">Timestamp</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
654694
<dd>
655695

656-
Convert DateTime to Timestamp can use between
696+
Convert DateTime to Timestamp
697+
698+
</dd>
699+
<a id="$,Timespan"></a>
700+
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CTimespan"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="timestamp.html#Timespan"><span class="Identifier">Timespan</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
701+
<dd>
702+
703+
704+
705+
</dd>
706+
<a id="parseTimespan,string"></a>
707+
<dt><pre><span class="Keyword">proc</span> <a href="#parseTimespan%2Cstring"><span class="Identifier">parseTimespan</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="timestamp.html#Timespan"><span class="Identifier">Timespan</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimespanInvalidFormatError</span><span class="Other">]</span><span class="Other">,</span>
708+
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
709+
<dd>
710+
711+
657712

658713
</dd>
659714

@@ -666,7 +721,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
666721
<div class="twelve-columns footer">
667722
<span class="nim-sprite"></span>
668723
<br/>
669-
<small style="color: var(--hint);">Made with Nim. Generated: 2020-05-22 15:19:21 UTC</small>
724+
<small style="color: var(--hint);">Made with Nim. Generated: 2020-06-10 03:04:11 UTC</small>
670725
</div>
671726
</div>
672727
</div>

timestamp.nimble

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Package
22

3-
version = "0.2.3"
3+
version = "0.3.0"
44
author = "Jack Tang"
55
description = "An alternative time library"
66
license = "MIT"

0 commit comments

Comments
 (0)