Página inicial Explorar Ajuda
Entrar
levovix
/
Nim
mirror de https://github.com/nim-lang/Nim
Observar 1
Favorito 0
Fork 1
Arquivos Issues 0 Wiki
Branch: gh-pages
Branches Tags
Nim
/
re.html

re.html 144 KB
Link permanente Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980 
  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/re</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/re</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li><a class="reference" id="licence-of-the-pcre-library_toc" href="#licence-of-the-pcre-library">Licence of the PCRE library</a></li>
    55. 

  55. <li><a class="reference" id="regular-expression-syntax-and-semantics_toc" href="#regular-expression-syntax-and-semantics">Regular expression syntax and semantics</a></li>
    56. 

  56. <ul class="simple"><li><a class="reference" id="regular-expression-syntax-and-semantics-backslash_toc" href="#regular-expression-syntax-and-semantics-backslash">Backslash</a></li>
    57. 

  57. <li><a class="reference" id="regular-expression-syntax-and-semantics-nonminusprinting-characters_toc" href="#regular-expression-syntax-and-semantics-nonminusprinting-characters">Non-printing characters</a></li>
    58. 

  58. <li><a class="reference" id="regular-expression-syntax-and-semantics-generic-character-types_toc" href="#regular-expression-syntax-and-semantics-generic-character-types">Generic character types</a></li>
    59. 

  59. <li><a class="reference" id="regular-expression-syntax-and-semantics-simple-assertions_toc" href="#regular-expression-syntax-and-semantics-simple-assertions">Simple assertions</a></li>
    60. 

  60. </ul><li>
    61. 

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

  62. </li>
    63. 

  63. <li>
    64. 

  64.   <details open>
    65. 

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

  66.     <ul class="simple simple-toc-section">
    67. 

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

  68. <li><a class="reference" href="#RegexError" title="RegexError = object of ValueError">RegexError</a></li>
    69. 

  69. <li><a class="reference" href="#RegexFlag" title="RegexFlag = enum
    70. 

  70.   reIgnoreCase = 0,         ## do caseless matching
    71. 

  71.   reMultiLine = 1,          ## `^` and `$` match newlines within data
    72. 

  72.   reDotAll = 2,             ## `.` matches anything including NL
    73. 

  73.   reExtended = 3,           ## ignore whitespace and `#` comments
    74. 

  74.   reStudy = 4                ## study the expression (may be omitted if the
    75. 

  75.                              ## expression will be used only once)">RegexFlag</a></li>
    76. 

  76. 

  77.     </ul>
    78. 

  78.   </details>
    79. 

  79. </li>
    80. 

  80. <li>
    81. 

  81.   <details open>
    82. 

  82.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    83. 

  83.     <ul class="simple simple-toc-section">
    84. 

  84.       <li><a class="reference" href="#MaxReBufSize" title="MaxReBufSize = 2147483647'i32">MaxReBufSize</a></li>
    85. 

  85. <li><a class="reference" href="#MaxSubpatterns" title="MaxSubpatterns = 20">MaxSubpatterns</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">contains
    95. 

  95.   <li><a class="reference" href="#contains%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint" title="contains(s: string; pattern: Regex; matches: var openArray[string]; start = 0): bool">contains(s: string; pattern: Regex; matches: var openArray[string]; start = 0): bool</a></li>
    96. 

  96. <li><a class="reference" href="#contains%2Cstring%2CRegex%2Cint" title="contains(s: string; pattern: Regex; start = 0): bool">contains(s: string; pattern: Regex; start = 0): bool</a></li>
    97. 

  97. 

  98. </ul>
    99. 

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

  100.   <li><a class="reference" href="#endsWith%2Cstring%2CRegex" title="endsWith(s: string; suffix: Regex): bool">endsWith(s: string; suffix: Regex): bool</a></li>
    101. 

  101. 

  102. </ul>
    103. 

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

  104.   <li><a class="reference" href="#escapeRe%2Cstring" title="escapeRe(s: string): string">escapeRe(s: string): string</a></li>
    105. 

  105. 

  106. </ul>
    107. 

  107. <ul class="simple nested-toc-section">find
    108. 

  108.   <li><a class="reference" href="#find%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint" title="find(buf: cstring; pattern: Regex; matches: var openArray[string]; start = 0;
    109. 

  109.      bufSize: int): int">find(buf: cstring; pattern: Regex; matches: var openArray[string]; start = 0;
    110. 

  110.      bufSize: int): int</a></li>
    111. 

  111. <li><a class="reference" href="#find%2Ccstring%2CRegex%2Cint%2Cint" title="find(buf: cstring; pattern: Regex; start = 0; bufSize: int): int">find(buf: cstring; pattern: Regex; start = 0; bufSize: int): int</a></li>
    112. 

  112. <li><a class="reference" href="#find%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint" title="find(s: string; pattern: Regex; matches: var openArray[string]; start = 0): int">find(s: string; pattern: Regex; matches: var openArray[string]; start = 0): int</a></li>
    113. 

  113. <li><a class="reference" href="#find%2Cstring%2CRegex%2Cint" title="find(s: string; pattern: Regex; start = 0): int">find(s: string; pattern: Regex; start = 0): int</a></li>
    114. 

  114. 

  115. </ul>
    116. 

  116. <ul class="simple nested-toc-section">findAll
    117. 

  117.   <li><a class="reference" href="#findAll%2Cstring%2CRegex%2Cint" title="findAll(s: string; pattern: Regex; start = 0): seq[string]">findAll(s: string; pattern: Regex; start = 0): seq[string]</a></li>
    118. 

  118. 

  119. </ul>
    120. 

  120. <ul class="simple nested-toc-section">findBounds
    121. 

  121.   <li><a class="reference" href="#findBounds%2Ccstring%2CRegex%2CopenArray%5Btuple%5Bint%2Cint%5D%5D%2Cint%2Cint" title="findBounds(buf: cstring; pattern: Regex;
    122. 

  122.            matches: var openArray[tuple[first, last: int]]; start = 0;
    123. 

  123.            bufSize: int): tuple[first, last: int]">findBounds(buf: cstring; pattern: Regex;
    124. 

  124.            matches: var openArray[tuple[first, last: int]]; start = 0;
    125. 

  125.            bufSize: int): tuple[first, last: int]</a></li>
    126. 

  126. <li><a class="reference" href="#findBounds%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint" title="findBounds(buf: cstring; pattern: Regex; matches: var openArray[string];
    127. 

  127.            start = 0; bufSize: int): tuple[first, last: int]">findBounds(buf: cstring; pattern: Regex; matches: var openArray[string];
    128. 

  128.            start = 0; bufSize: int): tuple[first, last: int]</a></li>
    129. 

  129. <li><a class="reference" href="#findBounds%2Ccstring%2CRegex%2Cint%2Cint" title="findBounds(buf: cstring; pattern: Regex; start = 0; bufSize: int): tuple[
    130. 

  130.     first, last: int]">findBounds(buf: cstring; pattern: Regex; start = 0; bufSize: int): tuple[
    131. 

  131.     first, last: int]</a></li>
    132. 

  132. <li><a class="reference" href="#findBounds%2Cstring%2CRegex%2CopenArray%5Btuple%5Bint%2Cint%5D%5D%2Cint" title="findBounds(s: string; pattern: Regex;
    133. 

  133.            matches: var openArray[tuple[first, last: int]]; start = 0): tuple[
    134. 

  134.     first, last: int]">findBounds(s: string; pattern: Regex;
    135. 

  135.            matches: var openArray[tuple[first, last: int]]; start = 0): tuple[
    136. 

  136.     first, last: int]</a></li>
    137. 

  137. <li><a class="reference" href="#findBounds%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint" title="findBounds(s: string; pattern: Regex; matches: var openArray[string]; start = 0): tuple[
    138. 

  138.     first, last: int]">findBounds(s: string; pattern: Regex; matches: var openArray[string]; start = 0): tuple[
    139. 

  139.     first, last: int]</a></li>
    140. 

  140. <li><a class="reference" href="#findBounds%2Cstring%2CRegex%2Cint" title="findBounds(s: string; pattern: Regex; start = 0): tuple[first, last: int]">findBounds(s: string; pattern: Regex; start = 0): tuple[first, last: int]</a></li>
    141. 

  141. 

  142. </ul>
    143. 

  143. <ul class="simple nested-toc-section">match
    144. 

  144.   <li><a class="reference" href="#match%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint" title="match(buf: cstring; pattern: Regex; matches: var openArray[string]; start = 0;
    145. 

  145.       bufSize: int): bool">match(buf: cstring; pattern: Regex; matches: var openArray[string]; start = 0;
    146. 

  146.       bufSize: int): bool</a></li>
    147. 

  147. <li><a class="reference" href="#match%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint" title="match(s: string; pattern: Regex; matches: var openArray[string]; start = 0): bool">match(s: string; pattern: Regex; matches: var openArray[string]; start = 0): bool</a></li>
    148. 

  148. <li><a class="reference" href="#match%2Cstring%2CRegex%2Cint" title="match(s: string; pattern: Regex; start = 0): bool">match(s: string; pattern: Regex; start = 0): bool</a></li>
    149. 

  149. 

  150. </ul>
    151. 

  151. <ul class="simple nested-toc-section">matchLen
    152. 

  152.   <li><a class="reference" href="#matchLen%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint" title="matchLen(buf: cstring; pattern: Regex; matches: var openArray[string];
    153. 

  153.          start = 0; bufSize: int): int">matchLen(buf: cstring; pattern: Regex; matches: var openArray[string];
    154. 

  154.          start = 0; bufSize: int): int</a></li>
    155. 

  155. <li><a class="reference" href="#matchLen%2Ccstring%2CRegex%2Cint%2Cint" title="matchLen(buf: cstring; pattern: Regex; start = 0; bufSize: int): int">matchLen(buf: cstring; pattern: Regex; start = 0; bufSize: int): int</a></li>
    156. 

  156. <li><a class="reference" href="#matchLen%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint" title="matchLen(s: string; pattern: Regex; matches: var openArray[string]; start = 0): int">matchLen(s: string; pattern: Regex; matches: var openArray[string]; start = 0): int</a></li>
    157. 

  157. <li><a class="reference" href="#matchLen%2Cstring%2CRegex%2Cint" title="matchLen(s: string; pattern: Regex; start = 0): int">matchLen(s: string; pattern: Regex; start = 0): int</a></li>
    158. 

  158. 

  159. </ul>
    160. 

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

  161.   <li><a class="reference" href="#multiReplace%2Cstring%2CopenArray%5Btuple%5BRegex%2Cstring%5D%5D" title="multiReplace(s: string; subs: openArray[tuple[pattern: Regex, repl: string]]): string">multiReplace(s: string; subs: openArray[tuple[pattern: Regex, repl: string]]): string</a></li>
    162. 

  162. 

  163. </ul>
    164. 

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

  165.   <li><a class="reference" href="#re%2Cstring" title="re(s: string; flags = {reStudy}): Regex">re(s: string; flags = {reStudy}): Regex</a></li>
    166. 

  166. 

  167. </ul>
    168. 

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

  169.   <li><a class="reference" href="#replace%2Cstring%2CRegex%2Cstring" title="replace(s: string; sub: Regex; by = &quot;&quot;): string">replace(s: string; sub: Regex; by = &quot;&quot;): string</a></li>
    170. 

  170. 

  171. </ul>
    172. 

  172. <ul class="simple nested-toc-section">replacef
    173. 

  173.   <li><a class="reference" href="#replacef%2Cstring%2CRegex%2Cstring" title="replacef(s: string; sub: Regex; by: string): string">replacef(s: string; sub: Regex; by: string): string</a></li>
    174. 

  174. 

  175. </ul>
    176. 

  176. <ul class="simple nested-toc-section">rex
    177. 

  177.   <li><a class="reference" href="#rex%2Cstring" title="rex(s: string; flags = {reStudy, reExtended}): Regex">rex(s: string; flags = {reStudy, reExtended}): Regex</a></li>
    178. 

  178. 

  179. </ul>
    180. 

  180. <ul class="simple nested-toc-section">split
    181. 

  181.   <li><a class="reference" href="#split%2Cstring%2CRegex%2Cint" title="split(s: string; sep: Regex; maxsplit = -1): seq[string]">split(s: string; sep: Regex; maxsplit = -1): seq[string]</a></li>
    182. 

  182. 

  183. </ul>
    184. 

  184. <ul class="simple nested-toc-section">startsWith
    185. 

  185.   <li><a class="reference" href="#startsWith%2Cstring%2CRegex" title="startsWith(s: string; prefix: Regex): bool">startsWith(s: string; prefix: Regex): bool</a></li>
    186. 

  186. 

  187. </ul>
    188. 

  188. <ul class="simple nested-toc-section">transformFile
    189. 

  189.   <li><a class="reference" href="#transformFile%2Cstring%2Cstring%2CopenArray%5Btuple%5BRegex%2Cstring%5D%5D" title="transformFile(infile, outfile: string;
    190. 

  190.               subs: openArray[tuple[pattern: Regex, repl: string]])">transformFile(infile, outfile: string;
    191. 

  191.               subs: openArray[tuple[pattern: Regex, repl: string]])</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. 

  195.     </ul>
    196. 

  196.   </details>
    197. 

  197. </li>
    198. 

  198. <li>
    199. 

  199.   <details open>
    200. 

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

  201.     <ul class="simple simple-toc-section">
    202. 

  202.       <ul class="simple nested-toc-section">findAll
    203. 

  203.   <li><a class="reference" href="#findAll.i%2Ccstring%2CRegex%2Cint%2Cint" title="findAll(buf: cstring; pattern: Regex; start = 0; bufSize: int): string">findAll(buf: cstring; pattern: Regex; start = 0; bufSize: int): string</a></li>
    204. 

  204. <li><a class="reference" href="#findAll.i%2Cstring%2CRegex%2Cint" title="findAll(s: string; pattern: Regex; start = 0): string">findAll(s: string; pattern: Regex; start = 0): string</a></li>
    205. 

  205. 

  206. </ul>
    207. 

  207. <ul class="simple nested-toc-section">split
    208. 

  208.   <li><a class="reference" href="#split.i%2Cstring%2CRegex%2Cint" title="split(s: string; sep: Regex; maxsplit = -1): string">split(s: string; sep: Regex; maxsplit = -1): string</a></li>
    209. 

  209. 

  210. </ul>
    211. 

  211. 

  212.     </ul>
    213. 

  213.   </details>
    214. 

  214. </li>
    215. 

  215. <li>
    216. 

  216.   <details open>
    217. 

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

  218.     <ul class="simple simple-toc-section">
    219. 

  219.       <ul class="simple nested-toc-section">=~
    220. 

  220.   <li><a class="reference" href="#%3D~.t%2Cstring%2CRegex" title="`=~`(s: string; pattern: Regex): untyped">`=~`(s: string; pattern: Regex): untyped</a></li>
    221. 

  221. 

  222. </ul>
    223. 

  223. 

  224.     </ul>
    225. 

  225.   </details>
    226. 

  226. </li>
    227. 

  227. 

  228. </ul>
    229. 

  229. 

  230.   </div>
    231. 

  231.   <div class="nine columns" id="content">
    232. 

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

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

  234. 

  235.     <div id="tocRoot"></div>
    236. 

  236.     
    237. 

  237.     <p class="module-desc"><p>Regular expression support for Nim.</p>
    238. 

  238. <p>This module is implemented by providing a wrapper around the <a class="reference external" href="https://www.pcre.org">PCRE (Perl-Compatible Regular Expressions)</a> C library. This means that your application will depend on the PCRE library's licence when using this module, which should not be a problem though.</p>
    239. 

  239. <div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    240. 

  240. 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>
    241. 

  241. <p>PCRE's licence follows:</p>
    242. 

  242. 

  243. <h1><a class="toc-backref" id="licence-of-the-pcre-library" href="#licence-of-the-pcre-library">Licence of the PCRE library</a></h1><p>PCRE is a library of functions to support regular expressions whose syntax and semantics are as close as possible to those of the Perl 5 language.</p>
    244. 

  244. <p>Written by Philip Hazel<br/>Copyright (c) 1997-2005 University of Cambridge<br/></p><hr />
    245. 

  245. <p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
    246. 

  246. <ul class="simple"><li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
    247. 

  247. <li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li>
    248. 

  248. <li>Neither the name of the University of Cambridge nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</li>
    249. 

  249. </ul>
    250. 

  250. <p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
    251. 

  251. 

  252. <h1><a class="toc-backref" id="regular-expression-syntax-and-semantics" href="#regular-expression-syntax-and-semantics">Regular expression syntax and semantics</a></h1><p>As the regular expressions supported by this module are enormous, the reader is referred to <a class="reference external" href="https://perldoc.perl.org/perlre.html">https://perldoc.perl.org/perlre.html</a> for the full documentation of Perl's regular expressions.</p>
    253. 

  253. <p>Because the backslash <tt class="docutils literal"><span class="pre">\</span></tt> is a meta character both in the Nim programming language and in regular expressions, it is strongly recommended that one uses the <em>raw</em> strings of Nim, so that backslashes are interpreted by the regular expression engine:</p>
    254. 

  254. <p><pre class="listing">  <span class="RawData">r&quot;\S&quot;</span>  <span class="Comment"># matches any character that is not whitespace</span></pre></p>
    255. 

  255. <p>A regular expression is a pattern that is matched against a subject string from left to right. Most characters stand for themselves in a pattern, and match the corresponding characters in the subject. As a trivial example, the pattern:</p>
    256. 

  256. <pre>The quick brown fox</pre>
    257. 

  257. <p>matches a portion of a subject string that is identical to itself. The power of regular expressions comes from the ability to include alternatives and repetitions in the pattern. These are encoded in the pattern by the use of metacharacters, which do not stand for themselves but instead are interpreted in some special way.</p>
    258. 

  258. <p>There are two different sets of metacharacters: those that are recognized anywhere in the pattern except within square brackets, and those that are recognized in square brackets. Outside square brackets, the metacharacters are as follows:</p>
    259. 

  259. <table border="1" class="docutils"><tr><th>meta character</th><th>meaning</th></tr>
    260. 

  260. <tr><td><tt class="docutils literal"><span class="pre">\</span></tt></td><td>general escape character with several uses</td></tr>
    261. 

  261. <tr><td><tt class="docutils literal"><span class="pre">^</span></tt></td><td>assert start of string (or line, in multiline mode)</td></tr>
    262. 

  262. <tr><td><tt class="docutils literal"><span class="pre">$</span></tt></td><td>assert end of string (or line, in multiline mode)</td></tr>
    263. 

  263. <tr><td><tt class="docutils literal"><span class="pre">.</span></tt></td><td>match any character except newline (by default)</td></tr>
    264. 

  264. <tr><td><tt class="docutils literal"><span class="pre">[</span></tt></td><td>start character class definition</td></tr>
    265. 

  265. <tr><td><tt class="docutils literal"><span class="pre">|</span></tt></td><td>start of alternative branch</td></tr>
    266. 

  266. <tr><td><tt class="docutils literal"><span class="pre">(</span></tt></td><td>start subpattern</td></tr>
    267. 

  267. <tr><td><tt class="docutils literal"><span class="pre">)</span></tt></td><td>end subpattern</td></tr>
    268. 

  268. <tr><td><tt class="docutils literal"><span class="pre">{</span></tt></td><td>start min/max quantifier</td></tr>
    269. 

  269. <tr><td><tt class="docutils literal"><span class="pre">?</span></tt></td><td>extends the meaning of <tt class="docutils literal"><span class="pre">(</span></tt><p>also 0 or 1 quantifier (equal to <tt class="docutils literal"><span class="pre">{0,1}</span></tt>)<br/>also quantifier minimizer<br/></p></td></tr>
    270. 

  270. <tr><td><tt class="docutils literal"><span class="pre">*</span></tt></td><td>0 or more quantifier (equal to <tt class="docutils literal"><span class="pre">{0,}</span></tt>)</td></tr>
    271. 

  271. <tr><td><tt class="docutils literal"><span class="pre">+</span></tt></td><td>1 or more quantifier (equal to <tt class="docutils literal"><span class="pre">{1,}</span></tt>)<p>also &quot;possessive quantifier&quot;<br/></p></td></tr>
    272. 

  272. </table><p>Part of a pattern that is in square brackets is called a &quot;character class&quot;. In a character class the only metacharacters are:</p>
    273. 

  273. <table border="1" class="docutils"><tr><th>meta character</th><th>meaning</th></tr>
    274. 

  274. <tr><td><tt class="docutils literal"><span class="pre">\</span></tt></td><td>general escape character</td></tr>
    275. 

  275. <tr><td><tt class="docutils literal"><span class="pre">^</span></tt></td><td>negate the class, but only if the first character</td></tr>
    276. 

  276. <tr><td><tt class="docutils literal"><span class="pre">-</span></tt></td><td>indicates character range</td></tr>
    277. 

  277. <tr><td><tt class="docutils literal"><span class="pre">[</span></tt></td><td>POSIX character class (only if followed by POSIX syntax)</td></tr>
    278. 

  278. <tr><td><tt class="docutils literal"><span class="pre">]</span></tt></td><td>terminates the character class</td></tr>
    279. 

  279. </table><p>The following sections describe the use of each of the metacharacters.</p>
    280. 

  280. 

  281. <h2><a class="toc-backref" id="regular-expression-syntax-and-semantics-backslash" href="#regular-expression-syntax-and-semantics-backslash">Backslash</a></h2><p>The <span id="backslash_1">backslash</span> character has several uses. Firstly, if it is followed by a non-alphanumeric character, it takes away any special meaning that character may have. This use of backslash as an escape character applies both inside and outside character classes.</p>
    282. 

  282. <p>For example, if you want to match a <tt class="docutils literal"><span class="pre">*</span></tt> character, you write <tt class="docutils literal"><span class="pre">\*</span></tt> in the pattern. This escaping action applies whether or not the following character would otherwise be interpreted as a metacharacter, so it is always safe to precede a non-alphanumeric with backslash to specify that it stands for itself. In particular, if you want to match a backslash, you write <tt class="docutils literal"><span class="pre">\\</span></tt>.</p>
    283. 

  283. 

  284. <h2><a class="toc-backref" id="regular-expression-syntax-and-semantics-nonminusprinting-characters" href="#regular-expression-syntax-and-semantics-nonminusprinting-characters">Non-printing characters</a></h2><p>A second use of backslash provides a way of encoding non-printing characters in patterns in a visible manner. There is no restriction on the appearance of non-printing characters, apart from the binary zero that terminates a pattern, but when a pattern is being prepared by text editing, it is usually easier to use one of the following escape sequences than the binary character it represents:</p>
    285. 

  285. <table border="1" class="docutils"><tr><th>character</th><th>meaning</th></tr>
    286. 

  286. <tr><td><tt class="docutils literal"><span class="pre">\a</span></tt></td><td>alarm, that is, the BEL character (hex 07)</td></tr>
    287. 

  287. <tr><td><tt class="docutils literal"><span class="pre">\e</span></tt></td><td>escape (hex 1B)</td></tr>
    288. 

  288. <tr><td><tt class="docutils literal"><span class="pre">\f</span></tt></td><td>formfeed (hex 0C)</td></tr>
    289. 

  289. <tr><td><tt class="docutils literal"><span class="pre">\n</span></tt></td><td>newline (hex 0A)</td></tr>
    290. 

  290. <tr><td><tt class="docutils literal"><span class="pre">\r</span></tt></td><td>carriage return (hex 0D)</td></tr>
    291. 

  291. <tr><td><tt class="docutils literal"><span class="pre">\t</span></tt></td><td>tab (hex 09)</td></tr>
    292. 

  292. <tr><td><tt class="docutils literal"><span class="pre">\ddd</span></tt></td><td>character with octal code ddd, or backreference</td></tr>
    293. 

  293. <tr><td><tt class="docutils literal"><span class="pre">\xhh</span></tt></td><td>character with hex code hh</td></tr>
    294. 

  294. </table><p>After <tt class="docutils literal"><span class="pre">\x</span></tt>, from zero to two hexadecimal digits are read (letters can be in upper or lower case). In UTF-8 mode, any number of hexadecimal digits may appear between <tt class="docutils literal"><span class="pre">\x{</span></tt> and <tt class="docutils literal"><span class="pre">}</span></tt>, but the value of the character code must be less than 2^31 (that is, the maximum hexadecimal value is 7FFFFFFF). If characters other than hexadecimal digits appear between <tt class="docutils literal"><span class="pre">\x{</span></tt> and <tt class="docutils literal"><span class="pre">}</span></tt>, or if there is no terminating <tt class="docutils literal"><span class="pre">}</span></tt>, this form of escape is not recognized. Instead, the initial <tt class="docutils literal"><span class="pre">\x</span></tt> will be interpreted as a basic hexadecimal escape, with no following digits, giving a character whose value is zero.</p>
    295. 

  295. <p>After <tt class="docutils literal"><span class="pre">\0</span></tt> up to two further octal digits are read. In both cases, if there are fewer than two digits, just those that are present are used. Thus the sequence <tt class="docutils literal"><span class="pre">\0\x\07</span></tt> specifies two binary zeros followed by a BEL character (code value 7). Make sure you supply two digits after the initial zero if the pattern character that follows is itself an octal digit.</p>
    296. 

  296. <p>The handling of a backslash followed by a digit other than 0 is complicated. Outside a character class, PCRE reads it and any following digits as a decimal number. If the number is less than 10, or if there have been at least that many previous capturing left parentheses in the expression, the entire sequence is taken as a back reference. A description of how this works is given later, following the discussion of parenthesized subpatterns.</p>
    297. 

  297. <p>Inside a character class, or if the decimal number is greater than 9 and there have not been that many capturing subpatterns, PCRE re-reads up to three octal digits following the backslash, and generates a single byte from the least significant 8 bits of the value. Any subsequent digits stand for themselves. For example:</p>
    298. 

  298. <table border="1" class="docutils"><tr><th>example</th><th>meaning</th></tr>
    299. 

  299. <tr><td><tt class="docutils literal"><span class="pre">\040</span></tt></td><td>is another way of writing a space</td></tr>
    300. 

  300. <tr><td><tt class="docutils literal"><span class="pre">\40</span></tt></td><td>is the same, provided there are fewer than 40 previous capturing subpatterns</td></tr>
    301. 

  301. <tr><td><tt class="docutils literal"><span class="pre">\7</span></tt></td><td>is always a back reference</td></tr>
    302. 

  302. <tr><td><tt class="docutils literal"><span class="pre">\11</span></tt></td><td>might be a back reference, or another way of writing a tab</td></tr>
    303. 

  303. <tr><td><tt class="docutils literal"><span class="pre">\011</span></tt></td><td>is always a tab</td></tr>
    304. 

  304. <tr><td><tt class="docutils literal"><span class="pre">\0113</span></tt></td><td>is a tab followed by the character &quot;3&quot;</td></tr>
    305. 

  305. <tr><td><tt class="docutils literal"><span class="pre">\113</span></tt></td><td>might be a back reference, otherwise the character with octal code 113</td></tr>
    306. 

  306. <tr><td><tt class="docutils literal"><span class="pre">\377</span></tt></td><td>might be a back reference, otherwise the byte consisting entirely of 1 bits</td></tr>
    307. 

  307. <tr><td><tt class="docutils literal"><span class="pre">\81</span></tt></td><td>is either a back reference, or a binary zero followed by the two characters &quot;8&quot; and &quot;1&quot;</td></tr>
    308. 

  308. </table><p>Note that octal values of 100 or greater must not be introduced by a leading zero, because no more than three octal digits are ever read.</p>
    309. 

  309. <p>All the sequences that define a single byte value or a single UTF-8 character (in UTF-8 mode) can be used both inside and outside character classes. In addition, inside a character class, the sequence <tt class="docutils literal"><span class="pre">\b</span></tt> is interpreted as the backspace character (hex 08), and the sequence <tt class="docutils literal"><span class="pre">\X</span></tt> is interpreted as the character &quot;X&quot;. Outside a character class, these sequences have different meanings (see below).</p>
    310. 

  310. 

  311. <h2><a class="toc-backref" id="regular-expression-syntax-and-semantics-generic-character-types" href="#regular-expression-syntax-and-semantics-generic-character-types">Generic character types</a></h2><p>The third use of backslash is for specifying <span id="generic-character-types_1">generic character types</span>. The following are always recognized:</p>
    312. 

  312. <table border="1" class="docutils"><tr><th>character type</th><th>meaning</th></tr>
    313. 

  313. <tr><td><tt class="docutils literal"><span class="pre">\d</span></tt></td><td>any decimal digit</td></tr>
    314. 

  314. <tr><td><tt class="docutils literal"><span class="pre">\D</span></tt></td><td>any character that is not a decimal digit</td></tr>
    315. 

  315. <tr><td><tt class="docutils literal"><span class="pre">\s</span></tt></td><td>any whitespace character</td></tr>
    316. 

  316. <tr><td><tt class="docutils literal"><span class="pre">\S</span></tt></td><td>any character that is not a whitespace character</td></tr>
    317. 

  317. <tr><td><tt class="docutils literal"><span class="pre">\w</span></tt></td><td>any &quot;word&quot; character</td></tr>
    318. 

  318. <tr><td><tt class="docutils literal"><span class="pre">\W</span></tt></td><td>any &quot;non-word&quot; character</td></tr>
    319. 

  319. </table><p>Each pair of escape sequences partitions the complete set of characters into two disjoint sets. Any given character matches one, and only one, of each pair.</p>
    320. 

  320. <p>These character type sequences can appear both inside and outside character classes. They each match one character of the appropriate type. If the current matching point is at the end of the subject string, all of them fail, since there is no character to match.</p>
    321. 

  321. <p>For compatibility with Perl, <tt class="docutils literal"><span class="pre">\s</span></tt> does not match the VT character (code 11). This makes it different from the POSIX &quot;space&quot; class. The <tt class="docutils literal"><span class="pre">\s</span></tt> characters are HT (9), LF (10), FF (12), CR (13), and space (32).</p>
    322. 

  322. <p>A &quot;word&quot; character is an underscore or any character less than 256 that is a letter or digit. The definition of letters and digits is controlled by PCRE's low-valued character tables, and may vary if locale-specific matching is taking place (see &quot;Locale support&quot; in the pcreapi page). For example, in the &quot;fr_FR&quot; (French) locale, some character codes greater than 128 are used for accented letters, and these are matched by <tt class="docutils literal"><span class="pre">\w</span></tt>.</p>
    323. 

  323. <p>In UTF-8 mode, characters with values greater than 128 never match <tt class="docutils literal"><span class="pre">\d</span></tt>, <tt class="docutils literal"><span class="pre">\s</span></tt>, or <tt class="docutils literal"><span class="pre">\w</span></tt>, and always match <tt class="docutils literal"><span class="pre">\D</span></tt>, <tt class="docutils literal"><span class="pre">\S</span></tt>, and <tt class="docutils literal"><span class="pre">\W</span></tt>. This is true even when Unicode character property support is available.</p>
    324. 

  324. 

  325. <h2><a class="toc-backref" id="regular-expression-syntax-and-semantics-simple-assertions" href="#regular-expression-syntax-and-semantics-simple-assertions">Simple assertions</a></h2><p>The fourth use of backslash is for certain <span id="simple-assertions_1">simple assertions</span>. An assertion specifies a condition that has to be met at a particular point in a match, without consuming any characters from the subject string. The use of subpatterns for more complicated assertions is described below. The backslashed assertions are:</p>
    326. 

  326. <table border="1" class="docutils"><tr><th>assertion</th><th>meaning</th></tr>
    327. 

  327. <tr><td><tt class="docutils literal"><span class="pre">\b</span></tt></td><td>matches at a word boundary</td></tr>
    328. 

  328. <tr><td><tt class="docutils literal"><span class="pre">\B</span></tt></td><td>matches when not at a word boundary</td></tr>
    329. 

  329. <tr><td><tt class="docutils literal"><span class="pre">\A</span></tt></td><td>matches at start of subject</td></tr>
    330. 

  330. <tr><td><tt class="docutils literal"><span class="pre">\Z</span></tt></td><td>matches at end of subject or before newline at end</td></tr>
    331. 

  331. <tr><td><tt class="docutils literal"><span class="pre">\z</span></tt></td><td>matches at end of subject</td></tr>
    332. 

  332. <tr><td><tt class="docutils literal"><span class="pre">\G</span></tt></td><td>matches at first matching position in subject</td></tr>
    333. 

  333. </table><p>These assertions may not appear in character classes (but note that <tt class="docutils literal"><span class="pre">\b</span></tt> has a different meaning, namely the backspace character, inside a character class).</p>
    334. 

  334. <p>A word boundary is a position in the subject string where the current character and the previous character do not both match <tt class="docutils literal"><span class="pre">\w</span></tt> or <tt class="docutils literal"><span class="pre">\W</span></tt> (i.e. one matches <tt class="docutils literal"><span class="pre">\w</span></tt> and the other matches <tt class="docutils literal"><span class="pre">\W</span></tt>), or the start or end of the string if the first or last character matches <tt class="docutils literal"><span class="pre">\w</span></tt>, respectively.</p>
    335. 

  335. <p>The <tt class="docutils literal"><span class="pre">\A</span></tt>, <tt class="docutils literal"><span class="pre">\Z</span></tt>, and <tt class="docutils literal"><span class="pre">\z</span></tt> assertions differ from the traditional circumflex and dollar in that they only ever match at the very start and end of the subject string, whatever options are set. The difference between <tt class="docutils literal"><span class="pre">\Z</span></tt> and <tt class="docutils literal"><span class="pre">\z</span></tt> is that <tt class="docutils literal"><span class="pre">\Z</span></tt> matches before a newline that is the last character of the string as well as at the end of the string, whereas <tt class="docutils literal"><span class="pre">\z</span></tt> matches only at the end. </p>
    336. 

  336. 

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

  338. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">re</span>
    339. 

  339. <span class="Comment">## Unless specified otherwise, `start` parameter in each proc indicates</span>
    340. 

  340. <span class="Comment">## where the scan starts, but outputs are relative to the start of the input</span>
    341. 

  341. <span class="Comment">## string, not to `start`:</span>
    342. 

  342. <span class="Identifier">doAssert</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="DecNumber">2</span> <span class="Comment"># lookbehind assertion</span>
    343. 

  343. <span class="Identifier">doAssert</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="Operator">-</span><span class="DecNumber">1</span> <span class="Comment"># we're past `start` =&gt; not found</span>
    344. 

  344. <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">match</span><span class="Punctuation">(</span><span class="StringLit">&quot;xabc&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;^abc$&quot;</span><span class="Punctuation">,</span> <span class="Identifier">start</span> <span class="Operator">=</span> <span class="DecNumber">1</span><span class="Punctuation">)</span>
    345. 

  345.   <span class="Comment"># can't match start of string since we're starting at 1</span></pre></p>
    346. 

  346.     <div class="section" id="6">
    347. 

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

  348.   <dl class="item">
    349. 

  349.     <a class="reference external" href="pcre.html">pcre</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="rtarrays.html">rtarrays</a>, <a class="reference external" href="syncio.html">syncio</a>
    350. 

  350.   </dl>
    351. 

  351. </div>
    352. 

  352. <div class="section" id="7">
    353. 

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

  354.   <dl class="item">
    355. 

  355.     <div id="Regex">
    356. 

  356.   <dt><pre><a href="re.html#Regex"><span class="Identifier">Regex</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">RegexDesc</span></pre></dt>
    357. 

  357.   <dd>
    358. 

  358.     
    359. 

  359.     a compiled regular expression
    360. 

  360.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L62" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    361. 

  361. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L62" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    362. 

  362. 

  363.   </dd>
    364. 

  364. </div>
    365. 

  365. <div id="RegexError">
    366. 

  366.   <dt><pre><a href="re.html#RegexError"><span class="Identifier">RegexError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a></pre></dt>
    367. 

  367.   <dd>
    368. 

  368.     
    369. 

  369.     is raised if the pattern is no valid regular expression.
    370. 

  370.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L64" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    371. 

  371. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L64" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    372. 

  372. 

  373.   </dd>
    374. 

  374. </div>
    375. 

  375. <div id="RegexFlag">
    376. 

  376.   <dt><pre><a href="re.html#RegexFlag"><span class="Identifier">RegexFlag</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    377. 

  377.   <span class="Identifier">reIgnoreCase</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span>         <span class="Comment">## do caseless matching</span>
    378. 

  378.   <span class="Identifier">reMultiLine</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">,</span>          <span class="Comment">## `^` and `$` match newlines within data</span>
    379. 

  379.   <span class="Identifier">reDotAll</span> <span class="Other">=</span> <span class="DecNumber">2</span><span class="Other">,</span>             <span class="Comment">## `.` matches anything including NL</span>
    380. 

  380.   <span class="Identifier">reExtended</span> <span class="Other">=</span> <span class="DecNumber">3</span><span class="Other">,</span>           <span class="Comment">## ignore whitespace and `#` comments</span>
    381. 

  381.   <span class="Identifier">reStudy</span> <span class="Other">=</span> <span class="DecNumber">4</span>                <span class="Comment">## study the expression (may be omitted if the</span>
    382. 

  382.                              <span class="Comment">## expression will be used only once)</span></pre></dt>
    383. 

  383.   <dd>
    384. 

  384.     
    385. 

  385.     options for regular expressions
    386. 

  386.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L50" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    387. 

  387. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L50" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    388. 

  388. 

  389.   </dd>
    390. 

  390. </div>
    391. 

  391. 

  392.   </dl>
    393. 

  393. </div>
    394. 

  394. <div class="section" id="10">
    395. 

  395.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    396. 

  396.   <dl class="item">
    397. 

  397.     <div id="MaxReBufSize">
    398. 

  398.   <dt><pre><a href="re.html#MaxReBufSize"><span class="Identifier">MaxReBufSize</span></a> <span class="Other">=</span> <span class="DecNumber">2147483647'i32</span></pre></dt>
    399. 

  399.   <dd>
    400. 

  400.     
    401. 

  401.     Maximum PCRE (API 1) buffer start/size equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">cint</span><span class="Punctuation">)</span></span></tt>, which even for 64-bit systems can be either 2<sup>31</sup>-1 or 2<sup>63</sup>-1.
    402. 

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

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

  404. 

  405.   </dd>
    406. 

  406. </div>
    407. 

  407. <div id="MaxSubpatterns">
    408. 

  408.   <dt><pre><a href="re.html#MaxSubpatterns"><span class="Identifier">MaxSubpatterns</span></a> <span class="Other">=</span> <span class="DecNumber">20</span></pre></dt>
    409. 

  409.   <dd>
    410. 

  410.     
    411. 

  411.     defines the maximum number of subpatterns that can be captured. This limit still exists for <tt class="docutils literal"><span class="pre"><span class="Identifier">replacef</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">parallelReplace</span></span></tt>.
    412. 

  412.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L45" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    413. 

  413. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L45" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    414. 

  414. 

  415.   </dd>
    416. 

  416. </div>
    417. 

  417. 

  418.   </dl>
    419. 

  419. </div>
    420. 

  420. <div class="section" id="12">
    421. 

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

  422.   <dl class="item">
    423. 

  423.     <div id="contains-procs-all">
    424. 

  424.   <div id="contains,string,Regex,openArray[string],int">
    425. 

  425.   <dt><pre><span class="Keyword">proc</span> <a href="#contains%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    426. 

  426.               <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#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    427. 

  427.   <dd>
    428. 

  428.     
    429. 

  429.     same as <tt class="docutils literal"><span class="pre"><span class="Identifier">find</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Identifier">pattern</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">,</span> <span class="Identifier">start</span><span class="Punctuation">)</span> <span class="Operator">&gt;=</span> <span class="DecNumber">0</span></span></tt><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    430. 

  430. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    431. 

  431. 

  432.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L478" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    433. 

  433. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L478" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    434. 

  434. 

  435.   </dd>
    436. 

  436. </div>
    437. 

  437. <div id="contains,string,Regex,int">
    438. 

  438.   <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">s</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="re.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="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    439. 

  439.     <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>
    440. 

  440.   <dd>
    441. 

  441.     
    442. 

  442.     same as <tt class="docutils literal"><span class="pre"><span class="Identifier">find</span><span class="Punctuation">(</span><span class="Identifier">s</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="Operator">&gt;=</span> <span class="DecNumber">0</span></span></tt>
    443. 

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

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

  445. 

  446.   </dd>
    447. 

  447. </div>
    448. 

  448. 

  449. </div>
    450. 

  450. <div id="endsWith-procs-all">
    451. 

  451.   <div id="endsWith,string,Regex">
    452. 

  452.   <dt><pre><span class="Keyword">proc</span> <a href="#endsWith%2Cstring%2CRegex"><span class="Identifier">endsWith</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">suffix</span><span class="Other">:</span> <a href="re.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 class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    453. 

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

  454.   <dd>
    455. 

  455.     
    456. 

  456.     returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> ends with the pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">suffix</span></span></tt>
    457. 

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

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

  459. 

  460.   </dd>
    461. 

  461. </div>
    462. 

  462. 

  463. </div>
    464. 

  464. <div id="escapeRe-procs-all">
    465. 

  465.   <div id="escapeRe,string">
    466. 

  466.   <dt><pre><span class="Keyword">proc</span> <a href="#escapeRe%2Cstring"><span class="Identifier">escapeRe</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="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>
    467. 

  467.   <dd>
    468. 

  468.     
    469. 

  469.     escapes <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> so that it is matched verbatim when used as a regular expression.
    470. 

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

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

  472. 

  473.   </dd>
    474. 

  474. </div>
    475. 

  475. 

  476. </div>
    477. 

  477. <div id="find-procs-all">
    478. 

  478.   <div id="find,cstring,Regex,openArray[string],int,int">
    479. 

  479.   <dt><pre><span class="Keyword">proc</span> <a href="#find%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint"><span class="Identifier">find</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    480. 

  480.           <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">bufSize</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#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="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>
    481. 

  481.   <dd>
    482. 

  482.     
    483. 

  483.     returns the starting position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned. <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> has length <tt class="docutils literal"><span class="pre"><span class="Identifier">bufSize</span></span></tt> (not necessarily <tt class="docutils literal"><span class="pre"><span class="CharLit">'\0'</span></span></tt> terminated).<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    484. 

  484. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    485. 

  485. 

  486.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L352" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    487. 

  487. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L352" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    488. 

  488. 

  489.   </dd>
    490. 

  490. </div>
    491. 

  491. <div id="find,cstring,Regex,int,int">
    492. 

  492.   <dt><pre><span class="Keyword">proc</span> <a href="#find%2Ccstring%2CRegex%2Cint%2Cint"><span class="Identifier">find</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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">bufSize</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#int"><span class="Identifier">int</span></a> {.
    493. 

  493.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    494. 

  494.   <dd>
    495. 

  495.     
    496. 

  496.     returns the starting position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt>, where <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> has length <tt class="docutils literal"><span class="pre"><span class="Identifier">bufSize</span></span></tt> (not necessarily <tt class="docutils literal"><span class="pre"><span class="CharLit">'\0'</span></span></tt> terminated). If it does not match, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned.
    497. 

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

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

  499. 

  500.   </dd>
    501. 

  501. </div>
    502. 

  502. <div id="find,string,Regex,openArray[string],int">
    503. 

  503.   <dt><pre><span class="Keyword">proc</span> <a href="#find%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">find</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</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#int"><span class="Identifier">int</span></a> {.
    504. 

  504.     <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    505. 

  505.   <dd>
    506. 

  506.     
    507. 

  507.     returns the starting position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    508. 

  508. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    509. 

  509. 

  510.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L373" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    511. 

  511. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L373" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    512. 

  512. 

  513.   </dd>
    514. 

  514. </div>
    515. 

  515. <div id="find,string,Regex,int">
    516. 

  516.   <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">s</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="re.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="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    517. 

  517.     <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>
    518. 

  518.   <dd>
    519. 

  519.     
    520. 

  520.     returns the starting position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. If it does not match, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned. We start the scan at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt>.
    521. 

  521. <p><strong class="examples_text">Example:</strong></p>
    522. 

  522. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;cde&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    523. 

  523. <span class="Identifier">doAssert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;abc&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    524. 

  524. <span class="Identifier">doAssert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;zz&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span> <span class="Comment"># not found</span>
    525. 

  525. <span class="Identifier">doAssert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;cde&quot;</span><span class="Punctuation">,</span> <span class="Identifier">start</span> <span class="Operator">=</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment"># still 2</span>
    526. 

  526. <span class="Identifier">doAssert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;cde&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="Operator">-</span><span class="DecNumber">1</span> <span class="Comment"># we're past the start position</span>
    527. 

  527. <span class="Identifier">doAssert</span> <span class="Identifier">find</span><span class="Punctuation">(</span><span class="StringLit">&quot;xabc&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(?&lt;=x|y)abc&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="DecNumber">1</span>
    528. 

  528.   <span class="Comment"># lookbehind assertion `(?&lt;=x|y)` can look behind `start`</span></pre>
    529. 

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

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

  531. 

  532.   </dd>
    533. 

  533. </div>
    534. 

  534. 

  535. </div>
    536. 

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

  537.   <div id="findAll,string,Regex,int">
    538. 

  538.   <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">s</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="re.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="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> {.<span class="Identifier">inline</span><span class="Other">,</span>
    539. 

  539.     <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>
    540. 

  540.   <dd>
    541. 

  541.     
    542. 

  542.     returns all matching <tt class="docutils literal"><span class="pre"><span class="Identifier">substrings</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> that match <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>. If it does not match, <tt class="docutils literal"><span class="pre"><span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt> is returned.
    543. 

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

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

  545. 

  546.   </dd>
    547. 

  547. </div>
    548. 

  548. 

  549. </div>
    550. 

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

  551.   <div id="findBounds,cstring,Regex,openArray[tuple[int,int]],int,int">
    552. 

  552.   <dt><pre><span class="Keyword">proc</span> <a href="#findBounds%2Ccstring%2CRegex%2CopenArray%5Btuple%5Bint%2Cint%5D%5D%2Cint%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span>
    553. 

  553.                 <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><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="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span>
    554. 

  554.                 <span class="Identifier">bufSize</span><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="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><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>
    555. 

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

  556.   <dd>
    557. 

  557.     
    558. 

  558.     returns the starting position and end position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> (where <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> has length <tt class="docutils literal"><span class="pre"><span class="Identifier">bufSize</span></span></tt> and is not necessarily <tt class="docutils literal"><span class="pre"><span class="CharLit">'\0'</span></span></tt> terminated), and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">0</span><span class="Punctuation">)</span></span></tt> is returned.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    559. 

  559. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    560. 

  560. 

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

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

  563. 

  564.   </dd>
    565. 

  565. </div>
    566. 

  566. <div id="findBounds,cstring,Regex,openArray[string],int,int">
    567. 

  567.   <dt><pre><span class="Keyword">proc</span> <a href="#findBounds%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    568. 

  568.                 <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">bufSize</span><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="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><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>
    569. 

  569.     <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>
    570. 

  570.   <dd>
    571. 

  571.     
    572. 

  572.     <p>returns the starting position and end position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> (where <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> has length <tt class="docutils literal"><span class="pre"><span class="Identifier">bufSize</span></span></tt> and is not necessarily <tt class="docutils literal"><span class="pre"><span class="CharLit">'\0'</span></span></tt> terminated), and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">0</span><span class="Punctuation">)</span></span></tt> is returned.</p>
    573. 

  573. <p>Note: The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</p>
    574. 

  574. 

  575.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L161" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    576. 

  576. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L161" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    577. 

  577. 

  578.   </dd>
    579. 

  579. </div>
    580. 

  580. <div id="findBounds,cstring,Regex,int,int">
    581. 

  581.   <dt><pre><span class="Keyword">proc</span> <a href="#findBounds%2Ccstring%2CRegex%2Cint%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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">bufSize</span><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="Keyword">tuple</span><span class="Other">[</span>
    582. 

  582.     <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    583. 

  583.   <dd>
    584. 

  584.     
    585. 

  585.     returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">first</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">last</span></span></tt> position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt>, where <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> has length <tt class="docutils literal"><span class="pre"><span class="Identifier">bufSize</span></span></tt> (not necessarily <tt class="docutils literal"><span class="pre"><span class="CharLit">'\0'</span></span></tt> terminated). If it does not match, <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">0</span><span class="Punctuation">)</span></span></tt> is returned.
    586. 

  586.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L254" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    587. 

  587. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L254" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    588. 

  588. 

  589.   </dd>
    590. 

  590. </div>
    591. 

  591. <div id="findBounds,string,Regex,openArray[tuple[int,int]],int">
    592. 

  592.   <dt><pre><span class="Keyword">proc</span> <a href="#findBounds%2Cstring%2CRegex%2CopenArray%5Btuple%5Bint%2Cint%5D%5D%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span>
    593. 

  593.                 <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><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="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span>
    594. 

  594.     <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    595. 

  595.   <dd>
    596. 

  596.     
    597. 

  597.     returns the starting position and end position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">0</span><span class="Punctuation">)</span></span></tt> is returned.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    598. 

  598. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    599. 

  599. 

  600. <p><strong class="examples_text">Example:</strong></p>
    601. 

  601. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">matches</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">first</span><span class="Punctuation">,</span> <span class="Identifier">last</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
    602. 

  602. <span class="Keyword">let</span> <span class="Punctuation">(</span><span class="Identifier">first</span><span class="Punctuation">,</span> <span class="Identifier">last</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">findBounds</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(\w+)&quot;</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">)</span>
    603. 

  603. <span class="Identifier">doAssert</span> <span class="Identifier">first</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    604. 

  604. <span class="Identifier">doAssert</span> <span class="Identifier">last</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    605. 

  605. <span class="Identifier">doAssert</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span></pre>
    606. 

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

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

  608. 

  609.   </dd>
    610. 

  610. </div>
    611. 

  611. <div id="findBounds,string,Regex,openArray[string],int">
    612. 

  612.   <dt><pre><span class="Keyword">proc</span> <a href="#findBounds%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    613. 

  613.                 <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    614. 

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

  615.   <dd>
    616. 

  616.     
    617. 

  617.     returns the starting position and end position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">0</span><span class="Punctuation">)</span></span></tt> is returned.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    618. 

  618. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    619. 

  619. 

  620. <p><strong class="examples_text">Example:</strong></p>
    621. 

  621. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">matches</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
    622. 

  622. <span class="Keyword">let</span> <span class="Punctuation">(</span><span class="Identifier">first</span><span class="Punctuation">,</span> <span class="Identifier">last</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">findBounds</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;(W\w+)&quot;</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">)</span>
    623. 

  623. <span class="Identifier">doAssert</span> <span class="Identifier">first</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    624. 

  624. <span class="Identifier">doAssert</span> <span class="Identifier">last</span> <span class="Operator">==</span> <span class="DecNumber">10</span>
    625. 

  625. <span class="Identifier">doAssert</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">&quot;World&quot;</span></pre>
    626. 

  626.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L184" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    627. 

  627. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L184" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    628. 

  628. 

  629.   </dd>
    630. 

  630. </div>
    631. 

  631. <div id="findBounds,string,Regex,int">
    632. 

  632.   <dt><pre><span class="Keyword">proc</span> <a href="#findBounds%2Cstring%2CRegex%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.
    633. 

  633.     <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    634. 

  634.   <dd>
    635. 

  635.     
    636. 

  636.     <p>returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">first</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">last</span></span></tt> position of <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. If it does not match, <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">0</span><span class="Punctuation">)</span></span></tt> is returned.</p>
    637. 

  637. <p>Note: there is a speed improvement if the matches do not need to be captured.</p>
    638. 

  638. 

  639. <p><strong class="examples_text">Example:</strong></p>
    640. 

  640. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">findBounds</span><span class="Punctuation">(</span><span class="StringLit">&quot;01234abc89&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;abc&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">,</span><span class="DecNumber">7</span><span class="Punctuation">)</span></pre>
    641. 

  641.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L267" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    642. 

  642. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L267" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    643. 

  643. 

  644.   </dd>
    645. 

  645. </div>
    646. 

  646. 

  647. </div>
    648. 

  648. <div id="match-procs-all">
    649. 

  649.   <div id="match,cstring,Regex,openArray[string],int,int">
    650. 

  650.   <dt><pre><span class="Keyword">proc</span> <a href="#match%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint"><span class="Identifier">match</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    651. 

  651.            <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">bufSize</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 class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    652. 

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

  653.   <dd>
    654. 

  654.     
    655. 

  655.     returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Operator">..&lt;</span><span class="Identifier">bufSize</span><span class="Punctuation">]</span></span></tt> matches the <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> is returned. <tt class="docutils literal"><span class="pre"><span class="Identifier">buf</span></span></tt> has length <tt class="docutils literal"><span class="pre"><span class="Identifier">bufSize</span></span></tt> (not necessarily <tt class="docutils literal"><span class="pre"><span class="CharLit">'\0'</span></span></tt> terminated).<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    656. 

  656. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    657. 

  657. 

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

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

  660. 

  661.   </dd>
    662. 

  662. </div>
    663. 

  663. <div id="match,string,Regex,openArray[string],int">
    664. 

  664.   <dt><pre><span class="Keyword">proc</span> <a href="#match%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">match</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</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#bool"><span class="Identifier">bool</span></a> {.
    665. 

  665.     <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    666. 

  666.   <dd>
    667. 

  667.     
    668. 

  668.     returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Operator">..</span><span class="Punctuation">]</span></span></tt> matches the <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> is returned.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    669. 

  669. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    670. 

  670. 

  671. <p><strong class="examples_text">Example:</strong></p>
    672. 

  672. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sequtils</span>
    673. 

  673. <span class="Keyword">var</span> <span class="Identifier">matches</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">string</span><span class="Punctuation">]</span>
    674. 

  674. <span class="Keyword">if</span> <span class="Identifier">match</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;c(d)ef(g)&quot;</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    675. 

  675.   <span class="Identifier">doAssert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">matches</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;d&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;g&quot;</span><span class="Punctuation">]</span></pre>
    676. 

  676.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L326" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    677. 

  677. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L326" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    678. 

  678. 

  679.   </dd>
    680. 

  680. </div>
    681. 

  681. <div id="match,string,Regex,int">
    682. 

  682.   <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">s</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="re.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="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    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.     returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Operator">..</span><span class="Punctuation">]</span></span></tt> matches the <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>.
    687. 

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

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

  689. 

  690.   </dd>
    691. 

  691. </div>
    692. 

  692. 

  693. </div>
    694. 

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

  695.   <div id="matchLen,cstring,Regex,openArray[string],int,int">
    696. 

  696.   <dt><pre><span class="Keyword">proc</span> <a href="#matchLen%2Ccstring%2CRegex%2CopenArray%5Bstring%5D%2Cint%2Cint"><span class="Identifier">matchLen</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    697. 

  697.               <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">bufSize</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#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    698. 

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

  699.   <dd>
    700. 

  700.     
    701. 

  701.     the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt>, but it returns the length of the match, if there is no match, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned. Note that a match length of zero can happen.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    702. 

  702. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    703. 

  703. 

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

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

  706. 

  707.   </dd>
    708. 

  708. </div>
    709. 

  709. <div id="matchLen,cstring,Regex,int,int">
    710. 

  710.   <dt><pre><span class="Keyword">proc</span> <a href="#matchLen%2Ccstring%2CRegex%2Cint%2Cint"><span class="Identifier">matchLen</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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">bufSize</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#int"><span class="Identifier">int</span></a> {.
    711. 

  711.     <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    712. 

  712.   <dd>
    713. 

  713.     
    714. 

  714.     the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt>, but it returns the length of the match, if there is no match, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned. Note that a match length of zero can happen.
    715. 

  715.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L316" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    716. 

  716. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L316" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    717. 

  717. 

  718.   </dd>
    719. 

  719. </div>
    720. 

  720. <div id="matchLen,string,Regex,openArray[string],int">
    721. 

  721.   <dt><pre><span class="Keyword">proc</span> <a href="#matchLen%2Cstring%2CRegex%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">matchLen</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    722. 

  722.               <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#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    723. 

  723.   <dd>
    724. 

  724.     
    725. 

  725.     the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt>, but it returns the length of the match, if there is no match, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned. Note that a match length of zero can happen.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    726. 

  726. The memory for <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> needs to be allocated before this function is called, otherwise it will just remain empty.</div>
    727. 

  727. 

  728.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L287" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    729. 

  729. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L287" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    730. 

  730. 

  731.   </dd>
    732. 

  732. </div>
    733. 

  733. <div id="matchLen,string,Regex,int">
    734. 

  734.   <dt><pre><span class="Keyword">proc</span> <a href="#matchLen%2Cstring%2CRegex%2Cint"><span class="Identifier">matchLen</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    735. 

  735.     <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>
    736. 

  736.   <dd>
    737. 

  737.     
    738. 

  738.     the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt>, but it returns the length of the match, if there is no match, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="DecNumber">1</span></span></tt> is returned. Note that a match length of zero can happen. 
    739. 

  739. <p><strong class="examples_text">Example:</strong></p>
    740. 

  740. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">matchLen</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;cde&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    741. 

  741. <span class="Identifier">doAssert</span> <span class="Identifier">matchLen</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;abcde&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    742. 

  742. <span class="Identifier">doAssert</span> <span class="Identifier">matchLen</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcdefg&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;cde&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span></pre>
    743. 

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

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

  745. 

  746.   </dd>
    747. 

  747. </div>
    748. 

  748. 

  749. </div>
    750. 

  750. <div id="multiReplace-procs-all">
    751. 

  751.   <div id="multiReplace,string,openArray[tuple[Regex,string]]">
    752. 

  752.   <dt><pre><span class="Keyword">proc</span> <a href="#multiReplace%2Cstring%2CopenArray%5Btuple%5BRegex%2Cstring%5D%5D"><span class="Identifier">multiReplace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    753. 

  753.                   <span class="Identifier">subs</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">,</span> <span class="Identifier">repl</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><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    754. 

  754.     <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>
    755. 

  755.   <dd>
    756. 

  756.     
    757. 

  757.     Returns a modified copy of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> with the substitutions in <tt class="docutils literal"><span class="pre"><span class="Identifier">subs</span></span></tt> applied in parallel.
    758. 

  758.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L533" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    759. 

  759. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L533" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    760. 

  760. 

  761.   </dd>
    762. 

  762. </div>
    763. 

  763. 

  764. </div>
    765. 

  765. <div id="re-procs-all">
    766. 

  766.   <div id="re,string">
    767. 

  767.   <dt><pre><span class="Keyword">proc</span> <a href="#re%2Cstring"><span class="Identifier">re</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">reStudy</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <a href="re.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">RegexError</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>
    768. 

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

  769.   <dd>
    770. 

  770.     
    771. 

  771.     <p>Constructor of regular expressions.</p>
    772. 

  772. <p>Note that Nim's extended raw string literals support the syntax <tt class="docutils literal"><span class="pre"><span class="RawData">re&quot;[abc]&quot;</span></span></tt> as a short form for <tt class="docutils literal"><span class="pre"><span class="Identifier">re</span><span class="Punctuation">(</span><span class="RawData">r&quot;[abc]&quot;</span><span class="Punctuation">)</span></span></tt>. Also note that since this compiles the regular expression, which is expensive, you should avoid putting it directly in the arguments of the functions like the examples show below if you plan to use it a lot of times, as this will hurt performance immensely. (e.g. outside a loop, ...)</p>
    773. 

  773. 

  774.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L101" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    775. 

  775. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L101" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    776. 

  776. 

  777.   </dd>
    778. 

  778. </div>
    779. 

  779. 

  780. </div>
    781. 

  781. <div id="replace-procs-all">
    782. 

  782.   <div id="replace,string,Regex,string">
    783. 

  783.   <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">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sub</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">by</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><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>
    784. 

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

  785.   <dd>
    786. 

  786.     
    787. 

  787.     Replaces <tt class="docutils literal"><span class="pre"><span class="Identifier">sub</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> by the string <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt>. Captures cannot be accessed in <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt>.
    788. 

  788. <p><strong class="examples_text">Example:</strong></p>
    789. 

  789. <pre class="listing"><span class="Identifier">doAssert</span> <span class="StringLit">&quot;var1=key; var2=key2&quot;</span><span class="Operator">.</span><span class="Identifier">replace</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w+)=(\w+)&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;; &quot;</span>
    790. 

  790. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;var1=key; var2=key2&quot;</span><span class="Operator">.</span><span class="Identifier">replace</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w+)=(\w+)&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;?&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;?; ?&quot;</span></pre>
    791. 

  791.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L494" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    792. 

  792. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L494" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    793. 

  793. 

  794.   </dd>
    795. 

  795. </div>
    796. 

  796. 

  797. </div>
    798. 

  798. <div id="replacef-procs-all">
    799. 

  799.   <div id="replacef,string,Regex,string">
    800. 

  800.   <dt><pre><span class="Keyword">proc</span> <a href="#replacef%2Cstring%2CRegex%2Cstring"><span class="Identifier">replacef</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sub</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">;</span> <span class="Identifier">by</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">ValueError</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="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.     Replaces <tt class="docutils literal"><span class="pre"><span class="Identifier">sub</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> by the string <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt>. Captures can be accessed in <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt> with the notation <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Identifier">i</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Comment">#</span></span></tt> (see strutils.`%`).
    805. 

  805. <p><strong class="examples_text">Example:</strong></p>
    806. 

  806. <pre class="listing"><span class="Identifier">doAssert</span> <span class="StringLit">&quot;var1=key; var2=key2&quot;</span><span class="Operator">.</span><span class="Identifier">replacef</span><span class="Punctuation">(</span><span class="RawData">re&quot;(\w+)=(\w+)&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;$1&lt;-$2$2&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    807. 

  807.   <span class="StringLit">&quot;var1&lt;-keykey; var2&lt;-key2key2&quot;</span></pre>
    808. 

  808.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L515" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    809. 

  809. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L515" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    810. 

  810. 

  811.   </dd>
    812. 

  812. </div>
    813. 

  813. 

  814. </div>
    815. 

  815. <div id="rex-procs-all">
    816. 

  816.   <div id="rex,string">
    817. 

  817.   <dt><pre><span class="Keyword">proc</span> <a href="#rex%2Cstring"><span class="Identifier">rex</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">reStudy</span><span class="Other">,</span> <span class="Identifier">reExtended</span><span class="Other">}</span><span class="Other">)</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a> {.
    818. 

  818.     <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">RegexError</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>
    819. 

  819.   <dd>
    820. 

  820.     
    821. 

  821.     <p>Constructor for extended regular expressions.</p>
    822. 

  822. <p>The extended means that comments starting with <tt class="docutils literal"><span class="pre"><span class="Comment">#</span></span></tt> and whitespace are ignored.</p>
    823. 

  823. 

  824.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    825. 

  825. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L126" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    826. 

  826. 

  827.   </dd>
    828. 

  828. </div>
    829. 

  829. 

  830. </div>
    831. 

  831. <div id="split-procs-all">
    832. 

  832.   <div id="split,string,Regex,int">
    833. 

  833.   <dt><pre><span class="Keyword">proc</span> <a href="#split%2Cstring%2CRegex%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sep</span><span class="Other">:</span> <a href="re.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="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> {.<span class="Identifier">inline</span><span class="Other">,</span>
    834. 

  834.     <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>
    835. 

  835.   <dd>
    836. 

  836.     
    837. 

  837.     <p>Splits the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into a seq of substrings.</p>
    838. 

  838. <p>The portion matched by <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt> is not returned.</p>
    839. 

  839. 

  840.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L594" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    841. 

  841. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L594" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    842. 

  842. 

  843.   </dd>
    844. 

  844. </div>
    845. 

  845. 

  846. </div>
    847. 

  847. <div id="startsWith-procs-all">
    848. 

  848.   <div id="startsWith,string,Regex">
    849. 

  849.   <dt><pre><span class="Keyword">proc</span> <a href="#startsWith%2Cstring%2CRegex"><span class="Identifier">startsWith</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">prefix</span><span class="Other">:</span> <a href="re.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 class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    850. 

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

  851.   <dd>
    852. 

  852.     
    853. 

  853.     returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> starts with the pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">prefix</span></span></tt>
    854. 

  854.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L485" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    855. 

  855. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L485" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    856. 

  856. 

  857.   </dd>
    858. 

  858. </div>
    859. 

  859. 

  860. </div>
    861. 

  861. <div id="transformFile-procs-all">
    862. 

  862.   <div id="transformFile,string,string,openArray[tuple[Regex,string]]">
    863. 

  863.   <dt><pre><span class="Keyword">proc</span> <a href="#transformFile%2Cstring%2Cstring%2CopenArray%5Btuple%5BRegex%2Cstring%5D%5D"><span class="Identifier">transformFile</span></a><span class="Other">(</span><span class="Identifier">infile</span><span class="Other">,</span> <span class="Identifier">outfile</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    864. 

  864.                    <span class="Identifier">subs</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">,</span> <span class="Identifier">repl</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> {.
    865. 

  865.     <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">IOError</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="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    866. 

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

  867.   <dd>
    868. 

  868.     
    869. 

  869.     reads in the file <tt class="docutils literal"><span class="pre"><span class="Identifier">infile</span></span></tt>, performs a parallel replacement (calls <tt class="docutils literal"><span class="pre"><span class="Identifier">parallelReplace</span></span></tt>) and writes back to <tt class="docutils literal"><span class="pre"><span class="Identifier">outfile</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurs. This is supposed to be used for quick scripting.
    870. 

  870.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L553" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    871. 

  871. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L553" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    872. 

  872. 

  873.   </dd>
    874. 

  874. </div>
    875. 

  875. 

  876. </div>
    877. 

  877. 

  878.   </dl>
    879. 

  879. </div>
    880. 

  880. <div class="section" id="15">
    881. 

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

  882.   <dl class="item">
    883. 

  883.     <div id="findAll-iterators-all">
    884. 

  884.   <div id="findAll.i,cstring,Regex,int,int">
    885. 

  885.   <dt><pre><span class="Keyword">iterator</span> <a href="#findAll.i%2Ccstring%2CRegex%2Cint%2Cint"><span class="Identifier">findAll</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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">bufSize</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> {.
    886. 

  886.     <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>
    887. 

  887.   <dd>
    888. 

  888.     
    889. 

  889.     <p>Yields all matching <tt class="docutils literal"><span class="pre"><span class="Identifier">substrings</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> that match <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>.</p>
    890. 

  890. <p>Note that since this is an iterator you should not modify the string you are iterating over: bad things could happen.</p>
    891. 

  891. 

  892.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L426" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    893. 

  893. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L426" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    894. 

  894. 

  895.   </dd>
    896. 

  896. </div>
    897. 

  897. <div id="findAll.i,string,Regex,int">
    898. 

  898.   <dt><pre><span class="Keyword">iterator</span> <a href="#findAll.i%2Cstring%2CRegex%2Cint"><span class="Identifier">findAll</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.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="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>
    899. 

  899.     <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>
    900. 

  900.   <dd>
    901. 

  901.     
    902. 

  902.     <p>Yields all matching <em>substrings</em> of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> that match <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>.</p>
    903. 

  903. <p>Note that since this is an iterator you should not modify the string you are iterating over: bad things could happen.</p>
    904. 

  904. 

  905.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L407" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    906. 

  906. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L407" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    907. 

  907. 

  908.   </dd>
    909. 

  909. </div>
    910. 

  910. 

  911. </div>
    912. 

  912. <div id="split-iterators-all">
    913. 

  913.   <div id="split.i,string,Regex,int">
    914. 

  914.   <dt><pre><span class="Keyword">iterator</span> <a href="#split.i%2Cstring%2CRegex%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sep</span><span class="Other">:</span> <a href="re.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="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>
    915. 

  915.     <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>
    916. 

  916.   <dd>
    917. 

  917.     
    918. 

  918.     <p>Splits the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into substrings.</p>
    919. 

  919. <p>Substrings are separated by the regular expression <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt> (and the portion matched by <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt> is not returned).</p>
    920. 

  920. 

  921. <p><strong class="examples_text">Example:</strong></p>
    922. 

  922. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sequtils</span>
    923. 

  923. <span class="Identifier">doAssert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;00232this02939is39an22example111&quot;</span><span class="Punctuation">,</span> <span class="RawData">re&quot;\d+&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    924. 

  924.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">]</span></pre>
    925. 

  925.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L561" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    926. 

  926. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L561" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    927. 

  927. 

  928.   </dd>
    929. 

  929. </div>
    930. 

  930. 

  931. </div>
    932. 

  932. 

  933.   </dl>
    934. 

  934. </div>
    935. 

  935. <div class="section" id="18">
    936. 

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

  937.   <dl class="item">
    938. 

  938.     <div id="=~-templates-all">
    939. 

  939.   <div id="=~.t,string,Regex">
    940. 

  940.   <dt><pre><span class="Keyword">template</span> <a href="#%3D~.t%2Cstring%2CRegex"><span class="Identifier">`=~`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="re.html#Regex"><span class="Identifier">Regex</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
    941. 

  941.   <dd>
    942. 

  942.     
    943. 

  943.     This calls <tt class="docutils literal"><span class="pre"><span class="Identifier">match</span></span></tt> with an implicit declared <tt class="docutils literal"><span class="pre"><span class="Identifier">matches</span></span></tt> array that can be used in the scope of the <tt class="docutils literal"><span class="pre"><span class="Operator">=~</span></span></tt> call:
    944. 

  944. <p><strong class="examples_text">Example:</strong></p>
    945. 

  945. <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">parse</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span>
    946. 

  946.   <span class="Keyword">if</span> <span class="Identifier">line</span> <span class="Operator">=~</span> <span class="RawData">re&quot;\s*(\w+)\s*\=\s*(\w+)&quot;</span><span class="Punctuation">:</span> <span class="Comment"># matches a key=value pair:</span>
    947. 

  947.     <span class="Identifier">result</span> <span class="Operator">=</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    948. 

  948.   <span class="Keyword">elif</span> <span class="Identifier">line</span> <span class="Operator">=~</span> <span class="RawData">re&quot;\s*(\#.*)&quot;</span><span class="Punctuation">:</span> <span class="Comment"># matches a comment</span>
    949. 

  949.     <span class="Comment"># note that the implicit `matches` array is different from 1st branch</span>
    950. 

  950.     <span class="Identifier">result</span> <span class="Operator">=</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">,</span><span class="Punctuation">)</span>
    951. 

  951.   <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">raiseAssert</span> <span class="StringLit">&quot;unreachable&quot;</span>
    952. 

  952.   <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">declared</span><span class="Punctuation">(</span><span class="Identifier">matches</span><span class="Punctuation">)</span>
    953. 

  953. <span class="Identifier">doAssert</span> <span class="Identifier">parse</span><span class="Punctuation">(</span><span class="StringLit">&quot;NAME = LENA&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;(&quot;NAME&quot;, &quot;LENA&quot;)&quot;&quot;&quot;</span>
    954. 

  954. <span class="Identifier">doAssert</span> <span class="Identifier">parse</span><span class="Punctuation">(</span><span class="StringLit">&quot;   # comment ... &quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;(&quot;# comment ... &quot;,)&quot;&quot;&quot;</span></pre>
    955. 

  955.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/impure/re.nim#L453" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    956. 

  956. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/impure/re.nim#L453" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    957. 

  957. 

  958.   </dd>
    959. 

  959. </div>
    960. 

  960. 

  961. </div>
    962. 

  962. 

  963.   </dl>
    964. 

  964. </div>
    965. 

  965. 

  966.   </div>
    967. 

  967. </div>
    968. 

  968. 

  969.       <div class="twelve-columns footer">
    970. 

  970.         <span class="nim-sprite"></span>
    971. 

  971.         <br>
    972. 

  972.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:27:43 UTC</small>
    973. 

  973.       </div>
    974. 

  974.     </div>
    975. 

  975.   </div>
    976. 

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

  977.     
    978. 

  978. </body>
    979. 

  979. </html>
    980. 

  980.