Головна сторінка Огляд Довідка
Увійти
levovix
/
Nim
дзеркало https://github.com/nim-lang/Nim
Слідкувати 1
Зірка 0
Відгалуження 1
Файли Проблеми 0 Wiki
Гілка: gh-pages
Гілки Теги
Nim
/
typetraits.html

typetraits.html 84 KB
Постійне посилання Історія Запис

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/typetraits</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <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=="/>
    16. 

  16. <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=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/typetraits</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    56. 

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

  59.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    60. 

  60.     <ul class="simple simple-toc-section">
    61. 

  61.       <li><a class="reference" href="#HoleyEnum" title="HoleyEnum = (not Ordinal) and enum">HoleyEnum</a></li>
    62. 

  62. <li><a class="reference" href="#OrdinalEnum" title="OrdinalEnum = Ordinal and enum">OrdinalEnum</a></li>
    63. 

  63. <li><a class="reference" href="#StaticParam" title="StaticParam[value] = object">StaticParam</a></li>
    64. 

  64. 

  65.     </ul>
    66. 

  66.   </details>
    67. 

  67. </li>
    68. 

  68. <li>
    69. 

  69.   <details open>
    70. 

  70.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    71. 

  71.     <ul class="simple simple-toc-section">
    72. 

  72.       <ul class="simple nested-toc-section">arity
    73. 

  73.   <li><a class="reference" href="#arity%2Ctypedesc" title="arity(t: typedesc): int">arity(t: typedesc): int</a></li>
    74. 

  74. 

  75. </ul>
    76. 

  76. <ul class="simple nested-toc-section">distinctBase
    77. 

  77.   <li><a class="reference" href="#distinctBase%2Ctypedesc%2Cstaticbool" title="distinctBase(T: typedesc; recursive: static bool = true): typedesc">distinctBase(T: typedesc; recursive: static bool = true): typedesc</a></li>
    78. 

  78. 

  79. </ul>
    80. 

  80. <ul class="simple nested-toc-section">genericHead
    81. 

  81.   <li><a class="reference" href="#genericHead%2Ctypedesc" title="genericHead(t: typedesc): typedesc">genericHead(t: typedesc): typedesc</a></li>
    82. 

  82. 

  83. </ul>
    84. 

  84. <ul class="simple nested-toc-section">hasClosure
    85. 

  85.   <li><a class="reference" href="#hasClosure%2CNimNode" title="hasClosure(fn: NimNode): bool">hasClosure(fn: NimNode): bool</a></li>
    86. 

  86. 

  87. </ul>
    88. 

  88. <ul class="simple nested-toc-section">hasDefaultValue
    89. 

  89.   <li><a class="reference" href="#hasDefaultValue%2Ctypedesc" title="hasDefaultValue(t: typedesc): bool">hasDefaultValue(t: typedesc): bool</a></li>
    90. 

  90. 

  91. </ul>
    92. 

  92. <ul class="simple nested-toc-section">isNamedTuple
    93. 

  93.   <li><a class="reference" href="#isNamedTuple%2Ctypedesc" title="isNamedTuple(T: typedesc): bool">isNamedTuple(T: typedesc): bool</a></li>
    94. 

  94. 

  95. </ul>
    96. 

  96. <ul class="simple nested-toc-section">name
    97. 

  97.   <li><a class="reference" href="#name%2Ctypedesc" title="name(t: typedesc): string">name(t: typedesc): string</a></li>
    98. 

  98. 

  99. </ul>
    100. 

  100. <ul class="simple nested-toc-section">rangeBase
    101. 

  101.   <li><a class="reference" href="#rangeBase%2Ctypedesc%5Brange%5D" title="rangeBase(T: typedesc[range]): typedesc">rangeBase(T: typedesc[range]): typedesc</a></li>
    102. 

  102. 

  103. </ul>
    104. 

  104. <ul class="simple nested-toc-section">stripGenericParams
    105. 

  105.   <li><a class="reference" href="#stripGenericParams%2Ctypedesc" title="stripGenericParams(t: typedesc): typedesc">stripGenericParams(t: typedesc): typedesc</a></li>
    106. 

  106. 

  107. </ul>
    108. 

  108. <ul class="simple nested-toc-section">supportsCopyMem
    109. 

  109.   <li><a class="reference" href="#supportsCopyMem%2Ctypedesc" title="supportsCopyMem(t: typedesc): bool">supportsCopyMem(t: typedesc): bool</a></li>
    110. 

  110. 

  111. </ul>
    112. 

  112. <ul class="simple nested-toc-section">tupleLen
    113. 

  113.   <li><a class="reference" href="#tupleLen%2Ctypedesc%5B%5D" title="tupleLen(T: typedesc[tuple]): int">tupleLen(T: typedesc[tuple]): int</a></li>
    114. 

  114. 

  115. </ul>
    116. 

  116. 

  117.     </ul>
    118. 

  118.   </details>
    119. 

  119. </li>
    120. 

  120. <li>
    121. 

  121.   <details open>
    122. 

  122.     <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
    123. 

  123.     <ul class="simple simple-toc-section">
    124. 

  124.       <ul class="simple nested-toc-section">enumLen
    125. 

  125.   <li><a class="reference" href="#enumLen.m%2Ctypedesc%5B%5D" title="enumLen(T: typedesc[enum]): int">enumLen(T: typedesc[enum]): int</a></li>
    126. 

  126. 

  127. </ul>
    128. 

  128. 

  129.     </ul>
    130. 

  130.   </details>
    131. 

  131. </li>
    132. 

  132. <li>
    133. 

  133.   <details open>
    134. 

  134.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    135. 

  135.     <ul class="simple simple-toc-section">
    136. 

  136.       <ul class="simple nested-toc-section">distinctBase
    137. 

  137.   <li><a class="reference" href="#distinctBase.t%2CT%2Cstaticbool" title="distinctBase[T](a: T; recursive: static bool = true): untyped">distinctBase[T](a: T; recursive: static bool = true): untyped</a></li>
    138. 

  138. 

  139. </ul>
    140. 

  140. <ul class="simple nested-toc-section">elementType
    141. 

  141.   <li><a class="reference" href="#elementType.t%2Cuntyped" title="elementType(a: untyped): typedesc">elementType(a: untyped): typedesc</a></li>
    142. 

  142. 

  143. </ul>
    144. 

  144. <ul class="simple nested-toc-section">genericParams
    145. 

  145.   <li><a class="reference" href="#genericParams.t%2Ctypedesc" title="genericParams(T: typedesc): untyped">genericParams(T: typedesc): untyped</a></li>
    146. 

  146. 

  147. </ul>
    148. 

  148. <ul class="simple nested-toc-section">get
    149. 

  149.   <li><a class="reference" href="#get.t%2Ctypedesc%5B%5D%2Cstaticint" title="get(T: typedesc[tuple]; i: static int): untyped">get(T: typedesc[tuple]; i: static int): untyped</a></li>
    150. 

  150. 

  151. </ul>
    152. 

  152. <ul class="simple nested-toc-section">pointerBase
    153. 

  153.   <li><a class="reference" href="#pointerBase.t%2Ctypedesc%5B%5D" title="pointerBase[T](_: typedesc[ptr T | ref T]): typedesc">pointerBase[T](_: typedesc[ptr T | ref T]): typedesc</a></li>
    154. 

  154. 

  155. </ul>
    156. 

  156. <ul class="simple nested-toc-section">rangeBase
    157. 

  157.   <li><a class="reference" href="#rangeBase.t%2CT" title="rangeBase[T: range](a: T): untyped">rangeBase[T: range](a: T): untyped</a></li>
    158. 

  158. 

  159. </ul>
    160. 

  160. <ul class="simple nested-toc-section">toSigned
    161. 

  161.   <li><a class="reference" href="#toSigned.t%2Ctypedesc%5B%5D" title="toSigned(T: typedesc[SomeInteger and not range]): untyped">toSigned(T: typedesc[SomeInteger and not range]): untyped</a></li>
    162. 

  162. 

  163. </ul>
    164. 

  164. <ul class="simple nested-toc-section">toUnsigned
    165. 

  165.   <li><a class="reference" href="#toUnsigned.t%2Ctypedesc%5B%5D" title="toUnsigned(T: typedesc[SomeInteger and not range]): untyped">toUnsigned(T: typedesc[SomeInteger and not range]): untyped</a></li>
    166. 

  166. 

  167. </ul>
    168. 

  168. <ul class="simple nested-toc-section">tupleLen
    169. 

  169.   <li><a class="reference" href="#tupleLen.t" title="tupleLen(t: tuple): int">tupleLen(t: tuple): int</a></li>
    170. 

  170. 

  171. </ul>
    172. 

  172. 

  173.     </ul>
    174. 

  174.   </details>
    175. 

  175. </li>
    176. 

  176. 

  177. </ul>
    178. 

  178. 

  179.   </div>
    180. 

  180.   <div class="nine columns" id="content">
    181. 

  181.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    182. 

  182. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    183. 

  183. 

  184.     <div id="tocRoot"></div>
    185. 

  185.     
    186. 

  186.     <p class="module-desc"><p>This module defines compile-time reflection procs for working with types.</p>
    187. 

  187. <p>Unstable API.</p>
    188. 

  188. 

  189. <p><strong class="examples_text">Example:</strong></p>
    190. 

  190. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">typetraits</span>
    191. 

  191. <span class="Keyword">type</span> <span class="Identifier">A</span> <span class="Operator">=</span> <span class="Keyword">enum</span> <span class="Identifier">a0</span> <span class="Operator">=</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">a1</span> <span class="Operator">=</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="Identifier">a2</span>
    192. 

  192. <span class="Keyword">type</span> <span class="Identifier">B</span> <span class="Operator">=</span> <span class="Keyword">enum</span> <span class="Identifier">b0</span> <span class="Operator">=</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">b1</span><span class="Punctuation">,</span> <span class="Identifier">b2</span>
    193. 

  193. <span class="Identifier">assert</span> <span class="Identifier">A</span> <span class="Keyword">is</span> <span class="Keyword">enum</span>
    194. 

  194. <span class="Identifier">assert</span> <span class="Identifier">A</span> <span class="Keyword">is</span> <span class="Identifier">HoleyEnum</span>
    195. 

  195. <span class="Identifier">assert</span> <span class="Identifier">A</span> <span class="Keyword">isnot</span> <span class="Identifier">OrdinalEnum</span>
    196. 

  196. <span class="Identifier">assert</span> <span class="Identifier">B</span> <span class="Keyword">isnot</span> <span class="Identifier">HoleyEnum</span>
    197. 

  197. <span class="Identifier">assert</span> <span class="Identifier">B</span> <span class="Keyword">is</span> <span class="Identifier">OrdinalEnum</span>
    198. 

  198. <span class="Identifier">assert</span> <span class="Identifier">int</span> <span class="Keyword">isnot</span> <span class="Identifier">HoleyEnum</span>
    199. 

  199. <span class="Keyword">type</span> <span class="Identifier">C</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">enum</span> <span class="Identifier">h0</span> <span class="Operator">=</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">h1</span> <span class="Operator">=</span> <span class="DecNumber">4</span>
    200. 

  200. <span class="Identifier">assert</span> <span class="Identifier">C</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span> <span class="Keyword">is</span> <span class="Identifier">HoleyEnum</span></pre></p>
    201. 

  201.     <div class="section" id="6">
    202. 

  202.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    203. 

  203.   <dl class="item">
    204. 

  204.     <a class="reference external" href="since.html">since</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="macros.html">macros</a>
    205. 

  205.   </dl>
    206. 

  206. </div>
    207. 

  207. <div class="section" id="7">
    208. 

  208.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    209. 

  209.   <dl class="item">
    210. 

  210.     <div id="HoleyEnum">
    211. 

  211.   <dt><pre><a href="typetraits.html#HoleyEnum"><span class="Identifier">HoleyEnum</span></a> <span class="Other">=</span> <span class="Other">(</span><span class="Keyword">not</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">)</span> <span class="Keyword">and</span> <span class="Keyword">enum</span></pre></dt>
    212. 

  212.   <dd>
    213. 

  213.     
    214. 

  214.     Enum with holes.
    215. 

  215.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L22" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    216. 

  216. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L22" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    217. 

  217. 

  218.   </dd>
    219. 

  219. </div>
    220. 

  220. <div id="OrdinalEnum">
    221. 

  221.   <dt><pre><a href="typetraits.html#OrdinalEnum"><span class="Identifier">OrdinalEnum</span></a> <span class="Other">=</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Keyword">and</span> <span class="Keyword">enum</span></pre></dt>
    222. 

  222.   <dd>
    223. 

  223.     
    224. 

  224.     Enum without holes.
    225. 

  225.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L23" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    226. 

  226. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L23" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    227. 

  227. 

  228.   </dd>
    229. 

  229. </div>
    230. 

  230. <div id="StaticParam">
    231. 

  231.   <dt><pre><a href="typetraits.html#StaticParam"><span class="Identifier">StaticParam</span></a><span class="Other">[</span><span class="Identifier">value</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
    232. 

  232.   <dd>
    233. 

  233.     
    234. 

  234.     Used to wrap a static value in <a class="reference external" href="#genericParams.t,typedesc">genericParams</a>.
    235. 

  235.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L223" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    236. 

  236. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L223" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    237. 

  237. 

  238.   </dd>
    239. 

  239. </div>
    240. 

  240. 

  241.   </dl>
    242. 

  242. </div>
    243. 

  243. <div class="section" id="12">
    244. 

  244.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    245. 

  245.   <dl class="item">
    246. 

  246.     <div id="arity-procs-all">
    247. 

  247.   <div id="arity,typedesc">
    248. 

  248.   <dt><pre><span class="Keyword">proc</span> <a href="#arity%2Ctypedesc"><span class="Identifier">arity</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    249. 

  249.                                <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    250. 

  250.   <dd>
    251. 

  251.     
    252. 

  252.     Returns the arity of <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt>. This is the number of &quot;type&quot; components or the number of generic parameters a given type <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> has.
    253. 

  253. <p><strong class="examples_text">Example:</strong></p>
    254. 

  254. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">arity</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    255. 

  255. <span class="Identifier">doAssert</span> <span class="Identifier">arity</span><span class="Punctuation">(</span><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    256. 

  256. <span class="Identifier">doAssert</span> <span class="Identifier">arity</span><span class="Punctuation">(</span><span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    257. 

  257. <span class="Identifier">doAssert</span> <span class="Identifier">arity</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">float</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span></pre>
    258. 

  258.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L45" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    259. 

  259. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L45" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    260. 

  260. 

  261.   </dd>
    262. 

  262. </div>
    263. 

  263. 

  264. </div>
    265. 

  265. <div id="distinctBase-procs-all">
    266. 

  266.   <div id="distinctBase,typedesc,staticbool">
    267. 

  267.   <dt><pre><span class="Keyword">proc</span> <a href="#distinctBase%2Ctypedesc%2Cstaticbool"><span class="Identifier">distinctBase</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">recursive</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.
    268. 

  268.     <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    269. 

  269.   <dd>
    270. 

  270.     
    271. 

  271.     <p>Returns the base type for distinct types, or the type itself otherwise. If <tt class="docutils literal"><span class="pre"><span class="Identifier">recursive</span></span></tt> is false, only the immediate distinct base will be returned.</p>
    272. 

  272. <p><strong>See also:</strong></p>
    273. 

  273. <ul class="simple"><li><a class="reference external" href="#distinctBase.t,T,static[bool]">distinctBase template</a></li>
    274. 

  274. </ul>
    275. 

  275. 

  276. <p><strong class="examples_text">Example:</strong></p>
    277. 

  277. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">MyInt</span> <span class="Operator">=</span> <span class="Keyword">distinct</span> <span class="Identifier">int</span>
    278. 

  278. <span class="Keyword">type</span> <span class="Identifier">MyOtherInt</span> <span class="Operator">=</span> <span class="Keyword">distinct</span> <span class="Identifier">MyInt</span>
    279. 

  279. <span class="Identifier">doAssert</span> <span class="Identifier">distinctBase</span><span class="Punctuation">(</span><span class="Identifier">MyInt</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
    280. 

  280. <span class="Identifier">doAssert</span> <span class="Identifier">distinctBase</span><span class="Punctuation">(</span><span class="Identifier">MyOtherInt</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
    281. 

  281. <span class="Identifier">doAssert</span> <span class="Identifier">distinctBase</span><span class="Punctuation">(</span><span class="Identifier">MyOtherInt</span><span class="Punctuation">,</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">MyInt</span>
    282. 

  282. <span class="Identifier">doAssert</span> <span class="Identifier">distinctBase</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span></pre>
    283. 

  283.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L167" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    284. 

  284. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L167" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    285. 

  285. 

  286.   </dd>
    287. 

  287. </div>
    288. 

  288. 

  289. </div>
    290. 

  290. <div id="genericHead-procs-all">
    291. 

  291.   <div id="genericHead,typedesc">
    292. 

  292.   <dt><pre><span class="Keyword">proc</span> <a href="#genericHead%2Ctypedesc"><span class="Identifier">genericHead</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    293. 

  293.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    294. 

  294.   <dd>
    295. 

  295.     
    296. 

  296.     <p>Accepts an instantiated generic type and returns its uninstantiated form. A compile-time error will be produced if the supplied type is not generic.</p>
    297. 

  297. <p><strong>See also:</strong></p>
    298. 

  298. <ul class="simple"><li><a class="reference external" href="#stripGenericParams,typedesc">stripGenericParams proc</a></li>
    299. 

  299. </ul>
    300. 

  300. 

  301. <p><strong class="examples_text">Example:</strong></p>
    302. 

  302. <pre class="listing"><span class="Keyword">type</span>
    303. 

  303.   <span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    304. 

  304.   <span class="Identifier">FooInst</span> <span class="Operator">=</span> <span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span>
    305. 

  305.   <span class="Identifier">Foo2</span> <span class="Operator">=</span> <span class="Identifier">genericHead</span><span class="Punctuation">(</span><span class="Identifier">FooInst</span><span class="Punctuation">)</span>
    306. 

  306. 

  307. <span class="Identifier">doAssert</span> <span class="Identifier">Foo2</span> <span class="Keyword">is</span> <span class="Identifier">Foo</span> <span class="Keyword">and</span> <span class="Identifier">Foo</span> <span class="Keyword">is</span> <span class="Identifier">Foo2</span>
    308. 

  308. <span class="Identifier">doAssert</span> <span class="Identifier">genericHead</span><span class="Punctuation">(</span><span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">Foo</span>
    309. 

  309. <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="Identifier">genericHead</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    310. 

  310. 

  311. <span class="Keyword">type</span> <span class="Identifier">Generic</span> <span class="Operator">=</span> <span class="Keyword">concept</span> <span class="Identifier">f</span>
    312. 

  312.   <span class="Keyword">type</span> <span class="Identifier">_</span> <span class="Operator">=</span> <span class="Identifier">genericHead</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">f</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    313. 

  313. 

  314. <span class="Keyword">proc</span> <span class="Identifier">bar</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">Generic</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">a</span>
    315. 

  315. 

  316. <span class="Identifier">doAssert</span> <span class="Identifier">bar</span><span class="Punctuation">(</span><span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">default</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    317. 

  317. <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span> <span class="Identifier">bar</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Operator">.</span><span class="Identifier">default</span><span class="Punctuation">)</span>
    318. 

  318. 

  319. <span class="Keyword">when</span> <span class="Identifier">false</span><span class="Punctuation">:</span> <span class="Comment"># these don't work yet</span>
    320. 

  320.   <span class="Identifier">doAssert</span> <span class="Identifier">genericHead</span><span class="Punctuation">(</span><span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span> <span class="Keyword">is</span> <span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span>
    321. 

  321.   <span class="Identifier">doAssert</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">genericHead</span> <span class="Keyword">is</span> <span class="Identifier">seq</span></pre>
    322. 

  322.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L54" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    323. 

  323. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L54" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    324. 

  324. 

  325.   </dd>
    326. 

  326. </div>
    327. 

  327. 

  328. </div>
    329. 

  329. <div id="hasClosure-procs-all">
    330. 

  330.   <div id="hasClosure,NimNode">
    331. 

  331.   <dt><pre><span class="Keyword">proc</span> <a href="#hasClosure%2CNimNode"><span class="Identifier">hasClosure</span></a><span class="Other">(</span><span class="Identifier">fn</span><span class="Other">:</span> <a href="system.html#NimNode"><span class="Identifier">NimNode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    332. 

  332.   <dd>
    333. 

  333.     
    334. 

  334.     Returns true if the func/proc/etc <tt class="docutils literal"><span class="pre"><span class="Identifier">fn</span></span></tt> has <tt class="docutils literal"><span class="pre"><span class="Identifier">closure</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">fn</span></span></tt> has to be a resolved symbol of kind <tt class="docutils literal"><span class="pre"><span class="Identifier">nnkSym</span></span></tt>. This implies that the macro that calls this proc should accept <tt class="docutils literal"><span class="pre"><span class="Identifier">typed</span></span></tt> arguments and not <tt class="docutils literal"><span class="pre"><span class="Identifier">untyped</span></span></tt> arguments.
    335. 

  335.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    336. 

  336. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    337. 

  337. 

  338.   </dd>
    339. 

  339. </div>
    340. 

  340. 

  341. </div>
    342. 

  342. <div id="hasDefaultValue-procs-all">
    343. 

  343.   <div id="hasDefaultValue,typedesc">
    344. 

  344.   <dt><pre><span class="Keyword">proc</span> <a href="#hasDefaultValue%2Ctypedesc"><span class="Identifier">hasDefaultValue</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    345. 

  345.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    346. 

  346.   <dd>
    347. 

  347.     
    348. 

  348.     Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> has a valid default value.
    349. 

  349. <p><strong class="examples_text">Example:</strong></p>
    350. 

  350. <pre class="listing"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">experimental</span><span class="Punctuation">:</span> <span class="StringLit">&quot;strictNotNil&quot;</span><span class="Operator">.</span><span class="Punctuation">}</span>
    351. 

  351. <span class="Keyword">type</span>
    352. 

  352.   <span class="Identifier">NilableObject</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
    353. 

  353.     <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    354. 

  354.   <span class="Keyword">Object</span> <span class="Operator">=</span> <span class="Identifier">NilableObject</span> <span class="Keyword">not</span> <span class="Keyword">nil</span>
    355. 

  355.   <span class="Identifier">RequiresInit</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    356. 

  356.     <span class="Identifier">a</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">requiresInit</span><span class="Operator">.</span><span class="Punctuation">}</span><span class="Punctuation">:</span> <span class="Identifier">T</span>
    357. 

  357. 

  358. <span class="Identifier">assert</span> <span class="Identifier">hasDefaultValue</span><span class="Punctuation">(</span><span class="Identifier">NilableObject</span><span class="Punctuation">)</span>
    359. 

  359. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">hasDefaultValue</span><span class="Punctuation">(</span><span class="Keyword">Object</span><span class="Punctuation">)</span>
    360. 

  360. <span class="Identifier">assert</span> <span class="Identifier">hasDefaultValue</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span>
    361. 

  361. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">hasDefaultValue</span><span class="Punctuation">(</span><span class="Keyword">var</span> <span class="Identifier">string</span><span class="Punctuation">)</span>
    362. 

  362. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">hasDefaultValue</span><span class="Punctuation">(</span><span class="Identifier">RequiresInit</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    363. 

  363.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L99" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    364. 

  364. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L99" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    365. 

  365. 

  366.   </dd>
    367. 

  367. </div>
    368. 

  368. 

  369. </div>
    370. 

  370. <div id="isNamedTuple-procs-all">
    371. 

  371.   <div id="isNamedTuple,typedesc">
    372. 

  372.   <dt><pre><span class="Keyword">proc</span> <a href="#isNamedTuple%2Ctypedesc"><span class="Identifier">isNamedTuple</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    373. 

  373.                                        <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    374. 

  374.   <dd>
    375. 

  375.     
    376. 

  376.     Returns true for named tuples, false for any other type.
    377. 

  377. <p><strong class="examples_text">Example:</strong></p>
    378. 

  378. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">isNamedTuple</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span>
    379. 

  379. <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">isNamedTuple</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    380. 

  380. <span class="Identifier">doAssert</span> <span class="Identifier">isNamedTuple</span><span class="Punctuation">(</span><span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">name</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">age</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    381. 

  381.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L116" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    382. 

  382. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L116" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    383. 

  383. 

  384.   </dd>
    385. 

  385. </div>
    386. 

  386. 

  387. </div>
    388. 

  388. <div id="name-procs-all">
    389. 

  389.   <div id="name,typedesc">
    390. 

  390.   <dt><pre><span class="Keyword">proc</span> <a href="#name%2Ctypedesc"><span class="Identifier">name</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    391. 

  391.                                  <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    392. 

  392.   <dd>
    393. 

  393.     
    394. 

  394.     <p>Returns the name of <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt>.</p>
    395. 

  395. <p>Alias for <a class="reference external" href="dollars.html#$,typedesc">system.`$`(t)</a> since Nim v0.20.</p>
    396. 

  396. 

  397. <p><strong class="examples_text">Example:</strong></p>
    398. 

  398. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">name</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;int&quot;</span>
    399. 

  399. <span class="Identifier">doAssert</span> <span class="Identifier">name</span><span class="Punctuation">(</span><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;seq[string]&quot;</span></pre>
    400. 

  400.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L37" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    401. 

  401. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L37" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    402. 

  402. 

  403.   </dd>
    404. 

  404. </div>
    405. 

  405. 

  406. </div>
    407. 

  407. <div id="rangeBase-procs-all">
    408. 

  408.   <div id="rangeBase,typedesc[range]">
    409. 

  409.   <dt><pre><span class="Keyword">proc</span> <a href="#rangeBase%2Ctypedesc%5Brange%5D"><span class="Identifier">rangeBase</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    410. 

  410.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    411. 

  411.   <dd>
    412. 

  412.     
    413. 

  413.     <p>Returns the base type for range types, or the type itself otherwise.</p>
    414. 

  414. <p><strong>See also:</strong></p>
    415. 

  415. <ul class="simple"><li><a class="reference external" href="#rangeBase.t,T">rangeBase template</a></li>
    416. 

  416. </ul>
    417. 

  417. 

  418. <p><strong class="examples_text">Example:</strong></p>
    419. 

  419. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">MyRange</span> <span class="Operator">=</span> <span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">5</span><span class="Punctuation">]</span>
    420. 

  420. <span class="Keyword">type</span> <span class="Identifier">MyEnum</span> <span class="Operator">=</span> <span class="Keyword">enum</span> <span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">,</span> <span class="Identifier">c</span>
    421. 

  421. <span class="Keyword">type</span> <span class="Identifier">MyEnumRange</span> <span class="Operator">=</span> <span class="Identifier">range</span><span class="Punctuation">[</span><span class="Identifier">b</span><span class="Operator">..</span><span class="Identifier">c</span><span class="Punctuation">]</span>
    422. 

  422. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">MyRange</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
    423. 

  423. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">MyEnumRange</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">MyEnum</span>
    424. 

  424. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">z</span><span class="CharLit">']) is char</span></pre>
    425. 

  425.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L133" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    426. 

  426. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L133" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    427. 

  427. 

  428.   </dd>
    429. 

  429. </div>
    430. 

  430. 

  431. </div>
    432. 

  432. <div id="stripGenericParams-procs-all">
    433. 

  433.   <div id="stripGenericParams,typedesc">
    434. 

  434.   <dt><pre><span class="Keyword">proc</span> <a href="#stripGenericParams%2Ctypedesc"><span class="Identifier">stripGenericParams</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    435. 

  435.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    436. 

  436.   <dd>
    437. 

  437.     
    438. 

  438.     This trait is similar to <a class="reference external" href="#genericHead,typedesc">genericHead</a>, but instead of producing an error for non-generic types, it will just return them unmodified.
    439. 

  439. <p><strong class="examples_text">Example:</strong></p>
    440. 

  440. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    441. 

  441. 

  442. <span class="Identifier">doAssert</span> <span class="Identifier">stripGenericParams</span><span class="Punctuation">(</span><span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">Foo</span>
    443. 

  443. <span class="Identifier">doAssert</span> <span class="Identifier">stripGenericParams</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span></pre>
    444. 

  444.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L84" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    445. 

  445. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L84" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    446. 

  446. 

  447.   </dd>
    448. 

  448. </div>
    449. 

  449. 

  450. </div>
    451. 

  451. <div id="supportsCopyMem-procs-all">
    452. 

  452.   <div id="supportsCopyMem,typedesc">
    453. 

  453.   <dt><pre><span class="Keyword">proc</span> <a href="#supportsCopyMem%2Ctypedesc"><span class="Identifier">supportsCopyMem</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    454. 

  454.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    455. 

  455.   <dd>
    456. 

  456.     
    457. 

  457.     <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> is safe to use for <span id="copymem_1">copyMem</span>.</p>
    458. 

  458. <p>Other languages name a type like these <span id="blob_1">blob</span>.</p>
    459. 

  459. 

  460.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L94" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    461. 

  461. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L94" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    462. 

  462. 

  463.   </dd>
    464. 

  464. </div>
    465. 

  465. 

  466. </div>
    467. 

  467. <div id="tupleLen-procs-all">
    468. 

  468.   <div id="tupleLen,typedesc[]">
    469. 

  469.   <dt><pre><span class="Keyword">proc</span> <a href="#tupleLen%2Ctypedesc%5B%5D"><span class="Identifier">tupleLen</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;TypeTrait&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    470. 

  470.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    471. 

  471.   <dd>
    472. 

  472.     
    473. 

  473.     <p>Returns the number of elements of the tuple type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.</p>
    474. 

  474. <p><strong>See also:</strong></p>
    475. 

  475. <ul class="simple"><li><a class="reference external" href="#tupleLen.t">tupleLen template</a></li>
    476. 

  476. </ul>
    477. 

  477. 

  478. <p><strong class="examples_text">Example:</strong></p>
    479. 

  479. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">tupleLen</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">float</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    480. 

  480. <span class="Identifier">doAssert</span> <span class="Identifier">tupleLen</span><span class="Punctuation">(</span><span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">name</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">age</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    481. 

  481.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L196" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    482. 

  482. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L196" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    483. 

  483. 

  484.   </dd>
    485. 

  485. </div>
    486. 

  486. 

  487. </div>
    488. 

  488. 

  489.   </dl>
    490. 

  490. </div>
    491. 

  491. <div class="section" id="17">
    492. 

  492.   <h1><a class="toc-backref" href="#17">Macros</a></h1>
    493. 

  493.   <dl class="item">
    494. 

  494.     <div id="enumLen-macros-all">
    495. 

  495.   <div id="enumLen.m,typedesc[]">
    496. 

  496.   <dt><pre><span class="Keyword">macro</span> <a href="#enumLen.m%2Ctypedesc%5B%5D"><span class="Identifier">enumLen</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Keyword">enum</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
    497. 

  497.   <dd>
    498. 

  498.     
    499. 

  499.     Returns the number of items in the enum <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.
    500. 

  500. <p><strong class="examples_text">Example:</strong></p>
    501. 

  501. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Foo</span> <span class="Operator">=</span> <span class="Keyword">enum</span>
    502. 

  502.   <span class="Identifier">fooItem1</span>
    503. 

  503.   <span class="Identifier">fooItem2</span>
    504. 

  504. 

  505. <span class="Identifier">doAssert</span> <span class="Identifier">Foo</span><span class="Operator">.</span><span class="Identifier">enumLen</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    506. 

  506.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L243" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    507. 

  507. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L243" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    508. 

  508. 

  509.   </dd>
    510. 

  510. </div>
    511. 

  511. 

  512. </div>
    513. 

  513. 

  514.   </dl>
    515. 

  515. </div>
    516. 

  516. <div class="section" id="18">
    517. 

  517.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    518. 

  518.   <dl class="item">
    519. 

  519.     <div id="distinctBase-templates-all">
    520. 

  520.   <div id="distinctBase.t,T,staticbool">
    521. 

  521.   <dt><pre><span class="Keyword">template</span> <a href="#distinctBase.t%2CT%2Cstaticbool"><span class="Identifier">distinctBase</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">recursive</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    522. 

  522.   <dd>
    523. 

  523.     
    524. 

  524.     Overload of <a class="reference external" href="#distinctBase,typedesc,static[bool]">distinctBase</a> for values.
    525. 

  525. <p><strong class="examples_text">Example:</strong></p>
    526. 

  526. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">MyInt</span> <span class="Operator">=</span> <span class="Keyword">distinct</span> <span class="Identifier">int</span>
    527. 

  527. <span class="Keyword">type</span> <span class="Identifier">MyOtherInt</span> <span class="Operator">=</span> <span class="Keyword">distinct</span> <span class="Identifier">MyInt</span>
    528. 

  528. <span class="Identifier">doAssert</span> <span class="FloatNumber">12.</span><span class="Identifier">MyInt</span><span class="Operator">.</span><span class="Identifier">distinctBase</span> <span class="Operator">==</span> <span class="DecNumber">12</span>
    529. 

  529. <span class="Identifier">doAssert</span> <span class="FloatNumber">12.</span><span class="Identifier">MyOtherInt</span><span class="Operator">.</span><span class="Identifier">distinctBase</span> <span class="Operator">==</span> <span class="DecNumber">12</span>
    530. 

  530. <span class="Identifier">doAssert</span> <span class="FloatNumber">12.</span><span class="Identifier">MyOtherInt</span><span class="Operator">.</span><span class="Identifier">distinctBase</span><span class="Punctuation">(</span><span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">MyInt</span>
    531. 

  531. <span class="Identifier">doAssert</span> <span class="FloatNumber">12.</span><span class="Identifier">distinctBase</span> <span class="Operator">==</span> <span class="DecNumber">12</span></pre>
    532. 

  532.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L182" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    533. 

  533. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L182" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    534. 

  534. 

  535.   </dd>
    536. 

  536. </div>
    537. 

  537. 

  538. </div>
    539. 

  539. <div id="elementType-templates-all">
    540. 

  540.   <div id="elementType.t,untyped">
    541. 

  541.   <dt><pre><span class="Keyword">template</span> <a href="#elementType.t%2Cuntyped"><span class="Identifier">elementType</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a></pre></dt>
    542. 

  542.   <dd>
    543. 

  543.     
    544. 

  544.     Returns the element type of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>, which can be any iterable (over which you can iterate).
    545. 

  545. <p><strong class="examples_text">Example:</strong></p>
    546. 

  546. <pre class="listing"><span class="Keyword">iterator</span> <span class="Identifier">myiter</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">auto</span> <span class="Operator">=</span>
    547. 

  547.   <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="DecNumber">0</span> <span class="Operator">..&lt;</span> <span class="Identifier">n</span><span class="Punctuation">:</span>
    548. 

  548.     <span class="Keyword">yield</span> <span class="Identifier">i</span>
    549. 

  549. 

  550. <span class="Identifier">doAssert</span> <span class="Identifier">elementType</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
    551. 

  551. <span class="Identifier">doAssert</span> <span class="Identifier">elementType</span><span class="Punctuation">(</span><span class="StringLit">&quot;asdf&quot;</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">char</span>
    552. 

  552. <span class="Identifier">doAssert</span> <span class="Identifier">elementType</span><span class="Punctuation">(</span><span class="Identifier">myiter</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span></pre>
    553. 

  553.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L227" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    554. 

  554. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L227" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    555. 

  555. 

  556.   </dd>
    557. 

  557. </div>
    558. 

  558. 

  559. </div>
    560. 

  560. <div id="genericParams-templates-all">
    561. 

  561.   <div id="genericParams.t,typedesc">
    562. 

  562.   <dt><pre><span class="Keyword">template</span> <a href="#genericParams.t%2Ctypedesc"><span class="Identifier">genericParams</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    563. 

  563.   <dd>
    564. 

  564.     
    565. 

  565.     <p>Returns the tuple of generic parameters for the generic type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.</p>
    566. 

  566. <p><strong>Note:</strong> For the builtin array type, the index generic parameter will <strong>always</strong> become a range type after it's bound to a variable.</p>
    567. 

  567. 

  568. <p><strong class="examples_text">Example:</strong></p>
    569. 

  569. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">T1</span><span class="Punctuation">,</span> <span class="Identifier">T2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    570. 

  570. 

  571. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">Foo</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Punctuation">(</span><span class="Identifier">float</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">)</span>
    572. 

  572. 

  573. <span class="Keyword">type</span> <span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="Identifier">N</span><span class="Punctuation">:</span> <span class="Keyword">static</span> <span class="Identifier">float</span><span class="Punctuation">,</span> <span class="Identifier">T</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    574. 

  574. 

  575. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Punctuation">(</span><span class="Identifier">StaticParam</span><span class="Punctuation">[</span><span class="FloatNumber">1.0</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">)</span>
    576. 

  576. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">value</span> <span class="Operator">==</span> <span class="FloatNumber">1.0</span>
    577. 

  577. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="FloatNumber">2.0</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="FloatNumber">2.0</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span>
    578. 

  578. <span class="Keyword">var</span> <span class="Identifier">s</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="FloatNumber">3.0</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">]</span>
    579. 

  579. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Punctuation">(</span><span class="Identifier">Bar</span><span class="Punctuation">[</span><span class="FloatNumber">3.0</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">,</span><span class="Punctuation">)</span>
    580. 

  580. 

  581. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Punctuation">(</span><span class="Identifier">StaticParam</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">)</span>
    582. 

  582. <span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span>
    583. 

  583. <span class="Identifier">doAssert</span> <span class="Identifier">genericParams</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Punctuation">(</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">9</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">)</span></pre>
    584. 

  584.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L313" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    585. 

  585. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L313" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    586. 

  586. 

  587.   </dd>
    588. 

  588. </div>
    589. 

  589. 

  590. </div>
    591. 

  591. <div id="get-templates-all">
    592. 

  592.   <div id="get.t,typedesc[],staticint">
    593. 

  593.   <dt><pre><span class="Keyword">template</span> <a href="#get.t%2Ctypedesc%5B%5D%2Cstaticint"><span class="Identifier">get</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    594. 

  594.   <dd>
    595. 

  595.     
    596. 

  596.     Returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt>-th element of <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.
    597. 

  597. <p><strong class="examples_text">Example:</strong></p>
    598. 

  598. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">get</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">float</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">float</span></pre>
    599. 

  599.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L215" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    600. 

  600. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L215" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    601. 

  601. 

  602.   </dd>
    603. 

  603. </div>
    604. 

  604. 

  605. </div>
    606. 

  606. <div id="pointerBase-templates-all">
    607. 

  607.   <div id="pointerBase.t,typedesc[]">
    608. 

  608.   <dt><pre><span class="Keyword">template</span> <a href="#pointerBase.t%2Ctypedesc%5B%5D"><span class="Identifier">pointerBase</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Keyword">ptr</span> <span class="Identifier">T</span> <span class="Operator">|</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a></pre></dt>
    609. 

  609.   <dd>
    610. 

  610.     
    611. 

  611.     Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> for <tt class="docutils literal"><span class="pre"><span class="Keyword">ref</span> <span class="Identifier">T</span> <span class="Operator">|</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span></span></tt>.
    612. 

  612. <p><strong class="examples_text">Example:</strong></p>
    613. 

  613. <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Keyword">ref</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">pointerBase</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
    614. 

  614. <span class="Keyword">type</span> <span class="Identifier">A</span> <span class="Operator">=</span> <span class="Keyword">ptr</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span>
    615. 

  615. <span class="Identifier">assert</span> <span class="Identifier">A</span><span class="Operator">.</span><span class="Identifier">pointerBase</span> <span class="Keyword">is</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span>
    616. 

  616. <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Keyword">ref</span> <span class="Identifier">A</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">pointerBase</span> <span class="Keyword">is</span> <span class="Identifier">A</span> <span class="Comment"># not seq[float]</span>
    617. 

  617. <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">;</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Keyword">addr</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">typeof</span><span class="Operator">.</span><span class="Identifier">pointerBase</span> <span class="Keyword">is</span> <span class="Identifier">char</span></pre>
    618. 

  618.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L123" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    619. 

  619. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L123" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    620. 

  620. 

  621.   </dd>
    622. 

  622. </div>
    623. 

  623. 

  624. </div>
    625. 

  625. <div id="rangeBase-templates-all">
    626. 

  626.   <div id="rangeBase.t,T">
    627. 

  627.   <dt><pre><span class="Keyword">template</span> <a href="#rangeBase.t%2CT"><span class="Identifier">rangeBase</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    628. 

  628.   <dd>
    629. 

  629.     
    630. 

  630.     Overload of <a class="reference external" href="#rangeBase,typedesc,static[bool]">rangeBase</a> for values.
    631. 

  631. <p><strong class="examples_text">Example:</strong></p>
    632. 

  632. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">MyRange</span> <span class="Operator">=</span> <span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">5</span><span class="Punctuation">]</span>
    633. 

  633. <span class="Keyword">type</span> <span class="Identifier">MyEnum</span> <span class="Operator">=</span> <span class="Keyword">enum</span> <span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">,</span> <span class="Identifier">c</span>
    634. 

  634. <span class="Keyword">type</span> <span class="Identifier">MyEnumRange</span> <span class="Operator">=</span> <span class="Identifier">range</span><span class="Punctuation">[</span><span class="Identifier">b</span><span class="Operator">..</span><span class="Identifier">c</span><span class="Punctuation">]</span>
    635. 

  635. <span class="Keyword">let</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">MyRange</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
    636. 

  636. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
    637. 

  637. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;int&quot;</span>
    638. 

  638. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    639. 

  639. <span class="Keyword">let</span> <span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">set</span><span class="Punctuation">[</span><span class="Identifier">MyEnumRange</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Identifier">c</span><span class="Punctuation">}</span>
    640. 

  640. <span class="Keyword">for</span> <span class="Identifier">e</span> <span class="Keyword">in</span> <span class="Identifier">y</span><span class="Punctuation">:</span>
    641. 

  641.   <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">e</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">MyEnum</span>
    642. 

  642.   <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">e</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;MyEnum&quot;</span>
    643. 

  643.   <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">e</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">c</span>
    644. 

  644. <span class="Keyword">let</span> <span class="Identifier">z</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">z</span><span class="CharLit">']] = @['</span><span class="Identifier">c</span><span class="CharLit">']</span>
    645. 

  645. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">char</span>
    646. 

  646. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;char&quot;</span>
    647. 

  647. <span class="Identifier">doAssert</span> <span class="Identifier">rangeBase</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'c'</span></pre>
    648. 

  648.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L146" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    649. 

  649. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L146" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    650. 

  650. 

  651.   </dd>
    652. 

  652. </div>
    653. 

  653. 

  654. </div>
    655. 

  655. <div id="toSigned-templates-all">
    656. 

  656.   <div id="toSigned.t,typedesc[]">
    657. 

  657.   <dt><pre><span class="Keyword">template</span> <a href="#toSigned.t%2Ctypedesc%5B%5D"><span class="Identifier">toSigned</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a> <span class="Keyword">and</span> <span class="Keyword">not</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    658. 

  658.   <dd>
    659. 

  659.     
    660. 

  660.     Returns a signed type with same bit size as <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.
    661. 

  661. <p><strong class="examples_text">Example:</strong></p>
    662. 

  662. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">int8</span><span class="Operator">.</span><span class="Identifier">toSigned</span> <span class="Keyword">is</span> <span class="Identifier">int8</span>
    663. 

  663. <span class="Identifier">assert</span> <span class="Identifier">uint16</span><span class="Operator">.</span><span class="Identifier">toSigned</span> <span class="Keyword">is</span> <span class="Identifier">int16</span>
    664. 

  664. <span class="Comment"># range types are currently unsupported:</span>
    665. 

  665. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="Identifier">toSigned</span><span class="Punctuation">(</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
    666. 

  666.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L364" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    667. 

  667. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L364" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    668. 

  668. 

  669.   </dd>
    670. 

  670. </div>
    671. 

  671. 

  672. </div>
    673. 

  673. <div id="toUnsigned-templates-all">
    674. 

  674.   <div id="toUnsigned.t,typedesc[]">
    675. 

  675.   <dt><pre><span class="Keyword">template</span> <a href="#toUnsigned.t%2Ctypedesc%5B%5D"><span class="Identifier">toUnsigned</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a> <span class="Keyword">and</span> <span class="Keyword">not</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    676. 

  676.   <dd>
    677. 

  677.     
    678. 

  678.     Returns an unsigned type with same bit size as <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.
    679. 

  679. <p><strong class="examples_text">Example:</strong></p>
    680. 

  680. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">int8</span><span class="Operator">.</span><span class="Identifier">toUnsigned</span> <span class="Keyword">is</span> <span class="Identifier">uint8</span>
    681. 

  681. <span class="Identifier">assert</span> <span class="Identifier">uint</span><span class="Operator">.</span><span class="Identifier">toUnsigned</span> <span class="Keyword">is</span> <span class="Identifier">uint</span>
    682. 

  682. <span class="Identifier">assert</span> <span class="Identifier">int</span><span class="Operator">.</span><span class="Identifier">toUnsigned</span> <span class="Keyword">is</span> <span class="Identifier">uint</span>
    683. 

  683. <span class="Comment"># range types are currently unsupported:</span>
    684. 

  684. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="Identifier">toUnsigned</span><span class="Punctuation">(</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
    685. 

  685.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L349" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    686. 

  686. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L349" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    687. 

  687. 

  688.   </dd>
    689. 

  689. </div>
    690. 

  690. 

  691. </div>
    692. 

  692. <div id="tupleLen-templates-all">
    693. 

  693.   <div id="tupleLen.t">
    694. 

  694.   <dt><pre><span class="Keyword">template</span> <a href="#tupleLen.t"><span class="Identifier">tupleLen</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
    695. 

  695.   <dd>
    696. 

  696.     
    697. 

  697.     <p>Returns the number of elements of the tuple <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt>.</p>
    698. 

  698. <p><strong>See also:</strong></p>
    699. 

  699. <ul class="simple"><li><a class="reference external" href="#tupleLen,typedesc">tupleLen proc</a></li>
    700. 

  700. </ul>
    701. 

  701. 

  702. <p><strong class="examples_text">Example:</strong></p>
    703. 

  703. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">tupleLen</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    704. 

  704.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/typetraits.nim#L205" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    705. 

  705. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/typetraits.nim#L205" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    706. 

  706. 

  707.   </dd>
    708. 

  708. </div>
    709. 

  709. 

  710. </div>
    711. 

  711. 

  712.   </dl>
    713. 

  713. </div>
    714. 

  714. 

  715.   </div>
    716. 

  716. </div>
    717. 

  717. 

  718.       <div class="twelve-columns footer">
    719. 

  719.         <span class="nim-sprite"></span>
    720. 

  720.         <br>
    721. 

  721.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:04 UTC</small>
    722. 

  722.       </div>
    723. 

  723.     </div>
    724. 

  724.   </div>
    725. 

  725.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    726. 

  726.     
    727. 

  727. </body>
    728. 

  728. </html>
    729. 

  729.