Sākums Izpētīt Palīdzība
Pierakstīties
levovix
/
Nim
spogulis no https://github.com/nim-lang/Nim
Vērot 1
Pievienot zvaigznīti 0
Atdalīts 1
Faili Problēmas 0 Vikivietne
Atzars: gh-pages
Atzari Tagi
Nim
/
ropes.html

ropes.html 62 KB
Patstāvīgā saite Vēsture Neapstrādāts

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

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

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

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

  5. <head>
    6. 

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

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

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

  9. 

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

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

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

  13. 

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

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

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

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

  20. 

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

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

  23. </head>
    24. 

  24. <body>
    25. 

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

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

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

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li>
    55. 

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

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

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

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

  61.       <li><a class="reference" href="#Rope" title="Rope {.acyclic.} = ref object">Rope</a></li>
    62. 

  62. 

  63.     </ul>
    64. 

  64.   </details>
    65. 

  65. </li>
    66. 

  66. <li>
    67. 

  67.   <details open>
    68. 

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

  69.     <ul class="simple simple-toc-section">
    70. 

  70.       <ul class="simple nested-toc-section">$
    71. 

  71.   <li><a class="reference" href="#%24%2CRope" title="`$`(r: Rope): string">`$`(r: Rope): string</a></li>
    72. 

  72. 

  73. </ul>
    74. 

  74. <ul class="simple nested-toc-section">%
    75. 

  75.   <li><a class="reference" href="#%25%2Cstring%2CopenArray%5BRope%5D" title="`%`(frmt: string; args: openArray[Rope]): Rope">`%`(frmt: string; args: openArray[Rope]): Rope</a></li>
    76. 

  76. 

  77. </ul>
    78. 

  78. <ul class="simple nested-toc-section">&
    79. 

  79.   <li><a class="reference" href="#%26%2CRope%2CRope" title="`&amp;`(a, b: Rope): Rope">`&amp;`(a, b: Rope): Rope</a></li>
    80. 

  80. <li><a class="reference" href="#%26%2CopenArray%5BRope%5D" title="`&amp;`(a: openArray[Rope]): Rope">`&amp;`(a: openArray[Rope]): Rope</a></li>
    81. 

  81. <li><a class="reference" href="#%26%2CRope%2Cstring" title="`&amp;`(a: Rope; b: string): Rope">`&amp;`(a: Rope; b: string): Rope</a></li>
    82. 

  82. <li><a class="reference" href="#%26%2Cstring%2CRope" title="`&amp;`(a: string; b: Rope): Rope">`&amp;`(a: string; b: Rope): Rope</a></li>
    83. 

  83. 

  84. </ul>
    85. 

  85. <ul class="simple nested-toc-section">[]
    86. 

  86.   <li><a class="reference" href="#%5B%5D%2CRope%2Cint" title="`[]`(r: Rope; i: int): char">`[]`(r: Rope; i: int): char</a></li>
    87. 

  87. 

  88. </ul>
    89. 

  89. <ul class="simple nested-toc-section">add
    90. 

  90.   <li><a class="reference" href="#add%2CRope%2CRope" title="add(a: var Rope; b: Rope)">add(a: var Rope; b: Rope)</a></li>
    91. 

  91. <li><a class="reference" href="#add%2CRope%2Cstring" title="add(a: var Rope; b: string)">add(a: var Rope; b: string)</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">addf
    95. 

  95.   <li><a class="reference" href="#addf%2CRope%2Cstring%2CopenArray%5BRope%5D" title="addf(c: var Rope; frmt: string; args: openArray[Rope])">addf(c: var Rope; frmt: string; args: openArray[Rope])</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">disableCache
    99. 

  99.   <li><a class="reference" href="#disableCache" title="disableCache()">disableCache()</a></li>
    100. 

  100. 

  101. </ul>
    102. 

  102. <ul class="simple nested-toc-section">enableCache
    103. 

  103.   <li><a class="reference" href="#enableCache" title="enableCache()">enableCache()</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. <ul class="simple nested-toc-section">equalsFile
    107. 

  107.   <li><a class="reference" href="#equalsFile%2CRope%2CFile" title="equalsFile(r: Rope; f: File): bool">equalsFile(r: Rope; f: File): bool</a></li>
    108. 

  108. <li><a class="reference" href="#equalsFile%2CRope%2Cstring" title="equalsFile(r: Rope; filename: string): bool">equalsFile(r: Rope; filename: string): bool</a></li>
    109. 

  109. 

  110. </ul>
    111. 

  111. <ul class="simple nested-toc-section">len
    112. 

  112.   <li><a class="reference" href="#len%2CRope" title="len(a: Rope): int">len(a: Rope): int</a></li>
    113. 

  113. 

  114. </ul>
    115. 

  115. <ul class="simple nested-toc-section">rope
    116. 

  116.   <li><a class="reference" href="#rope%2CBiggestFloat" title="rope(f: BiggestFloat): Rope">rope(f: BiggestFloat): Rope</a></li>
    117. 

  117. <li><a class="reference" href="#rope%2CBiggestInt" title="rope(i: BiggestInt): Rope">rope(i: BiggestInt): Rope</a></li>
    118. 

  118. <li><a class="reference" href="#rope%2Cstring" title="rope(s: string = &quot;&quot;): Rope">rope(s: string = &quot;&quot;): Rope</a></li>
    119. 

  119. 

  120. </ul>
    121. 

  121. <ul class="simple nested-toc-section">write
    122. 

  122.   <li><a class="reference" href="#write%2CFile%2CRope" title="write(f: File; r: Rope)">write(f: File; r: Rope)</a></li>
    123. 

  123. <li><a class="reference" href="#write%2CStream%2CRope" title="write(s: Stream; r: Rope)">write(s: Stream; r: Rope)</a></li>
    124. 

  124. 

  125. </ul>
    126. 

  126. 

  127.     </ul>
    128. 

  128.   </details>
    129. 

  129. </li>
    130. 

  130. <li>
    131. 

  131.   <details open>
    132. 

  132.     <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    133. 

  133.     <ul class="simple simple-toc-section">
    134. 

  134.       <ul class="simple nested-toc-section">items
    135. 

  135.   <li><a class="reference" href="#items.i%2CRope" title="items(r: Rope): char">items(r: Rope): char</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">leaves
    139. 

  139.   <li><a class="reference" href="#leaves.i%2CRope" title="leaves(r: Rope): string">leaves(r: Rope): string</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. 

  143.     </ul>
    144. 

  144.   </details>
    145. 

  145. </li>
    146. 

  146. 

  147. </ul>
    148. 

  148. 

  149.   </div>
    150. 

  150.   <div class="nine columns" id="content">
    151. 

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

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

  153. 

  154.     <div id="tocRoot"></div>
    155. 

  155.     
    156. 

  156.     <p class="module-desc">This module contains support for a <span id="rope_1">rope</span> data type. Ropes can represent very long strings efficiently; in particular, concatenation is done in O(1) instead of O(n). They are essentially concatenation trees that are only flattened when converting to a native Nim string. The empty string is represented by <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>. Ropes are immutable and subtrees can be shared without copying. Leaves can be cached for better memory efficiency at the cost of runtime efficiency.</p>
    157. 

  157.     <div class="section" id="6">
    158. 

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

  159.   <dl class="item">
    160. 

  160.     <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="formatfloat.html">formatfloat</a>, <a class="reference external" href="assertions.html">assertions</a>
    161. 

  161.   </dl>
    162. 

  162. </div>
    163. 

  163. <div class="section" id="7">
    164. 

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

  165.   <dl class="item">
    166. 

  166.     <div id="Rope">
    167. 

  167.   <dt><pre><a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span class="Identifier">acyclic</span>.} <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span></pre></dt>
    168. 

  168.   <dd>
    169. 

  169.     
    170. 

  170.     A rope data type. The empty rope is represented by <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>.
    171. 

  171.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L35" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    172. 

  172. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L35" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    173. 

  173. 

  174.   </dd>
    175. 

  175. </div>
    176. 

  176. 

  177.   </dl>
    178. 

  178. </div>
    179. 

  179. <div class="section" id="12">
    180. 

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

  181.   <dl class="item">
    182. 

  182.     <div id="$-procs-all">
    183. 

  183.   <div id="$,Rope">
    184. 

  184.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CRope"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroToString&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    185. 

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

  186.   <dd>
    187. 

  187.     
    188. 

  188.     Converts a rope back to a string.
    189. 

  189.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L291" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    190. 

  190. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L291" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    191. 

  191. 

  192.   </dd>
    193. 

  193. </div>
    194. 

  194. 

  195. </div>
    196. 

  196. <div id="%-procs-all">
    197. 

  197.   <div id="%,string,openArray[Rope]">
    198. 

  198.   <dt><pre><span class="Keyword">proc</span> <a href="#%25%2Cstring%2CopenArray%5BRope%5D"><span class="Identifier">`%`</span></a><span class="Other">(</span><span class="Identifier">frmt</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    199. 

  199.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroFormat&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</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>
    200. 

  200.   <dd>
    201. 

  201.     
    202. 

  202.     <tt class="docutils literal"><span class="pre"><span class="Operator">%</span></span></tt> substitution operator for ropes. Does not support the <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Identifier">identifier</span></span></tt> nor <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Punctuation">{</span><span class="Identifier">identifier</span><span class="Punctuation">}</span></span></tt> notations.
    203. 

  203. <p><strong class="examples_text">Example:</strong></p>
    204. 

  204. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r1</span> <span class="Operator">=</span> <span class="StringLit">&quot;$1 $2 $3&quot;</span> <span class="Operator">%</span> <span class="Punctuation">[</span><span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;is&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;a great language&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
    205. 

  205. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r1</span> <span class="Operator">==</span> <span class="StringLit">&quot;Nim is a great language&quot;</span>
    206. 

  206. 

  207. <span class="Keyword">let</span> <span class="Identifier">r2</span> <span class="Operator">=</span> <span class="StringLit">&quot;$# $# $#&quot;</span> <span class="Operator">%</span> <span class="Punctuation">[</span><span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;is&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;a great language&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
    208. 

  208. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r2</span> <span class="Operator">==</span> <span class="StringLit">&quot;Nim is a great language&quot;</span>
    209. 

  209. 

  210. <span class="Keyword">let</span> <span class="Identifier">r3</span> <span class="Operator">=</span> <span class="StringLit">&quot;${1} ${2} ${3}&quot;</span> <span class="Operator">%</span> <span class="Punctuation">[</span><span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;is&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;a great language&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
    211. 

  211. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r3</span> <span class="Operator">==</span> <span class="StringLit">&quot;Nim is a great language&quot;</span></pre>
    212. 

  212.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    213. 

  213. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    214. 

  214. 

  215.   </dd>
    216. 

  216. </div>
    217. 

  217. 

  218. </div>
    219. 

  219. <div id="&amp;-procs-all">
    220. 

  220.   <div id="&,Rope,Rope">
    221. 

  221.   <dt><pre><span class="Keyword">proc</span> <a href="#%26%2CRope%2CRope"><span class="Identifier">`&amp;`</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="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroConcRopeRope&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    222. 

  222.                              <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>
    223. 

  223.   <dd>
    224. 

  224.     
    225. 

  225.     The concatenation operator for ropes.
    226. 

  226. <p><strong class="examples_text">Example:</strong></p>
    227. 

  227. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello, &quot;</span><span class="Punctuation">)</span> <span class="Operator">&amp;</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim!&quot;</span><span class="Punctuation">)</span>
    228. 

  228. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello, Nim!&quot;</span></pre>
    229. 

  229.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L175" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    230. 

  230. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L175" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    231. 

  231. 

  232.   </dd>
    233. 

  233. </div>
    234. 

  234. <div id="&,openArray[Rope]">
    235. 

  235.   <dt><pre><span class="Keyword">proc</span> <a href="#%26%2CopenArray%5BRope%5D"><span class="Identifier">`&amp;`</span></a><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><a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroConcOpenArray&quot;</span><span class="Other">,</span>
    236. 

  236.                                      <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>
    237. 

  237.   <dd>
    238. 

  238.     
    239. 

  239.     The concatenation operator for an <tt class="docutils literal"><span class="pre"><span class="Identifier">openArray</span></span></tt> of ropes.
    240. 

  240. <p><strong class="examples_text">Example:</strong></p>
    241. 

  241. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Operator">&amp;</span><span class="Punctuation">[</span><span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello, &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;!&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
    242. 

  242. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello, Nim!&quot;</span></pre>
    243. 

  243.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L207" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    244. 

  244. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L207" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    245. 

  245. 

  246.   </dd>
    247. 

  247. </div>
    248. 

  248. <div id="&,Rope,string">
    249. 

  249.   <dt><pre><span class="Keyword">proc</span> <a href="#%26%2CRope%2Cstring"><span class="Identifier">`&amp;`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">b</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="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroConcRopeStr&quot;</span><span class="Other">,</span>
    250. 

  250.                                      <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>
    251. 

  251.   <dd>
    252. 

  252.     
    253. 

  253.     The concatenation operator for ropes.
    254. 

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

  255. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello, &quot;</span><span class="Punctuation">)</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;Nim!&quot;</span>
    256. 

  256. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello, Nim!&quot;</span></pre>
    257. 

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

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

  259. 

  260.   </dd>
    261. 

  261. </div>
    262. 

  262. <div id="&,string,Rope">
    263. 

  263.   <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Cstring%2CRope"><span class="Identifier">`&amp;`</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="Identifier">b</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroConcStrRope&quot;</span><span class="Other">,</span>
    264. 

  264.                                      <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>
    265. 

  265.   <dd>
    266. 

  266.     
    267. 

  267.     The concatenation operator for ropes.
    268. 

  268. <p><strong class="examples_text">Example:</strong></p>
    269. 

  269. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="StringLit">&quot;Hello, &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim!&quot;</span><span class="Punctuation">)</span>
    270. 

  270. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello, Nim!&quot;</span></pre>
    271. 

  271.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    272. 

  272. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    273. 

  273. 

  274.   </dd>
    275. 

  275. </div>
    276. 

  276. 

  277. </div>
    278. 

  278. <div id="[]-procs-all">
    279. 

  279.   <div id="[],Rope,int">
    280. 

  280.   <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CRope%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroCharAt&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    281. 

  281.                                    <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>
    282. 

  282.   <dd>
    283. 

  283.     
    284. 

  284.     Returns the character at position <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt> in the rope <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>. This is quite expensive! Worst-case: O(n). If <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span> <span class="Operator">&gt;=</span> <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Keyword">or</span> <span class="Identifier">i</span> <span class="Operator">&lt;</span> <span class="DecNumber">0</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="DecNumber">0</span></span></tt> is returned.
    285. 

  285. <p><strong class="examples_text">Example:</strong></p>
    286. 

  286. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello, Nim!&quot;</span><span class="Punctuation">)</span>
    287. 

  287. 

  288. <span class="Identifier">doAssert</span> <span class="Identifier">r</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="CharLit">'H'</span>
    289. 

  289. <span class="Identifier">doAssert</span> <span class="Identifier">r</span><span class="Punctuation">[</span><span class="DecNumber">7</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="CharLit">'N'</span>
    290. 

  290. <span class="Identifier">doAssert</span> <span class="Identifier">r</span><span class="Punctuation">[</span><span class="DecNumber">22</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="CharLit">'\0'</span></pre>
    291. 

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

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

  293. 

  294.   </dd>
    295. 

  295. </div>
    296. 

  296. 

  297. </div>
    298. 

  298. <div id="add-procs-all">
    299. 

  299.   <div id="add,Rope,Rope">
    300. 

  300.   <dt><pre><span class="Keyword">proc</span> <a href="#add%2CRope%2CRope"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1Rope&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    301. 

  301.                                  <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>
    302. 

  302.   <dd>
    303. 

  303.     
    304. 

  304.     Adds <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> to the rope <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    305. 

  305. <p><strong class="examples_text">Example:</strong></p>
    306. 

  306. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello, &quot;</span><span class="Punctuation">)</span>
    307. 

  307. <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim!&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    308. 

  308. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello, Nim!&quot;</span></pre>
    309. 

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

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

  311. 

  312.   </dd>
    313. 

  313. </div>
    314. 

  314. <div id="add,Rope,string">
    315. 

  315.   <dt><pre><span class="Keyword">proc</span> <a href="#add%2CRope%2Cstring"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1Str&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    316. 

  316.                                    <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>
    317. 

  317.   <dd>
    318. 

  318.     
    319. 

  319.     Adds <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> to the rope <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    320. 

  320. <p><strong class="examples_text">Example:</strong></p>
    321. 

  321. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello, &quot;</span><span class="Punctuation">)</span>
    322. 

  322. <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim!&quot;</span><span class="Punctuation">)</span>
    323. 

  323. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello, Nim!&quot;</span></pre>
    324. 

  324.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L224" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    325. 

  325. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L224" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    326. 

  326. 

  327.   </dd>
    328. 

  328. </div>
    329. 

  329. 

  330. </div>
    331. 

  331. <div id="addf-procs-all">
    332. 

  332.   <div id="addf,Rope,string,openArray[Rope]">
    333. 

  333.   <dt><pre><span class="Keyword">proc</span> <a href="#addf%2CRope%2Cstring%2CopenArray%5BRope%5D"><span class="Identifier">addf</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">frmt</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    334. 

  334.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</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>
    335. 

  335.   <dd>
    336. 

  336.     
    337. 

  337.     Shortcut for <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">,</span> <span class="Identifier">frmt</span> <span class="Operator">%</span> <span class="Identifier">args</span><span class="Punctuation">)</span></span></tt>.
    338. 

  338. <p><strong class="examples_text">Example:</strong></p>
    339. 

  339. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Dash: &quot;</span><span class="Punctuation">)</span>
    340. 

  340. <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">addf</span> <span class="StringLit">&quot;$1 $2 $3&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">[</span><span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Nim&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;is&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;a great language&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
    341. 

  341. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;Dash: Nim is a great language&quot;</span></pre>
    342. 

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

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

  344. 

  345.   </dd>
    346. 

  346. </div>
    347. 

  347. 

  348. </div>
    349. 

  349. <div id="disableCache-procs-all">
    350. 

  350.   <div id="disableCache">
    351. 

  351.   <dt><pre><span class="Keyword">proc</span> <a href="#disableCache"><span class="Identifier">disableCache</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    352. 

  352.   <dd>
    353. 

  353.     
    354. 

  354.     The cache is discarded and disabled. The GC will reuse its used memory.
    355. 

  355.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L170" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    356. 

  356. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L170" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    357. 

  357. 

  358.   </dd>
    359. 

  359. </div>
    360. 

  360. 

  361. </div>
    362. 

  362. <div id="enableCache-procs-all">
    363. 

  363.   <div id="enableCache">
    364. 

  364.   <dt><pre><span class="Keyword">proc</span> <a href="#enableCache"><span class="Identifier">enableCache</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    365. 

  365.   <dd>
    366. 

  366.     
    367. 

  367.     Enables the caching of leaves. This reduces the memory footprint at the cost of runtime efficiency.
    368. 

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

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

  370. 

  371.   </dd>
    372. 

  372. </div>
    373. 

  373. 

  374. </div>
    375. 

  375. <div id="equalsFile-procs-all">
    376. 

  376.   <div id="equalsFile,Rope,File">
    377. 

  377.   <dt><pre><span class="Keyword">proc</span> <a href="#equalsFile%2CRope%2CFile"><span class="Identifier">equalsFile</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1File&quot;</span><span class="Other">,</span>
    378. 

  378.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</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>
    379. 

  379.   <dd>
    380. 

  380.     
    381. 

  381.     Returns true if the contents of the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> equal <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
    382. 

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

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

  384. 

  385.   </dd>
    386. 

  386. </div>
    387. 

  387. <div id="equalsFile,Rope,string">
    388. 

  388.   <dt><pre><span class="Keyword">proc</span> <a href="#equalsFile%2CRope%2Cstring"><span class="Identifier">equalsFile</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">;</span> <span class="Identifier">filename</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#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1Str&quot;</span><span class="Other">,</span>
    389. 

  389.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</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>
    390. 

  390.   <dd>
    391. 

  391.     
    392. 

  392.     Returns true if the contents of the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> equal <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>. If <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> does not exist, false is returned.
    393. 

  393.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L389" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    394. 

  394. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L389" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    395. 

  395. 

  396.   </dd>
    397. 

  397. </div>
    398. 

  398. 

  399. </div>
    400. 

  400. <div id="len-procs-all">
    401. 

  401.   <div id="len,Rope">
    402. 

  402.   <dt><pre><span class="Keyword">proc</span> <a href="#len%2CRope"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    403. 

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

  404.   <dd>
    405. 

  405.     
    406. 

  406.     The rope's length.
    407. 

  407.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L49" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    408. 

  408. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L49" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    409. 

  409. 

  410.   </dd>
    411. 

  411. </div>
    412. 

  412. 

  413. </div>
    414. 

  414. <div id="rope-procs-all">
    415. 

  415.   <div id="rope,BiggestFloat">
    416. 

  416.   <dt><pre><span class="Keyword">proc</span> <a href="#rope%2CBiggestFloat"><span class="Identifier">rope</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="ctypes.html#BiggestFloat"><span class="Identifier">BiggestFloat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1BiggestFloat&quot;</span><span class="Other">,</span>
    417. 

  417.                                    <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>
    418. 

  418.   <dd>
    419. 

  419.     
    420. 

  420.     Converts a float to a rope.
    421. 

  421. <p><strong class="examples_text">Example:</strong></p>
    422. 

  422. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="FloatNumber">4.29</span><span class="Punctuation">)</span>
    423. 

  423. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;4.29&quot;</span></pre>
    424. 

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

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

  426. 

  427.   </dd>
    428. 

  428. </div>
    429. 

  429. <div id="rope,BiggestInt">
    430. 

  430.   <dt><pre><span class="Keyword">proc</span> <a href="#rope%2CBiggestInt"><span class="Identifier">rope</span></a><span class="Other">(</span><span class="Identifier">i</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1BiggestInt&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    431. 

  431.                                  <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>
    432. 

  432.   <dd>
    433. 

  433.     
    434. 

  434.     Converts an int to a rope.
    435. 

  435. <p><strong class="examples_text">Example:</strong></p>
    436. 

  436. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="DecNumber">429</span><span class="Punctuation">)</span>
    437. 

  437. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;429&quot;</span></pre>
    438. 

  438.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L149" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    439. 

  439. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L149" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    440. 

  440. 

  441.   </dd>
    442. 

  442. </div>
    443. 

  443. <div id="rope,string">
    444. 

  444.   <dt><pre><span class="Keyword">proc</span> <a href="#rope%2Cstring"><span class="Identifier">rope</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1Str&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    445. 

  445.                                   <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>
    446. 

  446.   <dd>
    447. 

  447.     
    448. 

  448.     Converts a string to a rope.
    449. 

  449. <p><strong class="examples_text">Example:</strong></p>
    450. 

  450. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;I'm a rope&quot;</span><span class="Punctuation">)</span>
    451. 

  451. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">r</span> <span class="Operator">==</span> <span class="StringLit">&quot;I'm a rope&quot;</span></pre>
    452. 

  452.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L130" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    453. 

  453. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L130" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    454. 

  454. 

  455.   </dd>
    456. 

  456. </div>
    457. 

  457. 

  458. </div>
    459. 

  459. <div id="write-procs-all">
    460. 

  460.   <div id="write,File,Rope">
    461. 

  461.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2CRope"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nro$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    462. 

  462.                                <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</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>
    463. 

  463.   <dd>
    464. 

  464.     
    465. 

  465.     Writes a rope to a file.
    466. 

  466.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L283" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    467. 

  467. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L283" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    468. 

  468. 

  469.   </dd>
    470. 

  470. </div>
    471. 

  471. <div id="write,Stream,Rope">
    472. 

  472.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CStream%2CRope"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nroWriteStream&quot;</span><span class="Other">,</span>
    473. 

  473.                                  <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    474. 

  474.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</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>
    475. 

  475.   <dd>
    476. 

  476.     
    477. 

  477.     Writes a rope to a stream.
    478. 

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

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

  480. 

  481.   </dd>
    482. 

  482. </div>
    483. 

  483. 

  484. </div>
    485. 

  485. 

  486.   </dl>
    487. 

  487. </div>
    488. 

  488. <div class="section" id="15">
    489. 

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

  490.   <dl class="item">
    491. 

  491.     <div id="items-iterators-all">
    492. 

  492.   <div id="items.i,Rope">
    493. 

  493.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CRope"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    494. 

  494.   <dd>
    495. 

  495.     
    496. 

  496.     Iterates over any character in the rope <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
    497. 

  497.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L278" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    498. 

  498. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L278" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    499. 

  499. 

  500.   </dd>
    501. 

  501. </div>
    502. 

  502. 

  503. </div>
    504. 

  504. <div id="leaves-iterators-all">
    505. 

  505.   <div id="leaves.i,Rope">
    506. 

  506.   <dt><pre><span class="Keyword">iterator</span> <a href="#leaves.i%2CRope"><span class="Identifier">leaves</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="ropes.html#Rope"><span class="Identifier">Rope</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    507. 

  507.   <dd>
    508. 

  508.     
    509. 

  509.     Iterates over any leaf string in the rope <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
    510. 

  510. <p><strong class="examples_text">Example:</strong></p>
    511. 

  511. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello&quot;</span><span class="Punctuation">)</span> <span class="Operator">&amp;</span> <span class="Identifier">rope</span><span class="Punctuation">(</span><span class="StringLit">&quot;, Nim!&quot;</span><span class="Punctuation">)</span>
    512. 

  512. <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="StringLit">&quot;Hello&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;, Nim!&quot;</span><span class="Punctuation">]</span>
    513. 

  513. <span class="Keyword">var</span> <span class="Identifier">index</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
    514. 

  514. <span class="Keyword">for</span> <span class="Identifier">leave</span> <span class="Keyword">in</span> <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">leaves</span><span class="Punctuation">:</span>
    515. 

  515.   <span class="Identifier">doAssert</span> <span class="Identifier">leave</span> <span class="Operator">==</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">index</span><span class="Punctuation">]</span>
    516. 

  516.   <span class="Identifier">inc</span><span class="Punctuation">(</span><span class="Identifier">index</span><span class="Punctuation">)</span></pre>
    517. 

  517.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/ropes.nim#L257" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    518. 

  518. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/ropes.nim#L257" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    519. 

  519. 

  520.   </dd>
    521. 

  521. </div>
    522. 

  522. 

  523. </div>
    524. 

  524. 

  525.   </dl>
    526. 

  526. </div>
    527. 

  527. 

  528.   </div>
    529. 

  529. </div>
    530. 

  530. 

  531.       <div class="twelve-columns footer">
    532. 

  532.         <span class="nim-sprite"></span>
    533. 

  533.         <br>
    534. 

  534.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-01-09 12:00:09 UTC</small>
    535. 

  535.       </div>
    536. 

  536.     </div>
    537. 

  537.   </div>
    538. 

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

  539.     
    540. 

  540. </body>
    541. 

  541. </html>
    542. 

  542.