首頁 探索 說明
登入
levovix
/
Nim
镜像来自 https://github.com/nim-lang/Nim
關註 1
讚好 0
複刻 1
Files 問題管理 0 Wiki
分支: gh-pages
分支列表 標籤列表
Nim
/
iterators.html

iterators.html 73 KB
永久連結 文件歷史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523 
  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>system/iterators</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">system/iterators</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="#15" id="65">Iterators</a></summary>
    60. 

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

  61.       <ul class="simple nested-toc-section">fieldPairs
    62. 

  62.   <li><a class="reference" href="#fieldPairs.i%2CS%2CT" title="fieldPairs[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
    63. 

  63.     a, b: RootObj]">fieldPairs[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
    64. 

  64.     a, b: RootObj]</a></li>
    65. 

  65. <li><a class="reference" href="#fieldPairs.i%2CT" title="fieldPairs[T: tuple | object](x: T): tuple[key: string, val: RootObj]">fieldPairs[T: tuple | object](x: T): tuple[key: string, val: RootObj]</a></li>
    66. 

  66. 

  67. </ul>
    68. 

  68. <ul class="simple nested-toc-section">fields
    69. 

  69.   <li><a class="reference" href="#fields.i%2CS%2CT" title="fields[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
    70. 

  70.     val: RootObj]">fields[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
    71. 

  71.     val: RootObj]</a></li>
    72. 

  72. <li><a class="reference" href="#fields.i%2CT" title="fields[T: tuple | object](x: T): RootObj">fields[T: tuple | object](x: T): RootObj</a></li>
    73. 

  73. 

  74. </ul>
    75. 

  75. <ul class="simple nested-toc-section">items
    76. 

  76.   <li><a class="reference" href="#items.i%2Ccstring" title="items(a: cstring): char">items(a: cstring): char</a></li>
    77. 

  77. <li><a class="reference" href="#items.i%2Cstring" title="items(a: string): char">items(a: string): char</a></li>
    78. 

  78. <li><a class="reference" href="#items.i%2Carray%5BIX%2CT%5D" title="items[IX, T](a: array[IX, T]): T">items[IX, T](a: array[IX, T]): T</a></li>
    79. 

  79. <li><a class="reference" href="#items.i%2CopenArray%5BT%5D_2" title="items[T: char](a: openArray[T]): T">items[T: char](a: openArray[T]): T</a></li>
    80. 

  80. <li><a class="reference" href="#items.i%2Ctypedesc%5BT%5D" title="items[T: enum and Ordinal](E: typedesc[T]): T">items[T: enum and Ordinal](E: typedesc[T]): T</a></li>
    81. 

  81. <li><a class="reference" href="#items.i%2CopenArray%5BT%5D" title="items[T: not char](a: openArray[T]): lent2 T">items[T: not char](a: openArray[T]): lent2 T</a></li>
    82. 

  82. <li><a class="reference" href="#items.i%2CSlice%5BT%3A%20Ordinal%5D" title="items[T: Ordinal](s: Slice[T]): T">items[T: Ordinal](s: Slice[T]): T</a></li>
    83. 

  83. <li><a class="reference" href="#items.i%2Cseq%5BT%5D" title="items[T](a: seq[T]): lent2 T">items[T](a: seq[T]): lent2 T</a></li>
    84. 

  84. <li><a class="reference" href="#items.i%2Cset%5BT%5D" title="items[T](a: set[T]): T">items[T](a: set[T]): T</a></li>
    85. 

  85. 

  86. </ul>
    87. 

  87. <ul class="simple nested-toc-section">mitems
    88. 

  88.   <li><a class="reference" href="#mitems.i%2Ccstring" title="mitems(a: var cstring): var char">mitems(a: var cstring): var char</a></li>
    89. 

  89. <li><a class="reference" href="#mitems.i%2Cstring" title="mitems(a: var string): var char">mitems(a: var string): var char</a></li>
    90. 

  90. <li><a class="reference" href="#mitems.i%2Carray%5BIX%2CT%5D" title="mitems[IX, T](a: var array[IX, T]): var T">mitems[IX, T](a: var array[IX, T]): var T</a></li>
    91. 

  91. <li><a class="reference" href="#mitems.i%2CopenArray%5BT%5D" title="mitems[T](a: var openArray[T]): var T">mitems[T](a: var openArray[T]): var T</a></li>
    92. 

  92. <li><a class="reference" href="#mitems.i%2Cseq%5BT%5D" title="mitems[T](a: var seq[T]): var T">mitems[T](a: var seq[T]): var T</a></li>
    93. 

  93. 

  94. </ul>
    95. 

  95. <ul class="simple nested-toc-section">mpairs
    96. 

  96.   <li><a class="reference" href="#mpairs.i%2Ccstring" title="mpairs(a: var cstring): tuple[key: int, val: var char]">mpairs(a: var cstring): tuple[key: int, val: var char]</a></li>
    97. 

  97. <li><a class="reference" href="#mpairs.i%2Cstring" title="mpairs(a: var string): tuple[key: int, val: var char]">mpairs(a: var string): tuple[key: int, val: var char]</a></li>
    98. 

  98. <li><a class="reference" href="#mpairs.i%2Carray%5BIX%2CT%5D" title="mpairs[IX, T](a: var array[IX, T]): tuple[key: IX, val: var T]">mpairs[IX, T](a: var array[IX, T]): tuple[key: IX, val: var T]</a></li>
    99. 

  99. <li><a class="reference" href="#mpairs.i%2CopenArray%5BT%5D" title="mpairs[T](a: var openArray[T]): tuple[key: int, val: var T]">mpairs[T](a: var openArray[T]): tuple[key: int, val: var T]</a></li>
    100. 

  100. <li><a class="reference" href="#mpairs.i%2Cseq%5BT%5D" title="mpairs[T](a: var seq[T]): tuple[key: int, val: var T]">mpairs[T](a: var seq[T]): tuple[key: int, val: var T]</a></li>
    101. 

  101. 

  102. </ul>
    103. 

  103. <ul class="simple nested-toc-section">pairs
    104. 

  104.   <li><a class="reference" href="#pairs.i%2Ccstring" title="pairs(a: cstring): tuple[key: int, val: char]">pairs(a: cstring): tuple[key: int, val: char]</a></li>
    105. 

  105. <li><a class="reference" href="#pairs.i%2Cstring" title="pairs(a: string): tuple[key: int, val: char]">pairs(a: string): tuple[key: int, val: char]</a></li>
    106. 

  106. <li><a class="reference" href="#pairs.i%2Carray%5BIX%2CT%5D" title="pairs[IX, T](a: array[IX, T]): tuple[key: IX, val: T]">pairs[IX, T](a: array[IX, T]): tuple[key: IX, val: T]</a></li>
    107. 

  107. <li><a class="reference" href="#pairs.i%2CopenArray%5BT%5D" title="pairs[T](a: openArray[T]): tuple[key: int, val: T]">pairs[T](a: openArray[T]): tuple[key: int, val: T]</a></li>
    108. 

  108. <li><a class="reference" href="#pairs.i%2Cseq%5BT%5D" title="pairs[T](a: seq[T]): tuple[key: int, val: T]">pairs[T](a: seq[T]): tuple[key: int, val: T]</a></li>
    109. 

  109. 

  110. </ul>
    111. 

  111. 

  112.     </ul>
    113. 

  113.   </details>
    114. 

  114. </li>
    115. 

  115. 

  116. </ul>
    117. 

  117. 

  118.   </div>
    119. 

  119.   <div class="nine columns" id="content">
    120. 

  120.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    121. 

  121. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    122. 

  122. 

  123.     <div id="tocRoot"></div>
    124. 

  124.     
    125. 

  125.     <p class="module-desc">Default iterators for some Nim types.</p>
    126. 

  126.     <div class="section" id="6">
    127. 

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

  128.   <dl class="item">
    129. 

  129.     <a class="reference external" href="assertions.html">assertions</a>
    130. 

  130.   </dl>
    131. 

  131. </div>
    132. 

  132. <div class="section" id="15">
    133. 

  133.   <h1><a class="toc-backref" href="#15">Iterators</a></h1>
    134. 

  134.   <dl class="item">
    135. 

  135.     <div id="fieldPairs-iterators-all">
    136. 

  136.   <div id="fieldPairs.i,S,T">
    137. 

  137.   <dt><pre><span class="Keyword">iterator</span> <a href="#fieldPairs.i%2CS%2CT"><span class="Identifier">fieldPairs</span></a><span class="Other">[</span><span class="Identifier">S</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span>
    138. 

  138.     <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;FieldPairs&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</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>
    139. 

  139.                                   <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>
    140. 

  140.   <dd>
    141. 

  141.     
    142. 

  142.     Iterates over every field of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    143. 

  143. This really transforms the 'for' and unrolls the loop. The current implementation also has a bug that affects symbol binding in the loop body.</div>
    144. 

  144. 

  145. <p><strong class="examples_text">Example:</strong></p>
    146. 

  146. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Foo</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    147. 

  147.   <span class="Identifier">x1</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    148. 

  148.   <span class="Identifier">x2</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    149. 

  149. <span class="Keyword">var</span> <span class="Identifier">a1</span> <span class="Operator">=</span> <span class="Identifier">Foo</span><span class="Punctuation">(</span><span class="Identifier">x1</span><span class="Punctuation">:</span> <span class="DecNumber">12</span><span class="Punctuation">,</span> <span class="Identifier">x2</span><span class="Punctuation">:</span> <span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">)</span>
    150. 

  150. <span class="Keyword">var</span> <span class="Identifier">a2</span><span class="Punctuation">:</span> <span class="Identifier">Foo</span>
    151. 

  151. <span class="Keyword">for</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">v1</span><span class="Punctuation">,</span> <span class="Identifier">v2</span> <span class="Keyword">in</span> <span class="Identifier">fieldPairs</span><span class="Punctuation">(</span><span class="Identifier">a1</span><span class="Punctuation">,</span> <span class="Identifier">a2</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    152. 

  152.   <span class="Keyword">when</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">&quot;x2&quot;</span><span class="Punctuation">:</span> <span class="Identifier">v2</span> <span class="Operator">=</span> <span class="Identifier">v1</span>
    153. 

  153. <span class="Identifier">doAssert</span> <span class="Identifier">a2</span> <span class="Operator">==</span> <span class="Identifier">Foo</span><span class="Punctuation">(</span><span class="Identifier">x1</span><span class="Punctuation">:</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">x2</span><span class="Punctuation">:</span> <span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">)</span></pre>
    154. 

  154.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L337" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    155. 

  155. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L337" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    156. 

  156. 

  157.   </dd>
    158. 

  158. </div>
    159. 

  159. <div id="fieldPairs.i,T">
    160. 

  160.   <dt><pre><span class="Keyword">iterator</span> <a href="#fieldPairs.i%2CT"><span class="Identifier">fieldPairs</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a><span class="Other">]</span> {.
    161. 

  161.     <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;FieldPairs&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</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>
    162. 

  162.   <dd>
    163. 

  163.     
    164. 

  164.     <p>Iterates over every field of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> returning their name and value.</p>
    165. 

  165. <p>When you iterate over objects with different field types you have to use the compile time <tt class="docutils literal"><span class="pre"><span class="Keyword">when</span></span></tt> instead of a runtime <tt class="docutils literal"><span class="pre"><span class="Keyword">if</span></span></tt> to select the code you want to run for each type. To perform the comparison use the <a class="reference external" href="manual.html#generics-is-operator">is operator</a>. Another way to do the same without <tt class="docutils literal"><span class="pre"><span class="Keyword">when</span></span></tt> is to leave the task of picking the appropriate code to a secondary proc which you overload for each field type and pass the <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> to.</p>
    166. 

  166. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    167. 

  167. This really transforms the 'for' and unrolls the loop. The current implementation also has a bug that affects symbol binding in the loop body.</div>
    168. 

  168. 

  169. <p><strong class="examples_text">Example:</strong></p>
    170. 

  170. <pre class="listing"><span class="Keyword">type</span>
    171. 

  171.   <span class="Identifier">Custom</span> <span class="Operator">=</span> <span class="Keyword">object</span>
    172. 

  172.     <span class="Identifier">foo</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    173. 

  173.     <span class="Identifier">bar</span><span class="Punctuation">:</span> <span class="Identifier">bool</span>
    174. 

  174. <span class="Keyword">proc</span> <span class="Punctuation">`</span><span class="Operator">$</span><span class="Punctuation">`</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">Custom</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span>
    175. 

  175.   <span class="Identifier">result</span> <span class="Operator">=</span> <span class="StringLit">&quot;Custom:&quot;</span>
    176. 

  176.   <span class="Keyword">for</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">value</span> <span class="Keyword">in</span> <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">fieldPairs</span><span class="Punctuation">:</span>
    177. 

  177.     <span class="Keyword">when</span> <span class="Identifier">value</span> <span class="Keyword">is</span> <span class="Identifier">bool</span><span class="Punctuation">:</span>
    178. 

  178.       <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;</span><span class="EscapeSequence">\n</span><span class="EscapeSequence">\t</span><span class="StringLit">&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">name</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot; is &quot;</span> <span class="Operator">&amp;</span> <span class="Operator">$</span><span class="Identifier">value</span><span class="Punctuation">)</span>
    179. 

  179.     <span class="Keyword">else</span><span class="Punctuation">:</span>
    180. 

  180.       <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;</span><span class="EscapeSequence">\n</span><span class="EscapeSequence">\t</span><span class="StringLit">&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">name</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot; '&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">value</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;'&quot;</span><span class="Punctuation">)</span></pre>
    181. 

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

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

  183. 

  184.   </dd>
    185. 

  185. </div>
    186. 

  186. 

  187. </div>
    188. 

  188. <div id="fields-iterators-all">
    189. 

  189.   <div id="fields.i,S,T">
    190. 

  190.   <dt><pre><span class="Keyword">iterator</span> <a href="#fields.i%2CS%2CT"><span class="Identifier">fields</span></a><span class="Other">[</span><span class="Identifier">S</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span>
    191. 

  191.     <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;Fields&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</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>
    192. 

  192.                                  <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>
    193. 

  193.   <dd>
    194. 

  194.     
    195. 

  195.     Iterates over every field of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    196. 

  196. This really transforms the 'for' and unrolls the loop. The current implementation also has a bug that affects symbol binding in the loop body.</div>
    197. 

  197. 

  198. <p><strong class="examples_text">Example:</strong></p>
    199. 

  199. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">t1</span> <span class="Operator">=</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">)</span>
    200. 

  200. <span class="Keyword">var</span> <span class="Identifier">t2</span> <span class="Operator">=</span> <span class="Identifier">default</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">t1</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    201. 

  201. <span class="Keyword">for</span> <span class="Identifier">v1</span><span class="Punctuation">,</span> <span class="Identifier">v2</span> <span class="Keyword">in</span> <span class="Identifier">fields</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="Punctuation">:</span> <span class="Identifier">v2</span> <span class="Operator">=</span> <span class="Identifier">v1</span>
    202. 

  202. <span class="Identifier">doAssert</span> <span class="Identifier">t1</span> <span class="Operator">==</span> <span class="Identifier">t2</span></pre>
    203. 

  203.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    204. 

  204. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    205. 

  205. 

  206.   </dd>
    207. 

  207. </div>
    208. 

  208. <div id="fields.i,T">
    209. 

  209.   <dt><pre><span class="Keyword">iterator</span> <a href="#fields.i%2CT"><span class="Identifier">fields</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;Fields&quot;</span><span class="Other">,</span>
    210. 

  210.     <span class="Identifier">noSideEffect</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>
    211. 

  211.   <dd>
    212. 

  212.     
    213. 

  213.     Iterates over every field of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
    214. 

  214. This really transforms the 'for' and unrolls the loop. The current implementation also has a bug that affects symbol binding in the loop body.</div>
    215. 

  215. 

  216. <p><strong class="examples_text">Example:</strong></p>
    217. 

  217. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">t</span> <span class="Operator">=</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">)</span>
    218. 

  218. <span class="Keyword">for</span> <span class="Identifier">v</span> <span class="Keyword">in</span> <span class="Identifier">fields</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">v</span> <span class="Operator">=</span> <span class="Identifier">default</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">v</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    219. 

  219. <span class="Identifier">doAssert</span> <span class="Identifier">t</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span></pre>
    220. 

  220.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L284" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    221. 

  221. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L284" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    222. 

  222. 

  223.   </dd>
    224. 

  224. </div>
    225. 

  225. 

  226. </div>
    227. 

  227. <div id="items-iterators-all">
    228. 

  228.   <div id="items.i,cstring">
    229. 

  229.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2Ccstring"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">inline</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>
    230. 

  230.   <dd>
    231. 

  231.     
    232. 

  232.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    233. 

  233. <p><strong class="examples_text">Example:</strong></p>
    234. 

  234. <pre class="listing"><span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sequtils</span> <span class="Keyword">import</span> <span class="Identifier">toSeq</span>
    235. 

  235. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="StringLit">&quot;abc</span><span class="EscapeSequence">\0</span><span class="StringLit">def&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">b</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">']</span>
    236. 

  236. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">cstring</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">b</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">']</span></pre>
    237. 

  237.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L70" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    238. 

  238. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L70" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    239. 

  239. 

  240.   </dd>
    241. 

  241. </div>
    242. 

  242. <div id="items.i,string">
    243. 

  243.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2Cstring"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">inline</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>
    244. 

  244.   <dd>
    245. 

  245.     
    246. 

  246.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    247. 

  247.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L265" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    248. 

  248. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L265" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    249. 

  249. 

  250.   </dd>
    251. 

  251. </div>
    252. 

  252. <div id="items.i,array[IX,T]">
    253. 

  253.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2Carray%5BIX%2CT%5D"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">IX</span><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> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">IX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    254. 

  254.   <dd>
    255. 

  255.     
    256. 

  256.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    257. 

  257.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L40" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    258. 

  258. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L40" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    259. 

  259. 

  260.   </dd>
    261. 

  261. </div>
    262. 

  262. <div id="items.i,openArray[T]_2">
    263. 

  263.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CopenArray%5BT%5D_2"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    264. 

  264.   <dd>
    265. 

  265.     
    266. 

  266.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    267. 

  267.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L23" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    268. 

  268. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L23" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    269. 

  269. 

  270.   </dd>
    271. 

  271. </div>
    272. 

  272. <div id="items.i,typedesc[T]">
    273. 

  273.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2Ctypedesc%5BT%5D"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">enum</span> <span class="Keyword">and</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">E</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
    274. 

  274.   <dd>
    275. 

  275.     
    276. 

  276.     Iterates over the values of <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt>. See also <tt class="docutils literal"><span class="pre"><span class="Identifier">enumutils</span><span class="Operator">.</span><span class="Identifier">items</span></span></tt> for enums with holes.
    277. 

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

  278. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Goo</span> <span class="Operator">=</span> <span class="Keyword">enum</span> <span class="Identifier">g0</span> <span class="Operator">=</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">g1</span><span class="Punctuation">,</span> <span class="Identifier">g2</span>
    279. 

  279. <span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sequtils</span> <span class="Keyword">import</span> <span class="Identifier">toSeq</span>
    280. 

  280. <span class="Identifier">assert</span> <span class="Identifier">Goo</span><span class="Operator">.</span><span class="Identifier">toSeq</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Identifier">g0</span><span class="Punctuation">,</span> <span class="Identifier">g1</span><span class="Punctuation">,</span> <span class="Identifier">g2</span><span class="Punctuation">]</span></pre>
    281. 

  281.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    282. 

  282. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    283. 

  283. 

  284.   </dd>
    285. 

  285. </div>
    286. 

  286. <div id="items.i,openArray[T]">
    287. 

  287.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CopenArray%5BT%5D"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">not</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">lent2</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    288. 

  288.   <dd>
    289. 

  289.     
    290. 

  290.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    291. 

  291.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L16" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    292. 

  292. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L16" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    293. 

  293. 

  294.   </dd>
    295. 

  295. </div>
    296. 

  296. <div id="items.i,Slice[T: Ordinal]">
    297. 

  297.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CSlice%5BT%3A%20Ordinal%5D"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#Slice"><span class="Identifier">Slice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
    298. 

  298.   <dd>
    299. 

  299.     
    300. 

  300.     Iterates over the slice <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>, yielding each value between <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">a</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">b</span></span></tt> (inclusively).
    301. 

  301.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L140" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    302. 

  302. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L140" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    303. 

  303. 

  304.   </dd>
    305. 

  305. </div>
    306. 

  306. <div id="items.i,seq[T]">
    307. 

  307.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2Cseq%5BT%5D"><span class="Identifier">items</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> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">lent2</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    308. 

  308.   <dd>
    309. 

  309.     
    310. 

  310.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    311. 

  311.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L247" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    312. 

  312. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L247" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    313. 

  313. 

  314.   </dd>
    315. 

  315. </div>
    316. 

  316. <div id="items.i,set[T]">
    317. 

  317.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2Cset%5BT%5D"><span class="Identifier">items</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> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    318. 

  318.   <dd>
    319. 

  319.     
    320. 

  320.     Iterates over each element of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">items</span></span></tt> iterates only over the elements that are really in the set (and not over the ones the set is able to hold).
    321. 

  321.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L58" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    322. 

  322. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L58" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    323. 

  323. 

  324.   </dd>
    325. 

  325. </div>
    326. 

  326. 

  327. </div>
    328. 

  328. <div id="mitems-iterators-all">
    329. 

  329.   <div id="mitems.i,cstring">
    330. 

  330.   <dt><pre><span class="Keyword">iterator</span> <a href="#mitems.i%2Ccstring"><span class="Identifier">mitems</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">inline</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>
    331. 

  331.     <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.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> so that you can modify the yielded value.
    335. 

  335. <p><strong class="examples_text">Example:</strong></p>
    336. 

  336. <pre class="listing"><span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span> <span class="Keyword">import</span> <span class="Identifier">collect</span>
    337. 

  337. <span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;abc</span><span class="EscapeSequence">\0</span><span class="StringLit">def&quot;</span>
    338. 

  338. <span class="Identifier">prepareMutation</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span>
    339. 

  339. <span class="Keyword">var</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">cstring</span>
    340. 

  340. <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">:</span>
    341. 

  341.   <span class="Keyword">for</span> <span class="Identifier">bi</span> <span class="Keyword">in</span> <span class="Identifier">mitems</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    342. 

  342.     <span class="Keyword">if</span> <span class="Identifier">bi</span> <span class="Operator">==</span> <span class="CharLit">'b'</span><span class="Punctuation">:</span> <span class="Identifier">bi</span> <span class="Operator">=</span> <span class="CharLit">'B'</span>
    343. 

  343.     <span class="Identifier">bi</span>
    344. 

  344. <span class="Identifier">assert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">B</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">']</span>
    345. 

  345. <span class="Identifier">assert</span> <span class="Identifier">b</span> <span class="Operator">==</span> <span class="StringLit">&quot;aBc&quot;</span>
    346. 

  346. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="StringLit">&quot;aBc</span><span class="EscapeSequence">\0</span><span class="StringLit">def&quot;</span></pre>
    347. 

  347.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L99" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    348. 

  348. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L99" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    349. 

  349. 

  350.   </dd>
    351. 

  351. </div>
    352. 

  352. <div id="mitems.i,string">
    353. 

  353.   <dt><pre><span class="Keyword">iterator</span> <a href="#mitems.i%2Cstring"><span class="Identifier">mitems</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">inline</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>
    354. 

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

  355.   <dd>
    356. 

  356.     
    357. 

  357.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> so that you can modify the yielded value.
    358. 

  358.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    359. 

  359. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    360. 

  360. 

  361.   </dd>
    362. 

  362. </div>
    363. 

  363. <div id="mitems.i,array[IX,T]">
    364. 

  364.   <dt><pre><span class="Keyword">iterator</span> <a href="#mitems.i%2Carray%5BIX%2CT%5D"><span class="Identifier">mitems</span></a><span class="Other">[</span><span class="Identifier">IX</span><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="Keyword">var</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">IX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    365. 

  365.   <dd>
    366. 

  366.     
    367. 

  367.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> so that you can modify the yielded value.
    368. 

  368.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L49" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    369. 

  369. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L49" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    370. 

  370. 

  371.   </dd>
    372. 

  372. </div>
    373. 

  373. <div id="mitems.i,openArray[T]">
    374. 

  374.   <dt><pre><span class="Keyword">iterator</span> <a href="#mitems.i%2CopenArray%5BT%5D"><span class="Identifier">mitems</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="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    375. 

  375.   <dd>
    376. 

  376.     
    377. 

  377.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> so that you can modify the yielded value.
    378. 

  378.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L33" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    379. 

  379. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L33" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    380. 

  380. 

  381.   </dd>
    382. 

  382. </div>
    383. 

  383. <div id="mitems.i,seq[T]">
    384. 

  384.   <dt><pre><span class="Keyword">iterator</span> <a href="#mitems.i%2Cseq%5BT%5D"><span class="Identifier">mitems</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="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    385. 

  385.   <dd>
    386. 

  386.     
    387. 

  387.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> so that you can modify the yielded value.
    388. 

  388.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L256" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    389. 

  389. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L256" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    390. 

  390. 

  391.   </dd>
    392. 

  392. </div>
    393. 

  393. 

  394. </div>
    395. 

  395. <div id="mpairs-iterators-all">
    396. 

  396.   <div id="mpairs.i,cstring">
    397. 

  397.   <dt><pre><span class="Keyword">iterator</span> <a href="#mpairs.i%2Ccstring"><span class="Identifier">mpairs</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    398. 

  398.     <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>
    399. 

  399.   <dd>
    400. 

  400.     
    401. 

  401.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span></span></tt> can be modified.
    402. 

  402.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L232" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    403. 

  403. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L232" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    404. 

  404. 

  405.   </dd>
    406. 

  406. </div>
    407. 

  407. <div id="mpairs.i,string">
    408. 

  408.   <dt><pre><span class="Keyword">iterator</span> <a href="#mpairs.i%2Cstring"><span class="Identifier">mpairs</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    409. 

  409.     <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>
    410. 

  410.   <dd>
    411. 

  411.     
    412. 

  412.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span></span></tt> can be modified.
    413. 

  413.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L208" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    414. 

  414. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L208" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    415. 

  415. 

  416.   </dd>
    417. 

  417. </div>
    418. 

  418. <div id="mpairs.i,array[IX,T]">
    419. 

  419.   <dt><pre><span class="Keyword">iterator</span> <a href="#mpairs.i%2Carray%5BIX%2CT%5D"><span class="Identifier">mpairs</span></a><span class="Other">[</span><span class="Identifier">IX</span><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="Keyword">var</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">IX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">IX</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    420. 

  420.   <dd>
    421. 

  421.     
    422. 

  422.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span></span></tt> can be modified.
    423. 

  423.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L170" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    424. 

  424. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L170" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    425. 

  425. 

  426.   </dd>
    427. 

  427. </div>
    428. 

  428. <div id="mpairs.i,openArray[T]">
    429. 

  429.   <dt><pre><span class="Keyword">iterator</span> <a href="#mpairs.i%2CopenArray%5BT%5D"><span class="Identifier">mpairs</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="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    430. 

  430.   <dd>
    431. 

  431.     
    432. 

  432.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span></span></tt> can be modified.
    433. 

  433.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    434. 

  434. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    435. 

  435. 

  436.   </dd>
    437. 

  437. </div>
    438. 

  438. <div id="mpairs.i,seq[T]">
    439. 

  439.   <dt><pre><span class="Keyword">iterator</span> <a href="#mpairs.i%2Cseq%5BT%5D"><span class="Identifier">mpairs</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="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    440. 

  440.   <dd>
    441. 

  441.     
    442. 

  442.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span></span></tt> can be modified.
    443. 

  443.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L189" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    444. 

  444. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L189" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    445. 

  445. 

  446.   </dd>
    447. 

  447. </div>
    448. 

  448. 

  449. </div>
    450. 

  450. <div id="pairs-iterators-all">
    451. 

  451.   <div id="pairs.i,cstring">
    452. 

  452.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2Ccstring"><span class="Identifier">pairs</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>
    453. 

  453.     <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>
    454. 

  454.   <dd>
    455. 

  455.     
    456. 

  456.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs.
    457. 

  457.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    458. 

  458. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    459. 

  459. 

  460.   </dd>
    461. 

  461. </div>
    462. 

  462. <div id="pairs.i,string">
    463. 

  463.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2Cstring"><span class="Identifier">pairs</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>
    464. 

  464.     <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>
    465. 

  465.   <dd>
    466. 

  466.     
    467. 

  467.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs.
    468. 

  468.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    469. 

  469. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    470. 

  470. 

  471.   </dd>
    472. 

  472. </div>
    473. 

  473. <div id="pairs.i,array[IX,T]">
    474. 

  474.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2Carray%5BIX%2CT%5D"><span class="Identifier">pairs</span></a><span class="Other">[</span><span class="Identifier">IX</span><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> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">IX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">IX</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    475. 

  475.   <dd>
    476. 

  476.     
    477. 

  477.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs.
    478. 

  478.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L161" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    479. 

  479. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L161" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    480. 

  480. 

  481.   </dd>
    482. 

  482. </div>
    483. 

  483. <div id="pairs.i,openArray[T]">
    484. 

  484.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2CopenArray%5BT%5D"><span class="Identifier">pairs</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> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    485. 

  485.   <dd>
    486. 

  486.     
    487. 

  487.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs.
    488. 

  488.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L146" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    489. 

  489. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L146" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    490. 

  490. 

  491.   </dd>
    492. 

  492. </div>
    493. 

  493. <div id="pairs.i,seq[T]">
    494. 

  494.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2Cseq%5BT%5D"><span class="Identifier">pairs</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> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    495. 

  495.   <dd>
    496. 

  496.     
    497. 

  497.     Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Yields <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> pairs.
    498. 

  498.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L180" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    499. 

  499. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L180" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    500. 

  500. 

  501.   </dd>
    502. 

  502. </div>
    503. 

  503. 

  504. </div>
    505. 

  505. 

  506.   </dl>
    507. 

  507. </div>
    508. 

  508. 

  509.   </div>
    510. 

  510. </div>
    511. 

  511. 

  512.       <div class="twelve-columns footer">
    513. 

  513.         <span class="nim-sprite"></span>
    514. 

  514.         <br>
    515. 

  515.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:20 UTC</small>
    516. 

  516.       </div>
    517. 

  517.     </div>
    518. 

  518.   </div>
    519. 

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

  520.     
    521. 

  521. </body>
    522. 

  522. </html>
    523. 

  523.