Files
Nim/iterators.html
github-actions[bot] de413ab6bb Deploy to GitHub pages
2025-12-25 20:14:24 +00:00

523 lines
73 KiB
HTML

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>system/iterators</title>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- Favicon -->
<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=="/>
<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=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">system/iterators</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple-boot">
<li><a href="manual.html">Manual</a></li>
<li><a href="lib.html">Standard library</a></li>
<li> <a id="indexLink" href="theindex.html">Index</a></li>
<li><a href="compiler/theindex.html">Compiler docs</a></li>
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput"
oninput="search()" />
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">fieldPairs
<li><a class="reference" href="#fieldPairs.i%2CS%2CT" title="fieldPairs[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
a, b: RootObj]">fieldPairs[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
a, b: RootObj]</a></li>
<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>
</ul>
<ul class="simple nested-toc-section">fields
<li><a class="reference" href="#fields.i%2CS%2CT" title="fields[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
val: RootObj]">fields[S: tuple | object; T: tuple | object](x: S; y: T): tuple[key: string,
val: RootObj]</a></li>
<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>
</ul>
<ul class="simple nested-toc-section">items
<li><a class="reference" href="#items.i%2Ccstring" title="items(a: cstring): char">items(a: cstring): char</a></li>
<li><a class="reference" href="#items.i%2Cstring" title="items(a: string): char">items(a: string): char</a></li>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</ul>
<ul class="simple nested-toc-section">mitems
<li><a class="reference" href="#mitems.i%2Ccstring" title="mitems(a: var cstring): var char">mitems(a: var cstring): var char</a></li>
<li><a class="reference" href="#mitems.i%2Cstring" title="mitems(a: var string): var char">mitems(a: var string): var char</a></li>
<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>
<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>
<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>
</ul>
<ul class="simple nested-toc-section">mpairs
<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>
<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>
<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>
<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>
<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>
</ul>
<ul class="simple nested-toc-section">pairs
<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>
<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>
<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>
<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>
<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>
</ul>
</ul>
</details>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc">Default iterators for some Nim types.</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="assertions.html">assertions</a>
</dl>
</div>
<div class="section" id="15">
<h1><a class="toc-backref" href="#15">Iterators</a></h1>
<dl class="item">
<div id="fieldPairs-iterators-all">
<div id="fieldPairs.i,S,T">
<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>
<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>
<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>
<dd>
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>
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>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Foo</span> <span class="Operator">=</span> <span class="Keyword">object</span>
<span class="Identifier">x1</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
<span class="Identifier">x2</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
<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>
<span class="Keyword">var</span> <span class="Identifier">a2</span><span class="Punctuation">:</span> <span class="Identifier">Foo</span>
<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>
<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>
<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>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L337" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L337" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="fieldPairs.i,T">
<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> {.
<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>
<dd>
<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>
<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>
<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
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>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">type</span>
<span class="Identifier">Custom</span> <span class="Operator">=</span> <span class="Keyword">object</span>
<span class="Identifier">foo</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
<span class="Identifier">bar</span><span class="Punctuation">:</span> <span class="Identifier">bool</span>
<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>
<span class="Identifier">result</span> <span class="Operator">=</span> <span class="StringLit">&quot;Custom:&quot;</span>
<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>
<span class="Keyword">when</span> <span class="Identifier">value</span> <span class="Keyword">is</span> <span class="Identifier">bool</span><span class="Punctuation">:</span>
<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>
<span class="Keyword">else</span><span class="Punctuation">:</span>
<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>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="fields-iterators-all">
<div id="fields.i,S,T">
<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>
<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>
<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>
<dd>
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>
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>
<p><strong class="examples_text">Example:</strong></p>
<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>
<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>
<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>
<span class="Identifier">doAssert</span> <span class="Identifier">t1</span> <span class="Operator">==</span> <span class="Identifier">t2</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="fields.i,T">
<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>
<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>
<dd>
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>
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>
<p><strong class="examples_text">Example:</strong></p>
<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>
<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>
<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>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L284" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L284" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="items-iterators-all">
<div id="items.i,cstring">
<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>
<dd>
Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
<p><strong class="examples_text">Example:</strong></p>
<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>
<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>
<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>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L70" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L70" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,string">
<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>
<dd>
Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L265" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L265" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,array[IX,T]">
<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>
<dd>
Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L40" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L40" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,openArray[T]_2">
<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>
<dd>
Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L23" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L23" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,typedesc[T]">
<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>
<dd>
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.
<p><strong class="examples_text">Example:</strong></p>
<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>
<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>
<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>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,openArray[T]">
<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>
<dd>
Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L16" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L16" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,Slice[T: Ordinal]">
<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>
<dd>
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).
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L140" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L140" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,seq[T]">
<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>
<dd>
Iterates over each item of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L247" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L247" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="items.i,set[T]">
<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>
<dd>
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).
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L58" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L58" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="mitems-iterators-all">
<div id="mitems.i,cstring">
<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>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
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.
<p><strong class="examples_text">Example:</strong></p>
<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>
<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>
<span class="Identifier">prepareMutation</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span>
<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>
<span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">:</span>
<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>
<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>
<span class="Identifier">bi</span>
<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>
<span class="Identifier">assert</span> <span class="Identifier">b</span> <span class="Operator">==</span> <span class="StringLit">&quot;aBc&quot;</span>
<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>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L99" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L99" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mitems.i,string">
<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>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mitems.i,array[IX,T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L49" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L49" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mitems.i,openArray[T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L33" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L33" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mitems.i,seq[T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L256" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L256" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="mpairs-iterators-all">
<div id="mpairs.i,cstring">
<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>
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L232" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L232" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mpairs.i,string">
<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>
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L208" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L208" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mpairs.i,array[IX,T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L170" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L170" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mpairs.i,openArray[T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="mpairs.i,seq[T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L189" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L189" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="pairs-iterators-all">
<div id="pairs.i,cstring">
<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>
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="pairs.i,string">
<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>
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="pairs.i,array[IX,T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L161" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L161" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="pairs.i,openArray[T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L146" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L146" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="pairs.i,seq[T]">
<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>
<dd>
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.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators.nim#L180" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators.nim#L180" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-25 20:14:02 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>