since.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/private/since</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  14. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/private/since</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <details open>
  51. <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
  52. <ul class="simple simple-toc-section">
  53. <ul class="simple nested-toc-section">since
  54. <li><a class="reference" href="#since.t%2C%2Cuntyped" title="since(version: (int, int); body: untyped)">since(version: (int, int); body: untyped)</a></li>
  55. <li><a class="reference" href="#since.t%2C%2Cuntyped_2" title="since(version: (int, int, int); body: untyped)">since(version: (int, int, int); body: untyped)</a></li>
  56. </ul>
  57. </ul>
  58. </details>
  59. </li>
  60. </ul>
  61. </div>
  62. <div class="nine columns" id="content">
  63. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/since.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  64. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/since.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  65. <div id="tocRoot"></div>
  66. <p class="module-desc"><p><tt class="docutils literal"><span class="pre"><span class="Identifier">since</span></span></tt> is used to emulate older versions of nim stdlib, see <tt class="docutils literal"><span class="pre"><span class="Identifier">tuse_version</span><span class="Operator">.</span><span class="Identifier">nim</span></span></tt>.</p>
  67. <p>If a symbol <tt class="docutils literal"><span class="pre"><span class="Identifier">foo</span></span></tt> is added in version <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">3</span><span class="Punctuation">,</span><span class="DecNumber">5</span><span class="Punctuation">)</span></span></tt>, use <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">since</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="FloatNumber">1.3</span><span class="Operator">.</span><span class="DecNumber">5</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt>, not <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">since</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="FloatNumber">1.4</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt>, so that it works in devel in between releases.</p>
  68. <p>The emulation cannot be 100% faithful and to avoid adding too much complexity, <tt class="docutils literal"><span class="pre"><span class="Identifier">since</span></span></tt> is not needed in those cases:</p>
  69. <ul class="simple"><li>if a new module is added</li>
  70. <li>if an overload is added</li>
  71. <li>if an extra parameter to an existing routine is added</li>
  72. </ul>
  73. </p>
  74. <div class="section" id="18">
  75. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  76. <dl class="item">
  77. <div id="since-templates-all">
  78. <div id="since.t,,untyped">
  79. <dt><pre><span class="Keyword">template</span> <a href="#since.t%2C%2Cuntyped"><span class="Identifier">since</span></a><span class="Other">(</span><span class="Identifier">version</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span> {.<span class="Identifier">dirty</span>.}</pre></dt>
  80. <dd>
  81. <p>Evaluates <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> if the <tt class="docutils literal"><span class="pre">(NimMajor, NimMinor)</span></tt> is greater than or equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">version</span></span></tt>. Usage:</p>
  82. <p><pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">fun</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">since</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Punctuation">}</span>
  83. <span class="Identifier">since</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">fun</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
  84. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/since.nim#L15" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  85. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/since.nim#L15" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  86. </dd>
  87. </div>
  88. <div id="since.t,,untyped_2">
  89. <dt><pre><span class="Keyword">template</span> <a href="#since.t%2C%2Cuntyped_2"><span class="Identifier">since</span></a><span class="Other">(</span><span class="Identifier">version</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span> {.<span class="Identifier">dirty</span>.}</pre></dt>
  90. <dd>
  91. <p>Evaluates <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> if <tt class="docutils literal"><span class="pre">(NimMajor, NimMinor, NimPatch)</span></tt> is greater than or equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">version</span></span></tt>. Usage:</p>
  92. <p><pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">fun</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">since</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Punctuation">}</span>
  93. <span class="Identifier">since</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">fun</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
  94. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/since.nim#L25" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  95. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/since.nim#L25" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  96. </dd>
  97. </div>
  98. </div>
  99. </dl>
  100. </div>
  101. </div>
  102. </div>
  103. <div class="twelve-columns footer">
  104. <span class="nim-sprite"></span>
  105. <br>
  106. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:52 UTC</small>
  107. </div>
  108. </div>
  109. </div>
  110. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  111. </body>
  112. </html>