صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
levovix
/
Nim
mirrorاز https://github.com/nim-lang/Nim
دنبال کردن 1
ستاره دار 0
انشعاب 1
پرونده‌ها مشکلات 0 ویکی
شاخه: gh-pages
شاخه‌ها تگ‌ها
Nim
/
nre.html

nre.html 122 KB
لینک دائمی تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963 
  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/nre</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/nre</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.   <ul class="simple"><li><a class="reference" id="licencing-options_toc" href="#licencing-options">Options</a></li>
    55. 

  55. </ul><li><a class="reference" id="what-is-nreqmark_toc" href="#what-is-nreqmark">What is NRE?</a></li>
    56. 

  56. <ul class="simple"><li><a class="reference" id="what-is-nreqmark-licencing_toc" href="#what-is-nreqmark-licencing">Licencing</a></li>
    57. 

  57. </ul><li>
    58. 

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

  59. </li>
    60. 

  60. <li>
    61. 

  61.   <details open>
    62. 

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

  63.     <ul class="simple simple-toc-section">
    64. 

  64.       <li><a class="reference" href="#CaptureBounds" title="CaptureBounds = distinct RegexMatch">CaptureBounds</a></li>
    65. 

  65. <li><a class="reference" href="#Captures" title="Captures = distinct RegexMatch">Captures</a></li>
    66. 

  66. <li><a class="reference" href="#InvalidUnicodeError" title="InvalidUnicodeError = ref object of RegexError
    67. 

  67.   pos*: int                  ## the location of the invalid unicode in bytes">InvalidUnicodeError</a></li>
    68. 

  68. <li><a class="reference" href="#Regex" title="Regex = ref RegexDesc">Regex</a></li>
    69. 

  69. <li><a class="reference" href="#RegexDesc" title="RegexDesc = object
    70. 

  70.   pattern*: string
    71. 

  71.   ## not nil
    72. 

  72.   ## nil">RegexDesc</a></li>
    73. 

  73. <li><a class="reference" href="#RegexError" title="RegexError = ref object of CatchableError">RegexError</a></li>
    74. 

  74. <li><a class="reference" href="#RegexInternalError" title="RegexInternalError = ref object of RegexError">RegexInternalError</a></li>
    75. 

  75. <li><a class="reference" href="#RegexMatch" title="RegexMatch = object
    76. 

  76.   pattern*: Regex            ## The regex doing the matching.
    77. 

  77.                              ## Not nil.
    78. 

  78.   str*: string               ## The string that was matched against.
    79. 

  79.   ## First item is the bounds of the match
    80. 

  80.   ## Other items are the captures
    81. 

  81.   ## `a` is inclusive start, `b` is exclusive end">RegexMatch</a></li>
    82. 

  82. <li><a class="reference" href="#StudyError" title="StudyError = ref object of RegexError">StudyError</a></li>
    83. 

  83. <li><a class="reference" href="#SyntaxError" title="SyntaxError = ref object of RegexError
    84. 

  84.   pos*: int                  ## the location of the syntax error in bytes
    85. 

  85.   pattern*: string           ## the pattern that caused the problem">SyntaxError</a></li>
    86. 

  86. 

  87.     </ul>
    88. 

  88.   </details>
    89. 

  89. </li>
    90. 

  90. <li>
    91. 

  91.   <details open>
    92. 

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

  93.     <ul class="simple simple-toc-section">
    94. 

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

  95.   <li><a class="reference" href="#%24%2CRegexMatch" title="`$`(pattern: RegexMatch): string">`$`(pattern: RegexMatch): string</a></li>
    96. 

  96. 

  97. </ul>
    98. 

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

  99.   <li><a class="reference" href="#%3D%3D%2CRegex%2CRegex" title="`==`(a, b: Regex): bool">`==`(a, b: Regex): bool</a></li>
    100. 

  100. <li><a class="reference" href="#%3D%3D%2CRegexMatch%2CRegexMatch" title="`==`(a, b: RegexMatch): bool">`==`(a, b: RegexMatch): bool</a></li>
    101. 

  101. 

  102. </ul>
    103. 

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

  104.   <li><a class="reference" href="#%5B%5D%2CCaptureBounds%2Cint" title="`[]`(pattern: CaptureBounds; i: int): HSlice[int, int]">`[]`(pattern: CaptureBounds; i: int): HSlice[int, int]</a></li>
    105. 

  105. <li><a class="reference" href="#%5B%5D%2CCaptureBounds%2Cstring" title="`[]`(pattern: CaptureBounds; name: string): HSlice[int, int]">`[]`(pattern: CaptureBounds; name: string): HSlice[int, int]</a></li>
    106. 

  106. <li><a class="reference" href="#%5B%5D%2CCaptures%2Cint" title="`[]`(pattern: Captures; i: int): string">`[]`(pattern: Captures; i: int): string</a></li>
    107. 

  107. <li><a class="reference" href="#%5B%5D%2CCaptures%2Cstring" title="`[]`(pattern: Captures; name: string): string">`[]`(pattern: Captures; name: string): string</a></li>
    108. 

  108. 

  109. </ul>
    110. 

  110. <ul class="simple nested-toc-section">captureBounds
    111. 

  111.   <li><a class="reference" href="#captureBounds%2CRegexMatch" title="captureBounds(pattern: RegexMatch): CaptureBounds">captureBounds(pattern: RegexMatch): CaptureBounds</a></li>
    112. 

  112. 

  113. </ul>
    114. 

  114. <ul class="simple nested-toc-section">captureCount
    115. 

  115.   <li><a class="reference" href="#captureCount%2CRegex" title="captureCount(pattern: Regex): int">captureCount(pattern: Regex): int</a></li>
    116. 

  116. 

  117. </ul>
    118. 

  118. <ul class="simple nested-toc-section">captureNameId
    119. 

  119.   <li><a class="reference" href="#captureNameId%2CRegex" title="captureNameId(pattern: Regex): Table[string, int]">captureNameId(pattern: Regex): Table[string, int]</a></li>
    120. 

  120. 

  121. </ul>
    122. 

  122. <ul class="simple nested-toc-section">captures
    123. 

  123.   <li><a class="reference" href="#captures%2CRegexMatch" title="captures(pattern: RegexMatch): Captures">captures(pattern: RegexMatch): Captures</a></li>
    124. 

  124. 

  125. </ul>
    126. 

  126. <ul class="simple nested-toc-section">contains
    127. 

  127.   <li><a class="reference" href="#contains%2CCaptureBounds%2Cint" title="contains(pattern: CaptureBounds; i: int): bool">contains(pattern: CaptureBounds; i: int): bool</a></li>
    128. 

  128. <li><a class="reference" href="#contains%2CCaptureBounds%2Cstring" title="contains(pattern: CaptureBounds; name: string): bool">contains(pattern: CaptureBounds; name: string): bool</a></li>
    129. 

  129. <li><a class="reference" href="#contains%2CCaptures%2Cint" title="contains(pattern: Captures; i: int): bool">contains(pattern: Captures; i: int): bool</a></li>
    130. 

  130. <li><a class="reference" href="#contains%2CCaptures%2Cstring" title="contains(pattern: Captures; name: string): bool">contains(pattern: Captures; name: string): bool</a></li>
    131. 

  131. <li><a class="reference" href="#contains%2Cstring%2CRegex%2Cint" title="contains(str: string; pattern: Regex; start = 0; endpos = int.high): bool">contains(str: string; pattern: Regex; start = 0; endpos = int.high): bool</a></li>
    132. 

  132. 

  133. </ul>
    134. 

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

  135.   <li><a class="reference" href="#escapeRe%2Cstring" title="escapeRe(str: string): string">escapeRe(str: string): string</a></li>
    136. 

  136. 

  137. </ul>
    138. 

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

  139.   <li><a class="reference" href="#find%2Cstring%2CRegex%2Cint" title="find(str: string; pattern: Regex; start = 0; endpos = int.high): Option[
    140. 

  140.     RegexMatch]">find(str: string; pattern: Regex; start = 0; endpos = int.high): Option[
    141. 

  141.     RegexMatch]</a></li>
    142. 

  142. 

  143. </ul>
    144. 

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

  145.   <li><a class="reference" href="#findAll%2Cstring%2CRegex%2Cint" title="findAll(str: string; pattern: Regex; start = 0; endpos = int.high): seq[string]">findAll(str: string; pattern: Regex; start = 0; endpos = int.high): seq[string]</a></li>
    146. 

  146. 

  147. </ul>
    148. 

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

  149.   <li><a class="reference" href="#match%2CRegexMatch" title="match(pattern: RegexMatch): string">match(pattern: RegexMatch): string</a></li>
    150. 

  150. <li><a class="reference" href="#match%2Cstring%2CRegex%2Cint" title="match(str: string; pattern: Regex; start = 0; endpos = int.high): Option[
    151. 

  151.     RegexMatch]">match(str: string; pattern: Regex; start = 0; endpos = int.high): Option[
    152. 

  152.     RegexMatch]</a></li>
    153. 

  153. 

  154. </ul>
    155. 

  155. <ul class="simple nested-toc-section">matchBounds
    156. 

  156.   <li><a class="reference" href="#matchBounds%2CRegexMatch" title="matchBounds(pattern: RegexMatch): HSlice[int, int]">matchBounds(pattern: RegexMatch): HSlice[int, int]</a></li>
    157. 

  157. 

  158. </ul>
    159. 

  159. <ul class="simple nested-toc-section">re
    160. 

  160.   <li><a class="reference" href="#re%2Cstring" title="re(pattern: string): Regex">re(pattern: string): Regex</a></li>
    161. 

  161. 

  162. </ul>
    163. 

  163. <ul class="simple nested-toc-section">replace
    164. 

  164.   <li><a class="reference" href="#replace%2Cstring%2CRegex%2Cstring" title="replace(str: string; pattern: Regex; sub: string): string">replace(str: string; pattern: Regex; sub: string): string</a></li>
    165. 

  165. <li><a class="reference" href="#replace%2Cstring%2CRegex%2Cproc%28RegexMatch%29" title="replace(str: string; pattern: Regex; subproc: proc (match: RegexMatch): string): string">replace(str: string; pattern: Regex; subproc: proc (match: RegexMatch): string): string</a></li>
    166. 

  166. <li><a class="reference" href="#replace%2Cstring%2CRegex%2Cproc%28string%29" title="replace(str: string; pattern: Regex; subproc: proc (match: string): string): string">replace(str: string; pattern: Regex; subproc: proc (match: string): string): string</a></li>
    167. 

  167. 

  168. </ul>
    169. 

  169. <ul class="simple nested-toc-section">split
    170. 

  170.   <li><a class="reference" href="#split%2Cstring%2CRegex%2Cint%2Cint" title="split(str: string; pattern: Regex; maxSplit = -1; start = 0): seq[string]">split(str: string; pattern: Regex; maxSplit = -1; start = 0): seq[string]</a></li>
    171. 

  171. 

  172. </ul>
    173. 

  173. <ul class="simple nested-toc-section">toSeq
    174. 

  174.   <li><a class="reference" href="#toSeq%2CCaptureBounds" title="toSeq(pattern: CaptureBounds; default = none(HSlice[int, int])): seq[
    175. 

  175.     Option[HSlice[int, int]]]">toSeq(pattern: CaptureBounds; default = none(HSlice[int, int])): seq[
    176. 

  176.     Option[HSlice[int, int]]]</a></li>
    177. 

  177. <li><a class="reference" href="#toSeq%2CCaptures%2COption%5Bstring%5D" title="toSeq(pattern: Captures; default: Option[string] = none(string)): seq[
    178. 

  178.     Option[string]]">toSeq(pattern: Captures; default: Option[string] = none(string)): seq[
    179. 

  179.     Option[string]]</a></li>
    180. 

  180. 

  181. </ul>
    182. 

  182. <ul class="simple nested-toc-section">toTable
    183. 

  183.   <li><a class="reference" href="#toTable%2CCaptureBounds" title="toTable(pattern: CaptureBounds): Table[string, HSlice[int, int]]">toTable(pattern: CaptureBounds): Table[string, HSlice[int, int]]</a></li>
    184. 

  184. <li><a class="reference" href="#toTable%2CCaptures" title="toTable(pattern: Captures): Table[string, string]">toTable(pattern: Captures): Table[string, string]</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. 

  188.     </ul>
    189. 

  189.   </details>
    190. 

  190. </li>
    191. 

  191. <li>
    192. 

  192.   <details open>
    193. 

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

  194.     <ul class="simple simple-toc-section">
    195. 

  195.       <ul class="simple nested-toc-section">findIter
    196. 

  196.   <li><a class="reference" href="#findIter.i%2Cstring%2CRegex%2Cint" title="findIter(str: string; pattern: Regex; start = 0; endpos = int.high): RegexMatch">findIter(str: string; pattern: Regex; start = 0; endpos = int.high): RegexMatch</a></li>
    197. 

  197. 

  198. </ul>
    199. 

  199. <ul class="simple nested-toc-section">items
    200. 

  200.   <li><a class="reference" href="#items.i%2CCaptureBounds" title="items(pattern: CaptureBounds; default = none(HSlice[int, int])): Option[
    201. 

  201.     HSlice[int, int]]">items(pattern: CaptureBounds; default = none(HSlice[int, int])): Option[
    202. 

  202.     HSlice[int, int]]</a></li>
    203. 

  203. <li><a class="reference" href="#items.i%2CCaptures%2COption%5Bstring%5D" title="items(pattern: Captures; default: Option[string] = none(string)): Option[string]">items(pattern: Captures; default: Option[string] = none(string)): Option[string]</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. 

  207.     </ul>
    208. 

  208.   </details>
    209. 

  209. </li>
    210. 

  210. 

  211. </ul>
    212. 

  212. 

  213.   </div>
    214. 

  214.   <div class="nine columns" id="content">
    215. 

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

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

  217. 

  218.     <div id="tocRoot"></div>
    219. 

  219.     
    220. 

  220.     <p class="module-desc">
    221. 

  221. <h1><a class="toc-backref" id="what-is-nreqmark" href="#what-is-nreqmark">What is NRE?</a></h1><p>A regular expression library for Nim using PCRE to do the hard work.</p>
    222. 

  222. <p>For documentation on how to write patterns, there exists <a class="reference external" href="https://www.pcre.org/original/doc/html/pcrepattern.html">the official PCRE pattern documentation</a>. You can also search the internet for a wide variety of third-party documentation and tools.</p>
    223. 

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

  224. If you love <tt class="docutils literal"><span class="pre"><span class="Identifier">sequtils</span><span class="Operator">.</span><span class="Identifier">toSeq</span></span></tt> we have bad news for you. This library doesn't work with it due to documented compiler limitations. As a workaround, use this:</div>
    225. 

  225. 

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

  227. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">nre</span>
    228. 

  228. <span class="Comment"># either `import std/nre except toSeq` or fully qualify `sequtils.toSeq`:</span>
    229. 

  229. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sequtils</span>
    230. 

  230. <span class="Keyword">iterator</span> <span class="Identifier">iota</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Operator">=</span>
    231. 

  231.   <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="FloatNumber">0.</span><span class="Operator">.&lt;</span><span class="Identifier">n</span><span class="Punctuation">:</span> <span class="Keyword">yield</span> <span class="Identifier">i</span>
    232. 

  232. <span class="Identifier">assert</span> <span class="Identifier">sequtils</span><span class="Operator">.</span><span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">iota</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span></pre><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    233. 

  233. There are also alternative nimble packages such as <a class="reference external" href="https://github.com/khchen/tinyre">tinyre</a> and <a class="reference external" href="https://github.com/nitely/nim-regex">regex</a>.</div>
    234. 

  234. 

  235. <h2><a class="toc-backref" id="what-is-nreqmark-licencing" href="#what-is-nreqmark-licencing">Licencing</a></h2><p>PCRE has <a class="reference external" href="https://pcre.sourceforge.net/license.txt">some additional terms</a> that you must agree to in order to use this module.</p>
    236. 

  236. 

  237. <p><strong class="examples_text">Example:</strong></p>
    238. 

  238. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">nre</span>
    239. 

  239. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
    240. 

  240. <span class="Keyword">let</span> <span class="Identifier">vowels</span> <span class="Operator">=</span> <span class="RawData">re&quot;[aeoui]&quot;</span>
    241. 

  241. <span class="Keyword">let</span> <span class="Identifier">bounds</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">:</span>
    242. 

  242.   <span class="Keyword">for</span> <span class="Identifier">match</span> <span class="Keyword">in</span> <span class="StringLit">&quot;moiga&quot;</span><span class="Operator">.</span><span class="Identifier">findIter</span><span class="Punctuation">(</span><span class="Identifier">vowels</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">match</span><span class="Operator">.</span><span class="Identifier">matchBounds</span>
    243. 

  243. <span class="Identifier">assert</span> <span class="Identifier">bounds</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span> <span class="Operator">..</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span> <span class="Operator">..</span> <span class="DecNumber">4</span><span class="Punctuation">]</span>
    244. 

  244. <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>
    245. 

  245. <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">sequtils</span><span class="Operator">.</span><span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="StringLit">&quot;moiga&quot;</span><span class="Operator">.</span><span class="Identifier">findIter</span><span class="Punctuation">(</span><span class="Identifier">vowels</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    246. 

  246.   <span class="Comment"># fully qualified to avoid confusion with nre.toSeq</span>
    247. 

  247. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    248. 

  248. 

  249. <span class="Keyword">let</span> <span class="Identifier">firstVowel</span> <span class="Operator">=</span> <span class="StringLit">&quot;foo&quot;</span><span class="Operator">.</span><span class="Identifier">find</span><span class="Punctuation">(</span><span class="Identifier">vowels</span><span class="Punctuation">)</span>
    250. 

  250. <span class="Keyword">let</span> <span class="Identifier">hasVowel</span> <span class="Operator">=</span> <span class="Identifier">firstVowel</span><span class="Operator">.</span><span class="Identifier">isSome</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    251. 

  251. <span class="Identifier">assert</span> <span class="Identifier">hasVowel</span>
    252. 

  252. <span class="Keyword">let</span> <span class="Identifier">matchBounds</span> <span class="Operator">=</span> <span class="Identifier">firstVowel</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">captureBounds</span><span class="Punctuation">[</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    253. 

  253. <span class="Identifier">assert</span> <span class="Identifier">matchBounds</span><span class="Operator">.</span><span class="Identifier">a</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    254. 

  254. 

  255. <span class="Comment"># as with module `re`, unless specified otherwise, `start` parameter in each</span>
    256. 

  256. <span class="Comment"># proc indicates where the scan starts, but outputs are relative to the start</span>
    257. 

  257. <span class="Comment"># of the input string, not to `start`:</span>
    258. 

  258. <span class="Identifier">assert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;uxabc&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(?&lt;=x|y)ab&quot;</span><span class="Punctuation">,</span> <span class="Identifier">start</span> <span class="Operator">=</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captures</span><span class="Punctuation">[</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;ab&quot;</span>
    259. 

  259. <span class="Identifier">assert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;uxabc&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;ab&quot;</span><span class="Punctuation">,</span> <span class="Identifier">start</span> <span class="Operator">=</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">isNone</span></pre></p>
    260. 

  260.     <div class="section" id="6">
    261. 

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

  262.   <dl class="item">
    263. 

  263.     <a class="reference external" href="pcre.html">pcre</a>, <a class="reference external" href="util.html">util</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="options.html">options</a>, <a class="reference external" href="unicode.html">unicode</a>, <a class="reference external" href="assertions.html">assertions</a>
    264. 

  264.   </dl>
    265. 

  265. </div>
    266. 

  266. <div class="section" id="7">
    267. 

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

  268.   <dl class="item">
    269. 

  269.     <div id="CaptureBounds">
    270. 

  270.   <dt><pre><a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a></pre></dt>
    271. 

  271.   <dd>
    272. 

  272.     
    273. 

  273.     
    274. 

  274.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    275. 

  275. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    276. 

  276. 

  277.   </dd>
    278. 

  278. </div>
    279. 

  279. <div id="Captures">
    280. 

  280.   <dt><pre><a href="nre.html#Captures"><span class="Identifier">Captures</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a></pre></dt>
    281. 

  281.   <dd>
    282. 

  282.     
    283. 

  283.     
    284. 

  284.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L198" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    285. 

  285. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L198" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    286. 

  286. 

  287.   </dd>
    288. 

  288. </div>
    289. 

  289. <div id="InvalidUnicodeError">
    290. 

  290.   <dt><pre><a href="nre.html#InvalidUnicodeError"><span class="Identifier">InvalidUnicodeError</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="nre.html#RegexError"><span class="Identifier">RegexError</span></a>
    291. 

  291.   <span class="Identifier">pos</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>                  <span class="Comment">## the location of the invalid unicode in bytes</span></pre></dt>
    292. 

  292.   <dd>
    293. 

  293.     
    294. 

  294.     Thrown when matching fails due to invalid unicode in strings
    295. 

  295.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L206" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    296. 

  296. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L206" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    297. 

  297. 

  298.   </dd>
    299. 

  299. </div>
    300. 

  300. <div id="Regex">
    301. 

  301.   <dt><pre><a href="nre.html#Regex"><span class="Identifier">Regex</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="nre.html#RegexDesc"><span class="Identifier">RegexDesc</span></a></pre></dt>
    302. 

  302.   <dd>
    303. 

  303.     
    304. 

  304.     Represents the pattern that things are matched against, constructed with <tt class="docutils literal"><span class="pre"><span class="Identifier">re</span><span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span></span></tt>. Examples: <tt class="docutils literal"><span class="pre"><span class="RawData">re&quot;foo&quot;</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">re</span><span class="Punctuation">(</span><span class="RawData">r&quot;(*ANYCRLF)(?x)foo # comment&quot;</span><span class="Operator">.</span></span></tt><dl class="docutils"><dt><tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span><span class="Punctuation">:</span> <span class="Identifier">string</span></span></tt></dt>
    305. 

  305. <dd>the string that was used to create the pattern. For details on how to write a pattern, please see <a class="reference external" href="https://www.pcre.org/original/doc/html/pcrepattern.html">the official PCRE pattern documentation.</a></dd>
    306. 

  306. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">captureCount</span><span class="Punctuation">:</span> <span class="Identifier">int</span></span></tt></dt>
    307. 

  307. <dd>the number of captures that the pattern has.</dd>
    308. 

  308. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">captureNameId</span><span class="Punctuation">:</span> <span class="Identifier">Table</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span></span></tt></dt>
    309. 

  309. <dd>a table from the capture names to their numeric id.</dd>
    310. 

  310. </dl>
    311. 

  311. 

  312. <h3><a class="toc-backref" id="licencing-options" href="#licencing-options">Options</a></h3><p>The following options may appear anywhere in the pattern, and they affect the rest of it.</p>
    313. 

  313. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?</span><span class="Identifier">i</span><span class="Punctuation">)</span></span></tt> - case insensitive</li>
    314. 

  314. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?</span><span class="Identifier">m</span><span class="Punctuation">)</span></span></tt> - multi-line: <tt class="docutils literal"><span class="pre"><span class="Operator">^</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> match the beginning and end of lines, not of the subject string</li>
    315. 

  315. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?</span><span class="Identifier">s</span><span class="Punctuation">)</span></span></tt> - <tt class="docutils literal"><span class="pre"><span class="Operator">.</span></span></tt> also matches newline (<em>dotall</em>)</li>
    316. 

  316. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?</span><span class="Identifier">U</span><span class="Punctuation">)</span></span></tt> - expressions are not greedy by default. <tt class="docutils literal"><span class="pre"><span class="Operator">?</span></span></tt> can be added to a qualifier to make it greedy</li>
    317. 

  317. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt> - whitespace and comments (<tt class="docutils literal"><span class="pre"><span class="Comment">#</span></span></tt>) are ignored (<em>extended</em>)</li>
    318. 

  318. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?</span><span class="Identifier">X</span><span class="Punctuation">)</span></span></tt> - character escapes without special meaning (<tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">w</span></span></tt> vs. <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">a</span></span></tt>) are errors (<em>extra</em>)</li>
    319. 

  319. </ul>
    320. 

  320. <p>One or a combination of these options may appear only at the beginning of the pattern:</p>
    321. 

  321. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">UTF8</span><span class="Punctuation">)</span></span></tt> - treat both the pattern and subject as UTF-8</li>
    322. 

  322. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">UCP</span><span class="Punctuation">)</span></span></tt> - Unicode character properties; <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">w</span></span></tt> matches <tt class="docutils literal"><span class="pre"><span class="Identifier">я</span></span></tt></li>
    323. 

  323. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">U</span><span class="Punctuation">)</span></span></tt> - a combination of the two options above</li>
    324. 

  324. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">FIRSTLINE</span><span class="Operator">*</span><span class="Punctuation">)</span></span></tt> - fails if there is not a match on the first line</li>
    325. 

  325. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">NO_AUTO_CAPTURE</span><span class="Punctuation">)</span></span></tt> - turn off auto-capture for groups; <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">?&lt;</span><span class="Identifier">name</span><span class="Operator">&gt;...</span><span class="Punctuation">)</span></span></tt> can be used to capture</li>
    326. 

  326. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">CR</span><span class="Punctuation">)</span></span></tt> - newlines are separated by <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span></span></tt></li>
    327. 

  327. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">LF</span><span class="Punctuation">)</span></span></tt> - newlines are separated by <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">n</span></span></tt> (UNIX default)</li>
    328. 

  328. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">CRLF</span><span class="Punctuation">)</span></span></tt> - newlines are separated by <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span><span class="Operator">\</span><span class="Identifier">n</span></span></tt> (Windows default)</li>
    329. 

  329. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">ANYCRLF</span><span class="Punctuation">)</span></span></tt> - newlines are separated by any of the above</li>
    330. 

  330. <li><p><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">ANY</span><span class="Punctuation">)</span></span></tt> - newlines are separated by any of the above and Unicode newlines:</p>
    331. 

  331. <p>single characters VT (vertical tab, U+000B), FF (form feed, U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS (paragraph separator, U+2029). For the 8-bit library, the last two are recognized only in UTF-8 mode. —  man pcre</p>
    332. 

  332. </li>
    333. 

  333. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">JAVASCRIPT_COMPAT</span><span class="Punctuation">)</span></span></tt> - JavaScript compatibility</li>
    334. 

  334. <li><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">*</span><span class="Identifier">NO_STUDY</span><span class="Punctuation">)</span></span></tt> - turn off studying; study is enabled by default</li>
    335. 

  335. </ul>
    336. 

  336. <p>For more details on the leading option groups, see the <a class="reference external" href="https://man7.org/linux/man-pages/man3/pcresyntax.3.html#OPTION_SETTING">Option Setting</a> and the <a class="reference external" href="https://man7.org/linux/man-pages/man3/pcresyntax.3.html#NEWLINE_CONVENTION">Newline Convention</a> sections of the <a class="reference external" href="https://man7.org/linux/man-pages/man3/pcresyntax.3.html">PCRE syntax manual</a>.</p>
    337. 

  337. <p>Some of these options are not part of PCRE and are converted by nre into PCRE flags. These include <tt class="docutils literal"><span class="pre"><span class="Identifier">NEVER_UTF</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">ANCHORED</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">DOLLAR_ENDONLY</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">FIRSTLINE</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">NO_AUTO_CAPTURE</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">JAVASCRIPT_COMPAT</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">U</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">NO_STUDY</span></span></tt>. In other PCRE wrappers, you will need to pass these as separate flags to PCRE.</p>
    338. 

  338. 

  339.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L84" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    340. 

  340. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L84" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    341. 

  341. 

  342.   </dd>
    343. 

  343. </div>
    344. 

  344. <div id="RegexDesc">
    345. 

  345.   <dt><pre><a href="nre.html#RegexDesc"><span class="Identifier">RegexDesc</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    346. 

  346.   <span class="Identifier">pattern</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>
    347. 

  347.   <span class="Comment">## not nil</span>
    348. 

  348.   <span class="Comment">## nil</span></pre></dt>
    349. 

  349.   <dd>
    350. 

  350.     
    351. 

  351.     
    352. 

  352.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L77" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    353. 

  353. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L77" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    354. 

  354. 

  355.   </dd>
    356. 

  356. </div>
    357. 

  357. <div id="RegexError">
    358. 

  358.   <dt><pre><a href="nre.html#RegexError"><span class="Identifier">RegexError</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#CatchableError"><span class="Identifier">CatchableError</span></a></pre></dt>
    359. 

  359.   <dd>
    360. 

  360.     
    361. 

  361.     
    362. 

  362.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L201" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    363. 

  363. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L201" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    364. 

  364. 

  365.   </dd>
    366. 

  366. </div>
    367. 

  367. <div id="RegexInternalError">
    368. 

  368.   <dt><pre><a href="nre.html#RegexInternalError"><span class="Identifier">RegexInternalError</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="nre.html#RegexError"><span class="Identifier">RegexError</span></a></pre></dt>
    369. 

  369.   <dd>
    370. 

  370.     
    371. 

  371.     Internal error in the module, this probably means that there is a bug
    372. 

  372.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L203" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    373. 

  373. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L203" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    374. 

  374. 

  375.   </dd>
    376. 

  376. </div>
    377. 

  377. <div id="RegexMatch">
    378. 

  378.   <dt><pre><a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    379. 

  379.   <span class="Identifier">pattern</span><span class="Operator">*</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a>            <span class="Comment">## The regex doing the matching.</span>
    380. 

  380.                              <span class="Comment">## Not nil.</span>
    381. 

  381.   <span class="Identifier">str</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>               <span class="Comment">## The string that was matched against.</span>
    382. 

  382.   <span class="Comment">## First item is the bounds of the match</span>
    383. 

  383.   <span class="Comment">## Other items are the captures</span>
    384. 

  384.   <span class="Comment">## `a` is inclusive start, `b` is exclusive end</span></pre></dt>
    385. 

  385.   <dd>
    386. 

  386.     
    387. 

  387.     Usually seen as Option<a class="reference internal nimdoc" title="object RegexMatch" href="#RegexMatch">RegexMatch</a>, it represents the result of an execution. On failure, it is none, on success, it is some.<dl class="docutils"><dt><tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span><span class="Punctuation">:</span> <span class="Identifier">Regex</span></span></tt></dt>
    388. 

  388. <dd>the pattern that is being matched</dd>
    389. 

  389. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">str</span><span class="Punctuation">:</span> <span class="Identifier">string</span></span></tt></dt>
    390. 

  390. <dd>the string that was matched against</dd>
    391. 

  391. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">captures</span><span class="Punctuation">[</span><span class="Punctuation">]</span><span class="Punctuation">:</span> <span class="Identifier">string</span></span></tt></dt>
    392. 

  392. <dd>the string value of whatever was captured at that id. If the value is invalid, then behavior is undefined. If the id is <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt>, then the whole match is returned. If the given capture was not matched, <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt> is returned. See examples for <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt>.</dd>
    393. 

  393. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">captureBounds</span><span class="Punctuation">[</span><span class="Punctuation">]</span><span class="Punctuation">:</span> <span class="Identifier">HSlice</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span></span></tt></dt>
    394. 

  394. <dd>gets the bounds of the given capture according to the same rules as the above. If the capture is not filled, then <tt class="docutils literal"><span class="pre"><span class="Identifier">None</span></span></tt> is returned. The bounds are both inclusive.  See examples for <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt>.</dd>
    395. 

  395. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">match</span><span class="Punctuation">:</span> <span class="Identifier">string</span></span></tt></dt>
    396. 

  396. <dd>the full text of the match.</dd>
    397. 

  397. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">matchBounds</span><span class="Punctuation">:</span> <span class="Identifier">HSlice</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span></span></tt></dt>
    398. 

  398. <dd>the bounds of the match, as in <tt class="docutils literal"><span class="pre"><span class="Identifier">captureBounds</span><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt></dd>
    399. 

  399. <dt><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">captureBounds</span><span class="Operator">|</span><span class="Identifier">captures</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">toTable</span></span></tt></dt>
    400. 

  400. <dd>returns a table with each named capture as a key.</dd>
    401. 

  401. <dt><tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">captureBounds</span><span class="Operator">|</span><span class="Identifier">captures</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">toSeq</span></span></tt></dt>
    402. 

  402. <dd>returns all the captures by their number.</dd>
    403. 

  403. <dt><tt class="docutils literal"><span class="pre"><span class="Operator">$:</span> <span class="Identifier">string</span></span></tt></dt>
    404. 

  404. <dd>same as <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt></dd>
    405. 

  405. </dl>
    406. 

  406. 

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

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

  409. 

  410.   </dd>
    411. 

  411. </div>
    412. 

  412. <div id="StudyError">
    413. 

  413.   <dt><pre><a href="nre.html#StudyError"><span class="Identifier">StudyError</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="nre.html#RegexError"><span class="Identifier">RegexError</span></a></pre></dt>
    414. 

  414.   <dd>
    415. 

  415.     
    416. 

  416.     Thrown when studying the regular expression fails for whatever reason. The message contains the error code.
    417. 

  417.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L216" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    418. 

  418. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L216" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    419. 

  419. 

  420.   </dd>
    421. 

  421. </div>
    422. 

  422. <div id="SyntaxError">
    423. 

  423.   <dt><pre><a href="nre.html#SyntaxError"><span class="Identifier">SyntaxError</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="nre.html#RegexError"><span class="Identifier">RegexError</span></a>
    424. 

  424.   <span class="Identifier">pos</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>                  <span class="Comment">## the location of the syntax error in bytes</span>
    425. 

  425.   <span class="Identifier">pattern</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>           <span class="Comment">## the pattern that caused the problem</span></pre></dt>
    426. 

  426.   <dd>
    427. 

  427.     
    428. 

  428.     Thrown when there is a syntax error in the regular expression string passed in
    429. 

  429.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L210" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    430. 

  430. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L210" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    431. 

  431. 

  432.   </dd>
    433. 

  433. </div>
    434. 

  434. 

  435.   </dl>
    436. 

  436. </div>
    437. 

  437. <div class="section" id="12">
    438. 

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

  439.   <dl class="item">
    440. 

  440.     <div id="$-procs-all">
    441. 

  441.   <div id="$,RegexMatch">
    442. 

  442.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CRegexMatch"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</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>
    443. 

  443.   <dd>
    444. 

  444.     
    445. 

  445.     
    446. 

  446.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L429" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    447. 

  447. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L429" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    448. 

  448. 

  449.   </dd>
    450. 

  450. </div>
    451. 

  451. 

  452. </div>
    453. 

  453. <div id="==-procs-all">
    454. 

  454.   <div id="==,Regex,Regex">
    455. 

  455.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CRegex%2CRegex"><span class="Identifier">`==`</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="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    456. 

  456.   <dd>
    457. 

  457.     
    458. 

  458.     
    459. 

  459.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L432" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    460. 

  460. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L432" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    461. 

  461. 

  462.   </dd>
    463. 

  463. </div>
    464. 

  464. <div id="==,RegexMatch,RegexMatch">
    465. 

  465.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CRegexMatch%2CRegexMatch"><span class="Identifier">`==`</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="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    466. 

  466.   <dd>
    467. 

  467.     
    468. 

  468.     
    469. 

  469.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L440" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    470. 

  470. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L440" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    471. 

  471. 

  472.   </dd>
    473. 

  473. </div>
    474. 

  474. 

  475. </div>
    476. 

  476. <div id="[]-procs-all">
    477. 

  477.   <div id="[],CaptureBounds,int">
    478. 

  478.   <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CCaptureBounds%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</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#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.<span><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>
    479. 

  479.     <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>
    480. 

  480.   <dd>
    481. 

  481.     
    482. 

  482.     
    483. 

  483.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    484. 

  484. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    485. 

  485. 

  486.   </dd>
    487. 

  487. </div>
    488. 

  488. <div id="[],CaptureBounds,string">
    489. 

  489.   <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CCaptureBounds%2Cstring"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</span></a><span class="Other">;</span> <span class="Identifier">name</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#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.
    490. 

  490.     <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="Identifier">KeyError</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>
    491. 

  491.   <dd>
    492. 

  492.     
    493. 

  493.     
    494. 

  494.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L375" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    495. 

  495. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L375" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    496. 

  496. 

  497.   </dd>
    498. 

  498. </div>
    499. 

  499. <div id="[],Captures,int">
    500. 

  500.   <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CCaptures%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</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#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>
    501. 

  501.   <dd>
    502. 

  502.     
    503. 

  503.     
    504. 

  504.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L349" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    505. 

  505. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L349" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    506. 

  506. 

  507.   </dd>
    508. 

  508. </div>
    509. 

  509. <div id="[],Captures,string">
    510. 

  510.   <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CCaptures%2Cstring"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</span></a><span class="Other">;</span> <span class="Identifier">name</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#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="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    511. 

  511.     <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>
    512. 

  512.   <dd>
    513. 

  513.     
    514. 

  514.     
    515. 

  515.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L381" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    516. 

  516. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L381" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    517. 

  517. 

  518.   </dd>
    519. 

  519. </div>
    520. 

  520. 

  521. </div>
    522. 

  522. <div id="captureBounds-procs-all">
    523. 

  523.   <div id="captureBounds,RegexMatch">
    524. 

  524.   <dt><pre><span class="Keyword">func</span> <a href="#captureBounds%2CRegexMatch"><span class="Identifier">captureBounds</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">)</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</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>
    525. 

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

  526.   <dd>
    527. 

  527.     
    528. 

  528.     
    529. 

  529.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L330" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    530. 

  530. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L330" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    531. 

  531. 

  532.   </dd>
    533. 

  533. </div>
    534. 

  534. 

  535. </div>
    536. 

  536. <div id="captureCount-procs-all">
    537. 

  537.   <div id="captureCount,Regex">
    538. 

  538.   <dt><pre><span class="Keyword">proc</span> <a href="#captureCount%2CRegex"><span class="Identifier">captureCount</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</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">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>
    539. 

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

  540.   <dd>
    541. 

  541.     
    542. 

  542.     
    543. 

  543.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L302" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    544. 

  544. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L302" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    545. 

  545. 

  546.   </dd>
    547. 

  547. </div>
    548. 

  548. 

  549. </div>
    550. 

  550. <div id="captureNameId-procs-all">
    551. 

  551.   <div id="captureNameId,Regex">
    552. 

  552.   <dt><pre><span class="Keyword">proc</span> <a href="#captureNameId%2CRegex"><span class="Identifier">captureNameId</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">)</span><span class="Other">:</span> <a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><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>
    553. 

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

  554.   <dd>
    555. 

  555.     
    556. 

  556.     
    557. 

  557.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L305" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    558. 

  558. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L305" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    559. 

  559. 

  560.   </dd>
    561. 

  561. </div>
    562. 

  562. 

  563. </div>
    564. 

  564. <div id="captures-procs-all">
    565. 

  565.   <div id="captures,RegexMatch">
    566. 

  566.   <dt><pre><span class="Keyword">func</span> <a href="#captures%2CRegexMatch"><span class="Identifier">captures</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">)</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</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>
    567. 

  567.   <dd>
    568. 

  568.     
    569. 

  569.     
    570. 

  570.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L332" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    571. 

  571. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L332" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    572. 

  572. 

  573.   </dd>
    574. 

  574. </div>
    575. 

  575. 

  576. </div>
    577. 

  577. <div id="contains-procs-all">
    578. 

  578.   <div id="contains,CaptureBounds,int">
    579. 

  579.   <dt><pre><span class="Keyword">func</span> <a href="#contains%2CCaptureBounds%2Cint"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</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#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    580. 

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

  581.   <dd>
    582. 

  582.     
    583. 

  583.     
    584. 

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

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

  586. 

  587.   </dd>
    588. 

  588. </div>
    589. 

  589. <div id="contains,CaptureBounds,string">
    590. 

  590.   <dt><pre><span class="Keyword">func</span> <a href="#contains%2CCaptureBounds%2Cstring"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</span></a><span class="Other">;</span> <span class="Identifier">name</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    591. 

  591.     <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>
    592. 

  592.   <dd>
    593. 

  593.     
    594. 

  594.     
    595. 

  595.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L361" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    596. 

  596. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L361" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    597. 

  597. 

  598.   </dd>
    599. 

  599. </div>
    600. 

  600. <div id="contains,Captures,int">
    601. 

  601.   <dt><pre><span class="Keyword">func</span> <a href="#contains%2CCaptures%2Cint"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</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#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    602. 

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

  603.   <dd>
    604. 

  604.     
    605. 

  605.     
    606. 

  606.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L338" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    607. 

  607. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L338" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    608. 

  608. 

  609.   </dd>
    610. 

  610. </div>
    611. 

  611. <div id="contains,Captures,string">
    612. 

  612.   <dt><pre><span class="Keyword">func</span> <a href="#contains%2CCaptures%2Cstring"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</span></a><span class="Other">;</span> <span class="Identifier">name</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    613. 

  613.     <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>
    614. 

  614.   <dd>
    615. 

  615.     
    616. 

  616.     
    617. 

  617.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L368" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    618. 

  618. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L368" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    619. 

  619. 

  620.   </dd>
    621. 

  621. </div>
    622. 

  622. <div id="contains,string,Regex,int">
    623. 

  623.   <dt><pre><span class="Keyword">proc</span> <a href="#contains%2Cstring%2CRegex%2Cint"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">endpos</span> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    624. 

  624.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</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>
    625. 

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

  626.   <dd>
    627. 

  627.     
    628. 

  628.     Determine if the string contains the given pattern between the end and start positions: This function is equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">isSome</span><span class="Punctuation">(</span><span class="Identifier">str</span><span class="Operator">.</span><span class="Identifier">find</span><span class="Punctuation">(</span><span class="Identifier">pattern</span><span class="Punctuation">,</span> <span class="Identifier">start</span><span class="Punctuation">,</span> <span class="Identifier">endpos</span><span class="Punctuation">)</span><span class="Punctuation">)</span></span></tt>.
    629. 

  629. <p><strong class="examples_text">Example:</strong></p>
    630. 

  630. <pre class="listing"><span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="RawData">re&quot;bc&quot;</span><span class="Punctuation">)</span>
    631. 

  631. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="RawData">re&quot;cd&quot;</span><span class="Punctuation">)</span>
    632. 

  632. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="RawData">re&quot;a&quot;</span><span class="Punctuation">,</span> <span class="Identifier">start</span> <span class="Operator">=</span> <span class="DecNumber">1</span><span class="Punctuation">)</span></pre>
    633. 

  633.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L628" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    634. 

  634. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L628" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    635. 

  635. 

  636.   </dd>
    637. 

  637. </div>
    638. 

  638. 

  639. </div>
    640. 

  640. <div id="escapeRe-procs-all">
    641. 

  641.   <div id="escapeRe,string">
    642. 

  642.   <dt><pre><span class="Keyword">proc</span> <a href="#escapeRe%2Cstring"><span class="Identifier">escapeRe</span></a><span class="Other">(</span><span class="Identifier">str</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#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">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>
    643. 

  643.   <dd>
    644. 

  644.     
    645. 

  645.     <p>Escapes the string so it doesn't match any special characters. Incompatible with the Extra flag (<tt class="docutils literal"><span class="pre"><span class="Identifier">X</span></span></tt>).</p>
    646. 

  646. <p>Escaped char: <tt class="docutils literal"><span class="pre"><span class="Operator">\</span> <span class="Operator">+</span> <span class="Operator">*</span> <span class="Operator">?</span> <span class="Punctuation">[</span> <span class="Operator">^</span> <span class="Punctuation">]</span> <span class="Operator">$</span> <span class="Punctuation">(</span> <span class="Punctuation">)</span> <span class="Punctuation">{</span> <span class="Punctuation">}</span> <span class="Operator">=</span> <span class="Operator">!</span> <span class="Operator">&lt;</span> <span class="Operator">&gt;</span> <span class="Operator">|</span> <span class="Punctuation">:</span> <span class="Operator">-</span></span></tt></p>
    647. 

  647. 

  648. <p><strong class="examples_text">Example:</strong></p>
    649. 

  649. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">escapeRe</span><span class="Punctuation">(</span><span class="StringLit">&quot;fly+wind&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;fly</span><span class="EscapeSequence">\\</span><span class="StringLit">+wind&quot;</span>
    650. 

  650. <span class="Identifier">assert</span> <span class="Identifier">escapeRe</span><span class="Punctuation">(</span><span class="StringLit">&quot;!&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\\</span><span class="StringLit">!&quot;</span>
    651. 

  651. <span class="Identifier">assert</span> <span class="Identifier">escapeRe</span><span class="Punctuation">(</span><span class="StringLit">&quot;nim*&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;nim</span><span class="EscapeSequence">\\</span><span class="StringLit">*&quot;</span></pre>
    652. 

  652.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L752" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    653. 

  653. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L752" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    654. 

  654. 

  655.   </dd>
    656. 

  656. </div>
    657. 

  657. 

  658. </div>
    659. 

  659. <div id="find-procs-all">
    660. 

  660.   <div id="find,string,Regex,int">
    661. 

  661.   <dt><pre><span class="Keyword">proc</span> <a href="#find%2Cstring%2CRegex%2Cint"><span class="Identifier">find</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">endpos</span> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span>
    662. 

  662.     <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</span><span class="Other">]</span><span class="Other">,</span>
    663. 

  663.                   <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>
    664. 

  664.   <dd>
    665. 

  665.     
    666. 

  666.     Finds the given pattern in the string between the end and start positions.<dl class="docutils"><dt><tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt></dt>
    667. 

  667. <dd>The start point at which to start matching. <tt class="docutils literal"><span class="pre"><span class="Operator">|</span><span class="Identifier">abc</span></span></tt> is <tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt>; <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Operator">|</span><span class="Identifier">bc</span></span></tt> is <tt class="docutils literal"><span class="pre"><span class="DecNumber">1</span></span></tt></dd>
    668. 

  668. <dt><tt class="docutils literal"><span class="pre"><span class="Identifier">endpos</span></span></tt></dt>
    669. 

  669. <dd>The maximum index for a match; <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span><span class="Operator">.</span><span class="Identifier">high</span></span></tt> means the end of the string, otherwise it’s an inclusive upper bound.</dd>
    670. 

  670. </dl>
    671. 

  671. 

  672.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L610" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    673. 

  673. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L610" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    674. 

  674. 

  675.   </dd>
    676. 

  676. </div>
    677. 

  677. 

  678. </div>
    679. 

  679. <div id="findAll-procs-all">
    680. 

  680.   <div id="findAll,string,Regex,int">
    681. 

  681.   <dt><pre><span class="Keyword">proc</span> <a href="#findAll%2Cstring%2CRegex%2Cint"><span class="Identifier">findAll</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">endpos</span> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span>
    682. 

  682.     <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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</span><span class="Other">]</span><span class="Other">,</span>
    683. 

  683.               <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>
    684. 

  684.   <dd>
    685. 

  685.     
    686. 

  686.     
    687. 

  687.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L623" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    688. 

  688. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L623" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    689. 

  689. 

  690.   </dd>
    691. 

  691. </div>
    692. 

  692. 

  693. </div>
    694. 

  694. <div id="match-procs-all">
    695. 

  695.   <div id="match,RegexMatch">
    696. 

  696.   <dt><pre><span class="Keyword">func</span> <a href="#match%2CRegexMatch"><span class="Identifier">match</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</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>
    697. 

  697.   <dd>
    698. 

  698.     
    699. 

  699.     
    700. 

  700.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L355" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    701. 

  701. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L355" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    702. 

  702. 

  703.   </dd>
    704. 

  704. </div>
    705. 

  705. <div id="match,string,Regex,int">
    706. 

  706.   <dt><pre><span class="Keyword">proc</span> <a href="#match%2Cstring%2CRegex%2Cint"><span class="Identifier">match</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">endpos</span> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span>
    707. 

  707.     <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</span><span class="Other">]</span><span class="Other">,</span>
    708. 

  708.                   <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>
    709. 

  709.   <dd>
    710. 

  710.     
    711. 

  711.     Like <a class="reference external" href="#find,string,Regex,int">find(...)</a>, but anchored to the start of the string.
    712. 

  712. <p><strong class="examples_text">Example:</strong></p>
    713. 

  713. <pre class="listing"><span class="Identifier">assert</span> <span class="StringLit">&quot;foo&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;f&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">isSome</span>
    714. 

  714. <span class="Identifier">assert</span> <span class="StringLit">&quot;foo&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;o&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">isNone</span>
    715. 

  715. 

  716. <span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w)&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captures</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
    717. 

  717. <span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(?&lt;letter&gt;\w)&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captures</span><span class="Punctuation">[</span><span class="StringLit">&quot;letter&quot;</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
    718. 

  718. <span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w)\w&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captures</span><span class="Punctuation">[</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;ab&quot;</span>
    719. 

  719. 

  720. <span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w)&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captureBounds</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">0</span>
    721. 

  721. <span class="Identifier">assert</span> <span class="DecNumber">0</span> <span class="Keyword">in</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w)&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captureBounds</span>
    722. 

  722. <span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captureBounds</span><span class="Punctuation">[</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="DecNumber">0</span> <span class="Operator">..</span> <span class="Operator">-</span><span class="DecNumber">1</span>
    723. 

  723. <span class="Identifier">assert</span> <span class="StringLit">&quot;abc&quot;</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">(</span><span class="RawData">re&quot;abc&quot;</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">get</span><span class="Operator">.</span><span class="Identifier">captureBounds</span><span class="Punctuation">[</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">2</span></pre>
    724. 

  724.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L542" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    725. 

  725. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L542" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    726. 

  726. 

  727.   </dd>
    728. 

  728. </div>
    729. 

  729. 

  730. </div>
    731. 

  731. <div id="matchBounds-procs-all">
    732. 

  732.   <div id="matchBounds,RegexMatch">
    733. 

  733.   <dt><pre><span class="Keyword">func</span> <a href="#matchBounds%2CRegexMatch"><span class="Identifier">matchBounds</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.<span><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>
    734. 

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

  735.   <dd>
    736. 

  736.     
    737. 

  737.     
    738. 

  738.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    739. 

  739. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    740. 

  740. 

  741.   </dd>
    742. 

  742. </div>
    743. 

  743. 

  744. </div>
    745. 

  745. <div id="re-procs-all">
    746. 

  746.   <div id="re,string">
    747. 

  747.   <dt><pre><span class="Keyword">proc</span> <a href="#re%2Cstring"><span class="Identifier">re</span></a><span class="Other">(</span><span class="Identifier">pattern</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="nre.html#Regex"><span class="Identifier">Regex</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="Identifier">KeyError</span><span class="Other">,</span> <span class="Identifier">SyntaxError</span><span class="Other">,</span> <span class="Identifier">StudyError</span><span class="Other">,</span>
    748. 

  748.     <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>
    749. 

  749.   <dd>
    750. 

  750.     
    751. 

  751.     
    752. 

  752.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L499" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    753. 

  753. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L499" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    754. 

  754. 

  755.   </dd>
    756. 

  756. </div>
    757. 

  757. 

  758. </div>
    759. 

  759. <div id="replace-procs-all">
    760. 

  760.   <div id="replace,string,Regex,string">
    761. 

  761.   <dt><pre><span class="Keyword">proc</span> <a href="#replace%2Cstring%2CRegex%2Cstring"><span class="Identifier">replace</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">sub</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#string"><span class="Identifier">string</span></a> {.
    762. 

  762.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    763. 

  763.     <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>
    764. 

  764.   <dd>
    765. 

  765.     
    766. 

  766.     
    767. 

  767.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L747" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    768. 

  768. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L747" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    769. 

  769. 

  770.   </dd>
    771. 

  771. </div>
    772. 

  772. <div id="replace,string,Regex,proc(RegexMatch)">
    773. 

  773.   <dt><pre><span class="Keyword">proc</span> <a href="#replace%2Cstring%2CRegex%2Cproc%28RegexMatch%29"><span class="Identifier">replace</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span>
    774. 

  774.              <span class="Identifier">subproc</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">match</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a><span class="Other">)</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#string"><span class="Identifier">string</span></a> {.
    775. 

  775.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    776. 

  776.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</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>
    777. 

  777.   <dd>
    778. 

  778.     
    779. 

  779.     <p>Replaces each match of Regex in the string with <tt class="docutils literal"><span class="pre"><span class="Identifier">subproc</span></span></tt>, which should never be or return <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>.</p>
    780. 

  780. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">subproc</span></span></tt> is a <tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span> <span class="Punctuation">(</span><span class="Identifier">RegexMatch</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span></span></tt>, then it is executed with each match and the return value is the replacement value.</p>
    781. 

  781. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">subproc</span></span></tt> is a <tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span> <span class="Punctuation">(</span><span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span></span></tt>, then it is executed with the full text of the match and the return value is the replacement value.</p>
    782. 

  782. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">subproc</span></span></tt> is a string, the syntax is as follows:</p>
    783. 

  783. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Operator">$$</span></span></tt> - literal <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt></li>
    784. 

  784. <li><tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">123</span></span></tt> - capture number <tt class="docutils literal"><span class="pre"><span class="DecNumber">123</span></span></tt></li>
    785. 

  785. <li><tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Identifier">foo</span></span></tt> - named capture <tt class="docutils literal"><span class="pre"><span class="Identifier">foo</span></span></tt></li>
    786. 

  786. <li><tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Punctuation">{</span><span class="Identifier">foo</span><span class="Punctuation">}</span></span></tt> - same as above</li>
    787. 

  787. <li><tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">1</span><span class="Operator">$</span><span class="Comment">#</span></span></tt> - first and second captures</li>
    788. 

  788. <li><tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Comment">#</span></span></tt> - first capture</li>
    789. 

  789. <li><tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">0</span></span></tt> - full match</li>
    790. 

  790. </ul>
    791. 

  791. <p>If a given capture is missing, <tt class="docutils literal"><span class="pre"><span class="Identifier">IndexDefect</span></span></tt> thrown for un-named captures and <tt class="docutils literal"><span class="pre"><span class="Identifier">KeyError</span></span></tt> for named captures.</p>
    792. 

  792. 

  793.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L718" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    794. 

  794. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L718" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    795. 

  795. 

  796.   </dd>
    797. 

  797. </div>
    798. 

  798. <div id="replace,string,Regex,proc(string)">
    799. 

  799.   <dt><pre><span class="Keyword">proc</span> <a href="#replace%2Cstring%2CRegex%2Cproc%28string%29"><span class="Identifier">replace</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">subproc</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">match</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#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    800. 

  800.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    801. 

  801.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</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>
    802. 

  802.   <dd>
    803. 

  803.     
    804. 

  804.     
    805. 

  805.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L743" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    806. 

  806. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L743" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    807. 

  807. 

  808.   </dd>
    809. 

  809. </div>
    810. 

  810. 

  811. </div>
    812. 

  812. <div id="split-procs-all">
    813. 

  813.   <div id="split,string,Regex,int,int">
    814. 

  814.   <dt><pre><span class="Keyword">proc</span> <a href="#split%2Cstring%2CRegex%2Cint%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">maxSplit</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    815. 

  815.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</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>
    816. 

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

  817.   <dd>
    818. 

  818.     
    819. 

  819.     <p>Splits the string with the given regex. This works according to the rules that Perl and Javascript use.</p>
    820. 

  820. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> behaves the same as in <a class="reference external" href="#find,string,Regex,int">find(...)</a>. </p>
    821. 

  821. 

  822. <p><strong class="examples_text">Example:</strong></p>
    823. 

  823. <pre class="listing"><span class="Comment"># -  If the match is zero-width, then the string is still split:</span>
    824. 

  824. <span class="Identifier">assert</span> <span class="StringLit">&quot;123&quot;</span><span class="Operator">.</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="RawData">re&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;3&quot;</span><span class="Punctuation">]</span>
    825. 

  825. 

  826. <span class="Comment"># -  If the pattern has a capture in it, it is added after the string</span>
    827. 

  827. <span class="Comment">#    split:</span>
    828. 

  828. <span class="Identifier">assert</span> <span class="StringLit">&quot;12&quot;</span><span class="Operator">.</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\d)&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">]</span>
    829. 

  829. 

  830. <span class="Comment"># -  If `maxsplit != -1`, then the string will only be split</span>
    831. 

  831. <span class="Comment">#    `maxsplit - 1` times. This means that there will be `maxsplit`</span>
    832. 

  832. <span class="Comment">#    strings in the output seq.</span>
    833. 

  833. <span class="Identifier">assert</span> <span class="StringLit">&quot;1.2.3&quot;</span><span class="Operator">.</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="RawData">re&quot;\.&quot;</span><span class="Punctuation">,</span> <span class="Identifier">maxsplit</span> <span class="Operator">=</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2.3&quot;</span><span class="Punctuation">]</span></pre>
    834. 

  834.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L639" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    835. 

  835. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L639" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    836. 

  836. 

  837.   </dd>
    838. 

  838. </div>
    839. 

  839. 

  840. </div>
    841. 

  841. <div id="toSeq-procs-all">
    842. 

  842.   <div id="toSeq,CaptureBounds">
    843. 

  843.   <dt><pre><span class="Keyword">proc</span> <a href="#toSeq%2CCaptureBounds"><span class="Identifier">toSeq</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</span></a><span class="Other">;</span> <span class="Identifier">default</span> <span class="Other">=</span> <span class="Identifier">none</span><span class="Other">(</span><a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span>
    844. 

  844.     <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span><a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">]</span><span class="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="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>
    845. 

  845.   <dd>
    846. 

  846.     
    847. 

  847.     
    848. 

  848.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L419" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    849. 

  849. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L419" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    850. 

  850. 

  851.   </dd>
    852. 

  852. </div>
    853. 

  853. <div id="toSeq,Captures,Option[string]">
    854. 

  854.   <dt><pre><span class="Keyword">proc</span> <a href="#toSeq%2CCaptures%2COption%5Bstring%5D"><span class="Identifier">toSeq</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><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="Identifier">none</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="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span>
    855. 

  855.     <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</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="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>
    856. 

  856.   <dd>
    857. 

  857.     
    858. 

  858.     
    859. 

  859.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L424" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    860. 

  860. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L424" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    861. 

  861. 

  862.   </dd>
    863. 

  863. </div>
    864. 

  864. 

  865. </div>
    866. 

  866. <div id="toTable-procs-all">
    867. 

  867.   <div id="toTable,CaptureBounds">
    868. 

  868.   <dt><pre><span class="Keyword">func</span> <a href="#toTable%2CCaptureBounds"><span class="Identifier">toTable</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</span></a><span class="Other">)</span><span class="Other">:</span> <a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">]</span> {.
    869. 

  869.     <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="Identifier">KeyError</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>
    870. 

  870.   <dd>
    871. 

  871.     
    872. 

  872.     
    873. 

  873.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L396" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    874. 

  874. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L396" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    875. 

  875. 

  876.   </dd>
    877. 

  877. </div>
    878. 

  878. <div id="toTable,Captures">
    879. 

  879.   <dt><pre><span class="Keyword">func</span> <a href="#toTable%2CCaptures"><span class="Identifier">toTable</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</span></a><span class="Other">)</span><span class="Other">:</span> <a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    880. 

  880.     <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>
    881. 

  881.   <dd>
    882. 

  882.     
    883. 

  883.     
    884. 

  884.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L392" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    885. 

  885. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L392" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    886. 

  886. 

  887.   </dd>
    888. 

  888. </div>
    889. 

  889. 

  890. </div>
    891. 

  891. 

  892.   </dl>
    893. 

  893. </div>
    894. 

  894. <div class="section" id="15">
    895. 

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

  896.   <dl class="item">
    897. 

  897.     <div id="findIter-iterators-all">
    898. 

  898.   <div id="findIter.i,string,Regex,int">
    899. 

  899.   <dt><pre><span class="Keyword">iterator</span> <a href="#findIter.i%2Cstring%2CRegex%2Cint"><span class="Identifier">findIter</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">endpos</span> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="nre.html#RegexMatch"><span class="Identifier">RegexMatch</span></a> {.
    900. 

  900.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">RegexInternalError</span><span class="Other">,</span> <span class="Identifier">InvalidUnicodeError</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>
    901. 

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

  902.   <dd>
    903. 

  903.     
    904. 

  904.     Works the same as <a class="reference external" href="#find,string,Regex,int">find(...)</a>, but finds every non-overlapping match:
    905. 

  905. <p><strong class="examples_text">Example:</strong></p>
    906. 

  906. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
    907. 

  907. <span class="Identifier">assert</span> <span class="Identifier">collect</span><span class="Punctuation">(</span><span class="Keyword">for</span> <span class="Identifier">a</span> <span class="Keyword">in</span> <span class="StringLit">&quot;2222&quot;</span><span class="Operator">.</span><span class="Identifier">findIter</span><span class="Punctuation">(</span><span class="RawData">re&quot;22&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">match</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;22&quot;</span><span class="Punctuation">]</span>
    908. 

  908.  <span class="Comment"># not @[&quot;22&quot;, &quot;22&quot;, &quot;22&quot;]</span></pre><p>Arguments are the same as <a class="reference external" href="#find,string,Regex,int">find(...)</a></p>
    909. 

  909. <p>Variants:</p>
    910. 

  910. <ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span> <span class="Identifier">findAll</span><span class="Punctuation">(</span><span class="Operator">...</span><span class="Punctuation">)</span></span></tt> returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span></span></tt></li>
    911. 

  911. </ul>
    912. 

  912. 

  913.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L559" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    914. 

  914. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L559" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    915. 

  915. 

  916.   </dd>
    917. 

  917. </div>
    918. 

  918. 

  919. </div>
    920. 

  920. <div id="items-iterators-all">
    921. 

  921.   <div id="items.i,CaptureBounds">
    922. 

  922.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CCaptureBounds"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#CaptureBounds"><span class="Identifier">CaptureBounds</span></a><span class="Other">;</span> <span class="Identifier">default</span> <span class="Other">=</span> <span class="Identifier">none</span><span class="Other">(</span><a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span>
    923. 

  923.     <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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>
    924. 

  924.   <dd>
    925. 

  925.     
    926. 

  926.     
    927. 

  927.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L411" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    928. 

  928. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L411" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    929. 

  929. 

  930.   </dd>
    931. 

  931. </div>
    932. 

  932. <div id="items.i,Captures,Option[string]">
    933. 

  933.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CCaptures%2COption%5Bstring%5D"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="nre.html#Captures"><span class="Identifier">Captures</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><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="Identifier">none</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="Other">:</span> <a href="options.html#Option"><span class="Identifier">Option</span></a><span class="Other">[</span>
    934. 

  934.     <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">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>
    935. 

  935.   <dd>
    936. 

  936.     
    937. 

  937.     
    938. 

  938.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/nre.nim#L415" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    939. 

  939. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/nre.nim#L415" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    940. 

  940. 

  941.   </dd>
    942. 

  942. </div>
    943. 

  943. 

  944. </div>
    945. 

  945. 

  946.   </dl>
    947. 

  947. </div>
    948. 

  948. 

  949.   </div>
    950. 

  950. </div>
    951. 

  951. 

  952.       <div class="twelve-columns footer">
    953. 

  953.         <span class="nim-sprite"></span>
    954. 

  954.         <br>
    955. 

  955.         <small style="color: var(--hint);">Made with Nim. Generated: 2024-12-25 13:28:31 UTC</small>
    956. 

  956.       </div>
    957. 

  957.     </div>
    958. 

  958.   </div>
    959. 

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

  960.     
    961. 

  961. </body>
    962. 

  962. </html>
    963. 

  963.