Ana Sayfa Keşfet Yardım
Giriş Yap
levovix
/
Nim
şunun yansıması https://github.com/nim-lang/Nim
İzle 1
Yıldızla 0
Çatalla 1
Dosyalar Sorunlar 0 Wiki
Dal: gh-pages
Dallar Biçim İmleri
Nim
/
parseutils.html

parseutils.html 223 KB
Kalıcı Bağlantı Geçmiş Ham

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306 
  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/parseutils</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/parseutils</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li>
    55. 

  55.   <details open>
    56. 

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

  57.     <ul class="simple simple-toc-section">
    58. 

  58.       <li><a class="reference" href="#InterpolatedKind" title="InterpolatedKind = enum
    59. 

  59.   ikStr,                    ## ``str`` part of the interpolated string
    60. 

  60.   ikDollar,                 ## escaped ``$`` part of the interpolated string
    61. 

  61.   ikVar,                    ## ``var`` part of the interpolated string
    62. 

  62.   ikExpr                     ## ``expr`` part of the interpolated string">InterpolatedKind</a></li>
    63. 

  63. 

  64.     </ul>
    65. 

  65.   </details>
    66. 

  66. </li>
    67. 

  67. <li>
    68. 

  68.   <details open>
    69. 

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

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

  71.       <ul class="simple nested-toc-section">captureBetween
    72. 

  72.   <li><a class="reference" href="#captureBetween%2CopenArray%5Bchar%5D%2Cchar%2Cchar" title="captureBetween(s: openArray[char]; first: char; second = '\x00'): string">captureBetween(s: openArray[char]; first: char; second = '\x00'): string</a></li>
    73. 

  73. <li><a class="reference" href="#captureBetween%2Cstring%2Cchar%2Cchar%2Cint" title="captureBetween(s: string; first: char; second = '\x00'; start = 0): string">captureBetween(s: string; first: char; second = '\x00'; start = 0): string</a></li>
    74. 

  74. 

  75. </ul>
    76. 

  76. <ul class="simple nested-toc-section">parseBiggestFloat
    77. 

  77.   <li><a class="reference" href="#parseBiggestFloat%2CopenArray%5Bchar%5D%2CBiggestFloat" title="parseBiggestFloat(s: openArray[char]; number: var BiggestFloat): int">parseBiggestFloat(s: openArray[char]; number: var BiggestFloat): int</a></li>
    78. 

  78. <li><a class="reference" href="#parseBiggestFloat%2Cstring%2CBiggestFloat%2Cint" title="parseBiggestFloat(s: string; number: var BiggestFloat; start = 0): int">parseBiggestFloat(s: string; number: var BiggestFloat; start = 0): int</a></li>
    79. 

  79. 

  80. </ul>
    81. 

  81. <ul class="simple nested-toc-section">parseBiggestInt
    82. 

  82.   <li><a class="reference" href="#parseBiggestInt%2CopenArray%5Bchar%5D%2CBiggestInt" title="parseBiggestInt(s: openArray[char]; number: var BiggestInt): int">parseBiggestInt(s: openArray[char]; number: var BiggestInt): int</a></li>
    83. 

  83. <li><a class="reference" href="#parseBiggestInt%2Cstring%2CBiggestInt%2Cint" title="parseBiggestInt(s: string; number: var BiggestInt; start = 0): int">parseBiggestInt(s: string; number: var BiggestInt; start = 0): int</a></li>
    84. 

  84. 

  85. </ul>
    86. 

  86. <ul class="simple nested-toc-section">parseBiggestUInt
    87. 

  87.   <li><a class="reference" href="#parseBiggestUInt%2CopenArray%5Bchar%5D%2CBiggestUInt" title="parseBiggestUInt(s: openArray[char]; number: var BiggestUInt): int">parseBiggestUInt(s: openArray[char]; number: var BiggestUInt): int</a></li>
    88. 

  88. <li><a class="reference" href="#parseBiggestUInt%2Cstring%2CBiggestUInt%2Cint" title="parseBiggestUInt(s: string; number: var BiggestUInt; start = 0): int">parseBiggestUInt(s: string; number: var BiggestUInt; start = 0): int</a></li>
    89. 

  89. 

  90. </ul>
    91. 

  91. <ul class="simple nested-toc-section">parseBin
    92. 

  92.   <li><a class="reference" href="#parseBin%2CopenArray%5Bchar%5D%2CT%2Cint" title="parseBin[T: SomeInteger](s: openArray[char]; number: var T; maxLen = 0): int">parseBin[T: SomeInteger](s: openArray[char]; number: var T; maxLen = 0): int</a></li>
    93. 

  93. <li><a class="reference" href="#parseBin%2Cstring%2CT%2Cint%2Cint" title="parseBin[T: SomeInteger](s: string; number: var T; start = 0; maxLen = 0): int">parseBin[T: SomeInteger](s: string; number: var T; start = 0; maxLen = 0): int</a></li>
    94. 

  94. 

  95. </ul>
    96. 

  96. <ul class="simple nested-toc-section">parseChar
    97. 

  97.   <li><a class="reference" href="#parseChar%2CopenArray%5Bchar%5D%2Cchar" title="parseChar(s: openArray[char]; c: var char): int">parseChar(s: openArray[char]; c: var char): int</a></li>
    98. 

  98. <li><a class="reference" href="#parseChar%2Cstring%2Cchar%2Cint" title="parseChar(s: string; c: var char; start = 0): int">parseChar(s: string; c: var char; start = 0): int</a></li>
    99. 

  99. 

  100. </ul>
    101. 

  101. <ul class="simple nested-toc-section">parseFloat
    102. 

  102.   <li><a class="reference" href="#parseFloat%2CopenArray%5Bchar%5D%2Cfloat" title="parseFloat(s: openArray[char]; number: var float): int">parseFloat(s: openArray[char]; number: var float): int</a></li>
    103. 

  103. <li><a class="reference" href="#parseFloat%2Cstring%2Cfloat%2Cint" title="parseFloat(s: string; number: var float; start = 0): int">parseFloat(s: string; number: var float; start = 0): int</a></li>
    104. 

  104. 

  105. </ul>
    106. 

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

  107.   <li><a class="reference" href="#parseHex%2CopenArray%5Bchar%5D%2CT%2Cint" title="parseHex[T: SomeInteger](s: openArray[char]; number: var T; maxLen = 0): int">parseHex[T: SomeInteger](s: openArray[char]; number: var T; maxLen = 0): int</a></li>
    108. 

  108. <li><a class="reference" href="#parseHex%2Cstring%2CT%2Cint%2Cint" title="parseHex[T: SomeInteger](s: string; number: var T; start = 0; maxLen = 0): int">parseHex[T: SomeInteger](s: string; number: var T; start = 0; maxLen = 0): int</a></li>
    109. 

  109. 

  110. </ul>
    111. 

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

  112.   <li><a class="reference" href="#parseIdent%2CopenArray%5Bchar%5D" title="parseIdent(s: openArray[char]): string">parseIdent(s: openArray[char]): string</a></li>
    113. 

  113. <li><a class="reference" href="#parseIdent%2CopenArray%5Bchar%5D%2Cstring" title="parseIdent(s: openArray[char]; ident: var string): int">parseIdent(s: openArray[char]; ident: var string): int</a></li>
    114. 

  114. <li><a class="reference" href="#parseIdent%2Cstring%2Cstring%2Cint" title="parseIdent(s: string; ident: var string; start = 0): int">parseIdent(s: string; ident: var string; start = 0): int</a></li>
    115. 

  115. <li><a class="reference" href="#parseIdent%2Cstring%2Cint" title="parseIdent(s: string; start = 0): string">parseIdent(s: string; start = 0): string</a></li>
    116. 

  116. 

  117. </ul>
    118. 

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

  119.   <li><a class="reference" href="#parseInt%2CopenArray%5Bchar%5D%2Cint" title="parseInt(s: openArray[char]; number: var int): int">parseInt(s: openArray[char]; number: var int): int</a></li>
    120. 

  120. <li><a class="reference" href="#parseInt%2Cstring%2Cint%2Cint" title="parseInt(s: string; number: var int; start = 0): int">parseInt(s: string; number: var int; start = 0): int</a></li>
    121. 

  121. 

  122. </ul>
    123. 

  123. <ul class="simple nested-toc-section">parseOct
    124. 

  124.   <li><a class="reference" href="#parseOct%2CopenArray%5Bchar%5D%2CT%2Cint" title="parseOct[T: SomeInteger](s: openArray[char]; number: var T; maxLen = 0): int">parseOct[T: SomeInteger](s: openArray[char]; number: var T; maxLen = 0): int</a></li>
    125. 

  125. <li><a class="reference" href="#parseOct%2Cstring%2CT%2Cint%2Cint" title="parseOct[T: SomeInteger](s: string; number: var T; start = 0; maxLen = 0): int">parseOct[T: SomeInteger](s: string; number: var T; start = 0; maxLen = 0): int</a></li>
    126. 

  126. 

  127. </ul>
    128. 

  128. <ul class="simple nested-toc-section">parseSaturatedNatural
    129. 

  129.   <li><a class="reference" href="#parseSaturatedNatural%2CopenArray%5Bchar%5D%2Cint" title="parseSaturatedNatural(s: openArray[char]; b: var int): int">parseSaturatedNatural(s: openArray[char]; b: var int): int</a></li>
    130. 

  130. <li><a class="reference" href="#parseSaturatedNatural%2Cstring%2Cint%2Cint" title="parseSaturatedNatural(s: string; b: var int; start = 0): int">parseSaturatedNatural(s: string; b: var int; start = 0): int</a></li>
    131. 

  131. 

  132. </ul>
    133. 

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

  134.   <li><a class="reference" href="#parseSize%2CopenArray%5Bchar%5D%2Cint64" title="parseSize(s: openArray[char]; size: var int64; alwaysBin = false): int">parseSize(s: openArray[char]; size: var int64; alwaysBin = false): int</a></li>
    135. 

  135. 

  136. </ul>
    137. 

  137. <ul class="simple nested-toc-section">parseUInt
    138. 

  138.   <li><a class="reference" href="#parseUInt%2CopenArray%5Bchar%5D%2Cuint" title="parseUInt(s: openArray[char]; number: var uint): int">parseUInt(s: openArray[char]; number: var uint): int</a></li>
    139. 

  139. <li><a class="reference" href="#parseUInt%2Cstring%2Cuint%2Cint" title="parseUInt(s: string; number: var uint; start = 0): int">parseUInt(s: string; number: var uint; start = 0): int</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">parseUntil
    143. 

  143.   <li><a class="reference" href="#parseUntil%2CopenArray%5Bchar%5D%2Cstring%2Cchar" title="parseUntil(s: openArray[char]; token: var string; until: char): int">parseUntil(s: openArray[char]; token: var string; until: char): int</a></li>
    144. 

  144. <li><a class="reference" href="#parseUntil%2CopenArray%5Bchar%5D%2Cstring%2Cset%5Bchar%5D" title="parseUntil(s: openArray[char]; token: var string; until: set[char]): int">parseUntil(s: openArray[char]; token: var string; until: set[char]): int</a></li>
    145. 

  145. <li><a class="reference" href="#parseUntil%2CopenArray%5Bchar%5D%2Cstring%2Cstring" title="parseUntil(s: openArray[char]; token: var string; until: string): int">parseUntil(s: openArray[char]; token: var string; until: string): int</a></li>
    146. 

  146. <li><a class="reference" href="#parseUntil%2Cstring%2Cstring%2Cchar%2Cint" title="parseUntil(s: string; token: var string; until: char; start = 0): int">parseUntil(s: string; token: var string; until: char; start = 0): int</a></li>
    147. 

  147. <li><a class="reference" href="#parseUntil%2Cstring%2Cstring%2Cset%5Bchar%5D%2Cint" title="parseUntil(s: string; token: var string; until: set[char]; start = 0): int">parseUntil(s: string; token: var string; until: set[char]; start = 0): int</a></li>
    148. 

  148. <li><a class="reference" href="#parseUntil%2Cstring%2Cstring%2Cstring%2Cint" title="parseUntil(s: string; token: var string; until: string; start = 0): int">parseUntil(s: string; token: var string; until: string; start = 0): int</a></li>
    149. 

  149. 

  150. </ul>
    151. 

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

  152.   <li><a class="reference" href="#parseWhile%2CopenArray%5Bchar%5D%2Cstring%2Cset%5Bchar%5D" title="parseWhile(s: openArray[char]; token: var string; validChars: set[char]): int">parseWhile(s: openArray[char]; token: var string; validChars: set[char]): int</a></li>
    153. 

  153. <li><a class="reference" href="#parseWhile%2Cstring%2Cstring%2Cset%5Bchar%5D%2Cint" title="parseWhile(s: string; token: var string; validChars: set[char]; start = 0): int">parseWhile(s: string; token: var string; validChars: set[char]; start = 0): int</a></li>
    154. 

  154. 

  155. </ul>
    156. 

  156. <ul class="simple nested-toc-section">skip
    157. 

  157.   <li><a class="reference" href="#skip%2CopenArray%5Bchar%5D%2CopenArray%5Bchar%5D" title="skip(s, token: openArray[char]): int">skip(s, token: openArray[char]): int</a></li>
    158. 

  158. <li><a class="reference" href="#skip%2Cstring%2Cstring%2Cint" title="skip(s, token: string; start = 0): int">skip(s, token: string; start = 0): int</a></li>
    159. 

  159. 

  160. </ul>
    161. 

  161. <ul class="simple nested-toc-section">skipIgnoreCase
    162. 

  162.   <li><a class="reference" href="#skipIgnoreCase%2CopenArray%5Bchar%5D%2CopenArray%5Bchar%5D" title="skipIgnoreCase(s, token: openArray[char]): int">skipIgnoreCase(s, token: openArray[char]): int</a></li>
    163. 

  163. <li><a class="reference" href="#skipIgnoreCase%2Cstring%2Cstring%2Cint" title="skipIgnoreCase(s, token: string; start = 0): int">skipIgnoreCase(s, token: string; start = 0): int</a></li>
    164. 

  164. 

  165. </ul>
    166. 

  166. <ul class="simple nested-toc-section">skipUntil
    167. 

  167.   <li><a class="reference" href="#skipUntil%2CopenArray%5Bchar%5D%2Cchar" title="skipUntil(s: openArray[char]; until: char): int">skipUntil(s: openArray[char]; until: char): int</a></li>
    168. 

  168. <li><a class="reference" href="#skipUntil%2CopenArray%5Bchar%5D%2Cset%5Bchar%5D" title="skipUntil(s: openArray[char]; until: set[char]): int">skipUntil(s: openArray[char]; until: set[char]): int</a></li>
    169. 

  169. <li><a class="reference" href="#skipUntil%2Cstring%2Cchar%2Cint" title="skipUntil(s: string; until: char; start = 0): int">skipUntil(s: string; until: char; start = 0): int</a></li>
    170. 

  170. <li><a class="reference" href="#skipUntil%2Cstring%2Cset%5Bchar%5D%2Cint" title="skipUntil(s: string; until: set[char]; start = 0): int">skipUntil(s: string; until: set[char]; start = 0): int</a></li>
    171. 

  171. 

  172. </ul>
    173. 

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

  174.   <li><a class="reference" href="#skipWhile%2CopenArray%5Bchar%5D%2Cset%5Bchar%5D" title="skipWhile(s: openArray[char]; toSkip: set[char]): int">skipWhile(s: openArray[char]; toSkip: set[char]): int</a></li>
    175. 

  175. <li><a class="reference" href="#skipWhile%2Cstring%2Cset%5Bchar%5D%2Cint" title="skipWhile(s: string; toSkip: set[char]; start = 0): int">skipWhile(s: string; toSkip: set[char]; start = 0): int</a></li>
    176. 

  176. 

  177. </ul>
    178. 

  178. <ul class="simple nested-toc-section">skipWhitespace
    179. 

  179.   <li><a class="reference" href="#skipWhitespace%2CopenArray%5Bchar%5D" title="skipWhitespace(s: openArray[char]): int">skipWhitespace(s: openArray[char]): int</a></li>
    180. 

  180. <li><a class="reference" href="#skipWhitespace%2Cstring%2Cint" title="skipWhitespace(s: string; start = 0): int">skipWhitespace(s: string; start = 0): int</a></li>
    181. 

  181. 

  182. </ul>
    183. 

  183. 

  184.     </ul>
    185. 

  185.   </details>
    186. 

  186. </li>
    187. 

  187. <li>
    188. 

  188.   <details open>
    189. 

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

  190.     <ul class="simple simple-toc-section">
    191. 

  191.       <ul class="simple nested-toc-section">interpolatedFragments
    192. 

  192.   <li><a class="reference" href="#interpolatedFragments.i%2CopenArray%5Bchar%5D" title="interpolatedFragments(s: openArray[char]): tuple[kind: InterpolatedKind,
    193. 

  193.     value: string]">interpolatedFragments(s: openArray[char]): tuple[kind: InterpolatedKind,
    194. 

  194.     value: string]</a></li>
    195. 

  195. <li><a class="reference" href="#interpolatedFragments.i%2Cstring" title="interpolatedFragments(s: string): tuple[kind: InterpolatedKind, value: string]">interpolatedFragments(s: string): tuple[kind: InterpolatedKind, value: string]</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. 

  199.     </ul>
    200. 

  200.   </details>
    201. 

  201. </li>
    202. 

  202. 

  203. </ul>
    204. 

  204. 

  205.   </div>
    206. 

  206.   <div class="nine columns" id="content">
    207. 

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

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

  209. 

  210.     <div id="tocRoot"></div>
    211. 

  211.     
    212. 

  212.     <p class="module-desc"><p>This module contains helpers for parsing tokens, numbers, integers, floats, identifiers, etc.</p>
    213. 

  213. <p>To unpack raw bytes look at the <a class="reference external" href="streams.html">streams</a> module.</p>
    214. 

  214. <p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">logs</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;2019-01-10: OK_&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2019-01-11: FAIL_&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2019-01: aaaa&quot;</span><span class="Punctuation">]</span>
    215. 

  215. <span class="Keyword">var</span> <span class="Identifier">outp</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
    216. 

  216. 

  217. <span class="Keyword">for</span> <span class="Identifier">log</span> <span class="Keyword">in</span> <span class="Identifier">logs</span><span class="Punctuation">:</span>
    218. 

  218.   <span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    219. 

  219.   <span class="Keyword">if</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="Identifier">log</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="CharLit">':'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">10</span><span class="Punctuation">:</span> <span class="Comment"># YYYY-MM-DD == 10</span>
    220. 

  220.     <span class="Identifier">outp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">res</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot; - &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="Identifier">log</span><span class="Punctuation">,</span> <span class="CharLit">' '</span><span class="Punctuation">,</span> <span class="CharLit">'_'</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    221. 

  221. <span class="Identifier">doAssert</span> <span class="Identifier">outp</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;2019-01-10 - OK&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2019-01-11 - FAIL&quot;</span><span class="Punctuation">]</span></pre></p>
    222. 

  222. <p><pre class="listing"><span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">strutils</span> <span class="Keyword">import</span> <span class="Identifier">Digits</span><span class="Punctuation">,</span> <span class="Identifier">parseInt</span>
    223. 

  223. 

  224. <span class="Keyword">let</span>
    225. 

  225.   <span class="Identifier">input1</span> <span class="Operator">=</span> <span class="StringLit">&quot;2019 school start&quot;</span>
    226. 

  226.   <span class="Identifier">input2</span> <span class="Operator">=</span> <span class="StringLit">&quot;3 years back&quot;</span>
    227. 

  227.   <span class="Identifier">startYear</span> <span class="Operator">=</span> <span class="Identifier">input1</span><span class="Punctuation">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="Identifier">input1</span><span class="Punctuation">,</span> <span class="Identifier">Digits</span><span class="Punctuation">)</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Comment"># 2019</span>
    228. 

  228.   <span class="Identifier">yearsBack</span> <span class="Operator">=</span> <span class="Identifier">input2</span><span class="Punctuation">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="Identifier">input2</span><span class="Punctuation">,</span> <span class="Identifier">Digits</span><span class="Punctuation">)</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Comment"># 3</span>
    229. 

  229.   <span class="Identifier">examYear</span> <span class="Operator">=</span> <span class="Identifier">parseInt</span><span class="Punctuation">(</span><span class="Identifier">startYear</span><span class="Punctuation">)</span> <span class="Operator">+</span> <span class="Identifier">parseInt</span><span class="Punctuation">(</span><span class="Identifier">yearsBack</span><span class="Punctuation">)</span>
    230. 

  230. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;Examination is in &quot;</span> <span class="Operator">&amp;</span> <span class="Operator">$</span><span class="Identifier">examYear</span> <span class="Operator">==</span> <span class="StringLit">&quot;Examination is in 2022&quot;</span></pre></p>
    231. 

  231. <p><strong>See also:</strong></p>
    232. 

  232. <ul class="simple"><li><a class="reference external" href="strutils.html">strutils module</a> for combined and identical parsing proc's</li>
    233. 

  233. <li><a class="reference external" href="json.html">json module</a> for a JSON parser</li>
    234. 

  234. <li><a class="reference external" href="parsecfg.html">parsecfg module</a> for a configuration file parser</li>
    235. 

  235. <li><a class="reference external" href="parsecsv.html">parsecsv module</a> for a simple CSV (comma separated value) parser</li>
    236. 

  236. <li><a class="reference external" href="parseopt.html">parseopt module</a> for a command line parser</li>
    237. 

  237. <li><a class="reference external" href="parsexml.html">parsexml module</a> for a XML / HTML parser</li>
    238. 

  238. <li><a class="reference external" href="lib.html#pure-libraries-parsers">other parsers</a> for other parsers</li>
    239. 

  239. </ul>
    240. 

  240. </p>
    241. 

  241.     <div class="section" id="7">
    242. 

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

  243.   <dl class="item">
    244. 

  244.     <div id="InterpolatedKind">
    245. 

  245.   <dt><pre><a href="parseutils.html#InterpolatedKind"><span class="Identifier">InterpolatedKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    246. 

  246.   <span class="Identifier">ikStr</span><span class="Other">,</span>                    <span class="Comment">## ``str`` part of the interpolated string</span>
    247. 

  247.   <span class="Identifier">ikDollar</span><span class="Other">,</span>                 <span class="Comment">## escaped ``$`` part of the interpolated string</span>
    248. 

  248.   <span class="Identifier">ikVar</span><span class="Other">,</span>                    <span class="Comment">## ``var`` part of the interpolated string</span>
    249. 

  249.   <span class="Identifier">ikExpr</span>                     <span class="Comment">## ``expr`` part of the interpolated string</span></pre></dt>
    250. 

  250.   <dd>
    251. 

  251.     
    252. 

  252.     Describes for <tt class="docutils literal"><span class="pre"><span class="Identifier">interpolatedFragments</span></span></tt> which part of the interpolated string is yielded; for example in &quot;str$$$var${expr}&quot;
    253. 

  253.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L676" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    254. 

  254. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L676" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    255. 

  255. 

  256.   </dd>
    257. 

  257. </div>
    258. 

  258. 

  259.   </dl>
    260. 

  260. </div>
    261. 

  261. <div class="section" id="12">
    262. 

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

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

  264.     <div id="captureBetween-procs-all">
    265. 

  265.   <div id="captureBetween,openArray[char],char,char">
    266. 

  266.   <dt><pre><span class="Keyword">proc</span> <a href="#captureBetween%2CopenArray%5Bchar%5D%2Cchar%2Cchar"><span class="Identifier">captureBetween</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">;</span> <span class="Identifier">second</span> <span class="Other">=</span> <span class="CharLit">'\x00'</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    267. 

  267.     <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>
    268. 

  268.   <dd>
    269. 

  269.     
    270. 

  270.     Finds the first occurrence of <tt class="docutils literal"><span class="pre">first</span></tt>, then returns everything from there up to <tt class="docutils literal"><span class="pre">second</span></tt> (if <tt class="docutils literal"><span class="pre">second</span></tt> is '0', then <tt class="docutils literal"><span class="pre">first</span></tt> is used).
    271. 

  271. <p><strong class="examples_text">Example:</strong></p>
    272. 

  272. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'e'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;llo World&quot;</span>
    273. 

  273. <span class="Identifier">doAssert</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'e'</span><span class="Punctuation">,</span> <span class="CharLit">'r'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;llo Wo&quot;</span>
    274. 

  274. <span class="Identifier">doAssert</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Operator">.</span><span class="Identifier">toOpenArray</span><span class="Punctuation">(</span><span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Hello World&quot;</span><span class="Operator">.</span><span class="Identifier">high</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="CharLit">'l'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;d&quot;</span></pre>
    275. 

  275.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L418" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    276. 

  276. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L418" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    277. 

  277. 

  278.   </dd>
    279. 

  279. </div>
    280. 

  280. <div id="captureBetween,string,char,char,int">
    281. 

  281.   <dt><pre><span class="Keyword">proc</span> <a href="#captureBetween%2Cstring%2Cchar%2Cchar%2Cint"><span class="Identifier">captureBetween</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">first</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">;</span> <span class="Identifier">second</span> <span class="Other">=</span> <span class="CharLit">'\x00'</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#string"><span class="Identifier">string</span></a> {.
    282. 

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

  283.   <dd>
    284. 

  284.     
    285. 

  285.     Finds the first occurrence of <tt class="docutils literal"><span class="pre">first</span></tt>, then returns everything from there up to <tt class="docutils literal"><span class="pre">second</span></tt> (if <tt class="docutils literal"><span class="pre">second</span></tt> is '0', then <tt class="docutils literal"><span class="pre">first</span></tt> is used).
    286. 

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

  287. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'e'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;llo World&quot;</span>
    288. 

  288. <span class="Identifier">doAssert</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'e'</span><span class="Punctuation">,</span> <span class="CharLit">'r'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;llo Wo&quot;</span>
    289. 

  289. <span class="Identifier">doAssert</span> <span class="Identifier">captureBetween</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'l'</span><span class="Punctuation">,</span> <span class="Identifier">start</span> <span class="Operator">=</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;d&quot;</span></pre>
    290. 

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

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

  292. 

  293.   </dd>
    294. 

  294. </div>
    295. 

  295. 

  296. </div>
    297. 

  297. <div id="parseBiggestFloat-procs-all">
    298. 

  298.   <div id="parseBiggestFloat,openArray[char],BiggestFloat">
    299. 

  299.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBiggestFloat%2CopenArray%5Bchar%5D%2CBiggestFloat"><span class="Identifier">parseBiggestFloat</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ctypes.html#BiggestFloat"><span class="Identifier">BiggestFloat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    300. 

  300.     <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;ParseBiggestFloat&quot;</span><span class="Other">,</span> <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;nimParseBiggestFloat&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
    301. 

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

  302.   <dd>
    303. 

  303.     
    304. 

  304.     Parses a float and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if a parsing error occurred.
    305. 

  305.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L586" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    306. 

  306. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L586" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    307. 

  307. 

  308.   </dd>
    309. 

  309. </div>
    310. 

  310. <div id="parseBiggestFloat,string,BiggestFloat,int">
    311. 

  311.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBiggestFloat%2Cstring%2CBiggestFloat%2Cint"><span class="Identifier">parseBiggestFloat</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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ctypes.html#BiggestFloat"><span class="Identifier">BiggestFloat</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> {.
    312. 

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

  313.   <dd>
    314. 

  314.     
    315. 

  315.     Parses a float starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if a parsing error occurred.
    316. 

  316.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L1067" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    317. 

  317. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L1067" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    318. 

  318. 

  319.   </dd>
    320. 

  320. </div>
    321. 

  321. 

  322. </div>
    323. 

  323. <div id="parseBiggestInt-procs-all">
    324. 

  324.   <div id="parseBiggestInt,openArray[char],BiggestInt">
    325. 

  325.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBiggestInt%2CopenArray%5Bchar%5D%2CBiggestInt"><span class="Identifier">parseBiggestInt</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    326. 

  326.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npuParseBiggestInt&quot;</span><span class="Other">,</span> </span><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    327. 

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

  328.   <dd>
    329. 

  329.     
    330. 

  330.     Parses an integer and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if there is no integer. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    331. 

  331. <p><strong class="examples_text">Example:</strong></p>
    332. 

  332. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">BiggestInt</span>
    333. 

  333. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;9223372036854775807&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">19</span>
    334. 

  334. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">9223372036854775807</span>
    335. 

  335. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;-2024_05_09&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    336. 

  336. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">20240509</span></pre>
    337. 

  337.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L466" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    338. 

  338. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L466" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    339. 

  339. 

  340.   </dd>
    341. 

  341. </div>
    342. 

  342. <div id="parseBiggestInt,string,BiggestInt,int">
    343. 

  343.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBiggestInt%2Cstring%2CBiggestInt%2Cint"><span class="Identifier">parseBiggestInt</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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</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> {.
    344. 

  344.     <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    345. 

  345.   <dd>
    346. 

  346.     
    347. 

  347.     Parses an integer starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if there is no integer. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    348. 

  348. <p><strong class="examples_text">Example:</strong></p>
    349. 

  349. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">BiggestInt</span>
    350. 

  350. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;9223372036854775807&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">19</span>
    351. 

  351. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">9223372036854775807</span>
    352. 

  352. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;-2024_05_09&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    353. 

  353. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">20240509</span>
    354. 

  354. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;-2024_05_02&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    355. 

  355. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">502</span></pre>
    356. 

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

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

  358. 

  359.   </dd>
    360. 

  360. </div>
    361. 

  361. 

  362. </div>
    363. 

  363. <div id="parseBiggestUInt-procs-all">
    364. 

  364.   <div id="parseBiggestUInt,openArray[char],BiggestUInt">
    365. 

  365.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBiggestUInt%2CopenArray%5Bchar%5D%2CBiggestUInt"><span class="Identifier">parseBiggestUInt</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ctypes.html#BiggestUInt"><span class="Identifier">BiggestUInt</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    366. 

  366.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npuParseBiggestUInt&quot;</span><span class="Other">,</span> </span><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><span class="Other">]</span><span class="Other">,</span>
    367. 

  367.     <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>
    368. 

  368.   <dd>
    369. 

  369.     
    370. 

  370.     Parses an unsigned integer and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    371. 

  371. <p><strong class="examples_text">Example:</strong></p>
    372. 

  372. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">BiggestUInt</span>
    373. 

  373. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;12&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    374. 

  374. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">12</span>
    375. 

  375. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;1111111111111111111&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">19</span>
    376. 

  376. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">1111111111111111111'</span><span class="Identifier">u64</span></pre>
    377. 

  377.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L549" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    378. 

  378. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L549" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    379. 

  379. 

  380.   </dd>
    381. 

  381. </div>
    382. 

  382. <div id="parseBiggestUInt,string,BiggestUInt,int">
    383. 

  383.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBiggestUInt%2Cstring%2CBiggestUInt%2Cint"><span class="Identifier">parseBiggestUInt</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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ctypes.html#BiggestUInt"><span class="Identifier">BiggestUInt</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> {.
    384. 

  384.     <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    385. 

  385.   <dd>
    386. 

  386.     
    387. 

  387.     Parses an unsigned integer starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    388. 

  388. <p><strong class="examples_text">Example:</strong></p>
    389. 

  389. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">BiggestUInt</span>
    390. 

  390. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;12&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    391. 

  391. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">12</span>
    392. 

  392. <span class="Identifier">doAssert</span> <span class="Identifier">parseBiggestUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;1111111111111111111&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">19</span>
    393. 

  393. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">1111111111111111111'</span><span class="Identifier">u64</span></pre>
    394. 

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

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

  396. 

  397.   </dd>
    398. 

  398. </div>
    399. 

  399. 

  400. </div>
    401. 

  401. <div id="parseBin-procs-all">
    402. 

  402.   <div id="parseBin,openArray[char],T,int">
    403. 

  403.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBin%2CopenArray%5Bchar%5D%2CT%2Cint"><span class="Identifier">parseBin</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">maxLen</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> {.
    404. 

  404.     <span class="Identifier">noSideEffect</span>.}</pre></dt>
    405. 

  405.   <dd>
    406. 

  406.     
    407. 

  407.     <p>Parses a binary number and stores its value in <tt class="docutils literal"><span class="pre">number</span></tt>.</p>
    408. 

  408. <p>Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre">number</span></tt> is not changed.</p>
    409. 

  409. <p>If <tt class="docutils literal"><span class="pre">maxLen == 0</span></tt>, the parsing continues until the first non-bin character or to the end of the string. Otherwise, no more than <tt class="docutils literal"><span class="pre">maxLen</span></tt> characters are parsed starting from the <tt class="docutils literal"><span class="pre">start</span></tt> position.</p>
    410. 

  410. <p>It does not check for overflow. If the value represented by the string is too big to fit into <tt class="docutils literal"><span class="pre">number</span></tt>, only the value of last fitting characters will be stored in <tt class="docutils literal"><span class="pre">number</span></tt> without producing an error.</p>
    411. 

  411. 

  412. <p><strong class="examples_text">Example:</strong></p>
    413. 

  413. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">num</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    414. 

  414. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">29</span>
    415. 

  415. <span class="Identifier">doAssert</span> <span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">5138925</span>
    416. 

  416. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;3&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    417. 

  417. <span class="Keyword">var</span> <span class="Identifier">num8</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    418. 

  418. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0b_0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">32</span>
    419. 

  419. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="BinNumber">0b1110_1101'i8</span>
    420. 

  420. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0b_0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">9</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">9</span>
    421. 

  421. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="BinNumber">0b0100_1110'i8</span>
    422. 

  422. <span class="Keyword">var</span> <span class="Identifier">num8u</span><span class="Punctuation">:</span> <span class="Identifier">uint8</span>
    423. 

  423. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0b_0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8u</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">32</span>
    424. 

  424. <span class="Identifier">doAssert</span> <span class="Identifier">num8u</span> <span class="Operator">==</span> <span class="DecNumber">237</span>
    425. 

  425. <span class="Keyword">var</span> <span class="Identifier">num64</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>
    426. 

  426. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0100111001101001111011010100111001101001&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num64</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">40</span>
    427. 

  427. <span class="Identifier">doAssert</span> <span class="Identifier">num64</span> <span class="Operator">==</span> <span class="DecNumber">336784608873</span></pre>
    428. 

  428.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L63" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    429. 

  429. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L63" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    430. 

  430. 

  431.   </dd>
    432. 

  432. </div>
    433. 

  433. <div id="parseBin,string,T,int,int">
    434. 

  434.   <dt><pre><span class="Keyword">proc</span> <a href="#parseBin%2Cstring%2CT%2Cint%2Cint"><span class="Identifier">parseBin</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</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="Identifier">maxLen</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> {.
    435. 

  435.     <span class="Identifier">noSideEffect</span>.}</pre></dt>
    436. 

  436.   <dd>
    437. 

  437.     
    438. 

  438.     <p>Parses a binary number and stores its value in <tt class="docutils literal"><span class="pre">number</span></tt>.</p>
    439. 

  439. <p>Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre">number</span></tt> is not changed.</p>
    440. 

  440. <p>If <tt class="docutils literal"><span class="pre">maxLen == 0</span></tt>, the parsing continues until the first non-bin character or to the end of the string. Otherwise, no more than <tt class="docutils literal"><span class="pre">maxLen</span></tt> characters are parsed starting from the <tt class="docutils literal"><span class="pre">start</span></tt> position.</p>
    441. 

  441. <p>It does not check for overflow. If the value represented by the string is too big to fit into <tt class="docutils literal"><span class="pre">number</span></tt>, only the value of last fitting characters will be stored in <tt class="docutils literal"><span class="pre">number</span></tt> without producing an error.</p>
    442. 

  442. 

  443. <p><strong class="examples_text">Example:</strong></p>
    444. 

  444. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">num</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    445. 

  445. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">29</span>
    446. 

  446. <span class="Identifier">doAssert</span> <span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">5138925</span>
    447. 

  447. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;3&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    448. 

  448. <span class="Keyword">var</span> <span class="Identifier">num8</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    449. 

  449. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0b_0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">32</span>
    450. 

  450. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="BinNumber">0b1110_1101'i8</span>
    451. 

  451. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0b_0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">9</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">9</span>
    452. 

  452. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="BinNumber">0b0100_1110'i8</span>
    453. 

  453. <span class="Keyword">var</span> <span class="Identifier">num8u</span><span class="Punctuation">:</span> <span class="Identifier">uint8</span>
    454. 

  454. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0b_0100_1110_0110_1001_1110_1101&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8u</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">32</span>
    455. 

  455. <span class="Identifier">doAssert</span> <span class="Identifier">num8u</span> <span class="Operator">==</span> <span class="DecNumber">237</span>
    456. 

  456. <span class="Keyword">var</span> <span class="Identifier">num64</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>
    457. 

  457. <span class="Identifier">doAssert</span> <span class="Identifier">parseBin</span><span class="Punctuation">(</span><span class="StringLit">&quot;0100111001101001111011010100111001101001&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num64</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">40</span>
    458. 

  458. <span class="Identifier">doAssert</span> <span class="Identifier">num64</span> <span class="Operator">==</span> <span class="DecNumber">336784608873</span></pre>
    459. 

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

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

  461. 

  462.   </dd>
    463. 

  463. </div>
    464. 

  464. 

  465. </div>
    466. 

  466. <div id="parseChar-procs-all">
    467. 

  467.   <div id="parseChar,openArray[char],char">
    468. 

  468.   <dt><pre><span class="Keyword">proc</span> <a href="#parseChar%2CopenArray%5Bchar%5D%2Cchar"><span class="Identifier">parseChar</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="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>
    469. 

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

  470.   <dd>
    471. 

  471.     
    472. 

  472.     Parses a single character, stores it in <tt class="docutils literal"><span class="pre"><span class="Identifier">c</span></span></tt> and returns 1. In case of error (if start &gt;= s.len) it returns 0 and the value of <tt class="docutils literal"><span class="pre"><span class="Identifier">c</span></span></tt> is unchanged.
    473. 

  473. <p><strong class="examples_text">Example:</strong></p>
    474. 

  474. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">c</span><span class="Punctuation">:</span> <span class="Identifier">char</span>
    475. 

  475. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;nim&quot;</span><span class="Operator">.</span><span class="Identifier">parseChar</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    476. 

  476. <span class="Identifier">doAssert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="CharLit">'\0'</span>
    477. 

  477. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;nim&quot;</span><span class="Operator">.</span><span class="Identifier">parseChar</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    478. 

  478. <span class="Identifier">doAssert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="CharLit">'n'</span></pre>
    479. 

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

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

  481. 

  482.   </dd>
    483. 

  483. </div>
    484. 

  484. <div id="parseChar,string,char,int">
    485. 

  485.   <dt><pre><span class="Keyword">proc</span> <a href="#parseChar%2Cstring%2Cchar%2Cint"><span class="Identifier">parseChar</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">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">;</span> <span class="Identifier">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><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>
    486. 

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

  487.   <dd>
    488. 

  488.     
    489. 

  489.     Parses a single character, stores it in <tt class="docutils literal"><span class="pre"><span class="Identifier">c</span></span></tt> and returns 1. In case of error (if start &gt;= s.len) it returns 0 and the value of <tt class="docutils literal"><span class="pre"><span class="Identifier">c</span></span></tt> is unchanged.
    490. 

  490. <p><strong class="examples_text">Example:</strong></p>
    491. 

  491. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">c</span><span class="Punctuation">:</span> <span class="Identifier">char</span>
    492. 

  492. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;nim&quot;</span><span class="Operator">.</span><span class="Identifier">parseChar</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    493. 

  493. <span class="Identifier">doAssert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="CharLit">'\0'</span>
    494. 

  494. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;nim&quot;</span><span class="Operator">.</span><span class="Identifier">parseChar</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    495. 

  495. <span class="Identifier">doAssert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="CharLit">'n'</span></pre>
    496. 

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

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

  498. 

  499.   </dd>
    500. 

  500. </div>
    501. 

  501. 

  502. </div>
    503. 

  503. <div id="parseFloat-procs-all">
    504. 

  504.   <div id="parseFloat,openArray[char],float">
    505. 

  505.   <dt><pre><span class="Keyword">proc</span> <a href="#parseFloat%2CopenArray%5Bchar%5D%2Cfloat"><span class="Identifier">parseFloat</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    506. 

  506.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npuParseFloat&quot;</span><span class="Other">,</span> </span><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    507. 

  507.   <dd>
    508. 

  508.     
    509. 

  509.     Parses a float and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if there occurred a parsing error.
    510. 

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

  511. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">float</span>
    512. 

  512. <span class="Identifier">doAssert</span> <span class="Identifier">parseFloat</span><span class="Punctuation">(</span><span class="StringLit">&quot;32&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    513. 

  513. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="FloatNumber">32.0</span>
    514. 

  514. <span class="Identifier">doAssert</span> <span class="Identifier">parseFloat</span><span class="Punctuation">(</span><span class="StringLit">&quot;32.57&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    515. 

  515. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="FloatNumber">32.57</span>
    516. 

  516. <span class="Identifier">doAssert</span> <span class="Identifier">parseFloat</span><span class="Punctuation">(</span><span class="StringLit">&quot;32.57&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    517. 

  517. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="FloatNumber">57.00</span></pre>
    518. 

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

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

  520. 

  521.   </dd>
    522. 

  522. </div>
    523. 

  523. <div id="parseFloat,string,float,int">
    524. 

  524.   <dt><pre><span class="Keyword">proc</span> <a href="#parseFloat%2Cstring%2Cfloat%2Cint"><span class="Identifier">parseFloat</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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#float"><span class="Identifier">float</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">noSideEffect</span><span class="Other">,</span>
    525. 

  525.     <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>
    526. 

  526.   <dd>
    527. 

  527.     
    528. 

  528.     Parses a float starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if there occurred a parsing error.
    529. 

  529. <p><strong class="examples_text">Example:</strong></p>
    530. 

  530. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">float</span>
    531. 

  531. <span class="Identifier">doAssert</span> <span class="Identifier">parseFloat</span><span class="Punctuation">(</span><span class="StringLit">&quot;32&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    532. 

  532. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="FloatNumber">32.0</span>
    533. 

  533. <span class="Identifier">doAssert</span> <span class="Identifier">parseFloat</span><span class="Punctuation">(</span><span class="StringLit">&quot;32.57&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    534. 

  534. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="FloatNumber">32.57</span>
    535. 

  535. <span class="Identifier">doAssert</span> <span class="Identifier">parseFloat</span><span class="Punctuation">(</span><span class="StringLit">&quot;32.57&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    536. 

  536. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="FloatNumber">57.00</span></pre>
    537. 

  537.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L1073" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    538. 

  538. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L1073" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    539. 

  539. 

  540.   </dd>
    541. 

  541. </div>
    542. 

  542. 

  543. </div>
    544. 

  544. <div id="parseHex-procs-all">
    545. 

  545.   <div id="parseHex,openArray[char],T,int">
    546. 

  546.   <dt><pre><span class="Keyword">proc</span> <a href="#parseHex%2CopenArray%5Bchar%5D%2CT%2Cint"><span class="Identifier">parseHex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">maxLen</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> {.
    547. 

  547.     <span class="Identifier">noSideEffect</span>.}</pre></dt>
    548. 

  548.   <dd>
    549. 

  549.     
    550. 

  550.     <p>Parses a hexadecimal number and stores its value in <tt class="docutils literal"><span class="pre">number</span></tt>.</p>
    551. 

  551. <p>Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre">number</span></tt> is not changed.</p>
    552. 

  552. <p>If <tt class="docutils literal"><span class="pre">maxLen == 0</span></tt>, the parsing continues until the first non-hex character or to the end of the string. Otherwise, no more than <tt class="docutils literal"><span class="pre">maxLen</span></tt> characters are parsed starting from the <tt class="docutils literal"><span class="pre">start</span></tt> position.</p>
    553. 

  553. <p>It does not check for overflow. If the value represented by the string is too big to fit into <tt class="docutils literal"><span class="pre">number</span></tt>, only the value of last fitting characters will be stored in <tt class="docutils literal"><span class="pre">number</span></tt> without producing an error.</p>
    554. 

  554. 

  555. <p><strong class="examples_text">Example:</strong></p>
    556. 

  556. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">num</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    557. 

  557. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">8</span>
    558. 

  558. <span class="Identifier">doAssert</span> <span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">5138925</span>
    559. 

  559. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;X&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    560. 

  560. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;#ABC&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    561. 

  561. <span class="Keyword">var</span> <span class="Identifier">num8</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    562. 

  562. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;0x_4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    563. 

  563. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="HexNumber">0xED'i8</span>
    564. 

  564. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;0x_4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    565. 

  565. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="HexNumber">0x4E'i8</span>
    566. 

  566. <span class="Keyword">var</span> <span class="Identifier">num8u</span><span class="Punctuation">:</span> <span class="Identifier">uint8</span>
    567. 

  567. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;0x_4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8u</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    568. 

  568. <span class="Identifier">doAssert</span> <span class="Identifier">num8u</span> <span class="Operator">==</span> <span class="DecNumber">237</span>
    569. 

  569. <span class="Keyword">var</span> <span class="Identifier">num64</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>
    570. 

  570. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;4E69ED4E69ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num64</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">12</span>
    571. 

  571. <span class="Identifier">doAssert</span> <span class="Identifier">num64</span> <span class="Operator">==</span> <span class="DecNumber">86216859871725</span></pre>
    572. 

  572.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L159" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    573. 

  573. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L159" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    574. 

  574. 

  575.   </dd>
    576. 

  576. </div>
    577. 

  577. <div id="parseHex,string,T,int,int">
    578. 

  578.   <dt><pre><span class="Keyword">proc</span> <a href="#parseHex%2Cstring%2CT%2Cint%2Cint"><span class="Identifier">parseHex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</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="Identifier">maxLen</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> {.
    579. 

  579.     <span class="Identifier">noSideEffect</span>.}</pre></dt>
    580. 

  580.   <dd>
    581. 

  581.     
    582. 

  582.     <p>Parses a hexadecimal number and stores its value in <tt class="docutils literal"><span class="pre">number</span></tt>.</p>
    583. 

  583. <p>Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre">number</span></tt> is not changed.</p>
    584. 

  584. <p>If <tt class="docutils literal"><span class="pre">maxLen == 0</span></tt>, the parsing continues until the first non-hex character or to the end of the string. Otherwise, no more than <tt class="docutils literal"><span class="pre">maxLen</span></tt> characters are parsed starting from the <tt class="docutils literal"><span class="pre">start</span></tt> position.</p>
    585. 

  585. <p>It does not check for overflow. If the value represented by the string is too big to fit into <tt class="docutils literal"><span class="pre">number</span></tt>, only the value of last fitting characters will be stored in <tt class="docutils literal"><span class="pre">number</span></tt> without producing an error.</p>
    586. 

  586. 

  587. <p><strong class="examples_text">Example:</strong></p>
    588. 

  588. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">num</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    589. 

  589. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">8</span>
    590. 

  590. <span class="Identifier">doAssert</span> <span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">5138925</span>
    591. 

  591. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;X&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    592. 

  592. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;#ABC&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    593. 

  593. <span class="Keyword">var</span> <span class="Identifier">num8</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    594. 

  594. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;0x_4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    595. 

  595. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="HexNumber">0xED'i8</span>
    596. 

  596. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;0x_4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    597. 

  597. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="HexNumber">0x4E'i8</span>
    598. 

  598. <span class="Keyword">var</span> <span class="Identifier">num8u</span><span class="Punctuation">:</span> <span class="Identifier">uint8</span>
    599. 

  599. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;0x_4E_69_ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8u</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    600. 

  600. <span class="Identifier">doAssert</span> <span class="Identifier">num8u</span> <span class="Operator">==</span> <span class="DecNumber">237</span>
    601. 

  601. <span class="Keyword">var</span> <span class="Identifier">num64</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>
    602. 

  602. <span class="Identifier">doAssert</span> <span class="Identifier">parseHex</span><span class="Punctuation">(</span><span class="StringLit">&quot;4E69ED4E69ED&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num64</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">12</span>
    603. 

  603. <span class="Identifier">doAssert</span> <span class="Identifier">num64</span> <span class="Operator">==</span> <span class="DecNumber">86216859871725</span></pre>
    604. 

  604.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L811" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    605. 

  605. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L811" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    606. 

  606. 

  607.   </dd>
    608. 

  608. </div>
    609. 

  609. 

  610. </div>
    611. 

  611. <div id="parseIdent-procs-all">
    612. 

  612.   <div id="parseIdent,openArray[char]">
    613. 

  613.   <dt><pre><span class="Keyword">proc</span> <a href="#parseIdent%2CopenArray%5Bchar%5D"><span class="Identifier">parseIdent</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
    614. 

  614.   <dd>
    615. 

  615.     
    616. 

  616.     Parses an identifier and returns it or an empty string in case of an error.
    617. 

  617. <p><strong class="examples_text">Example:</strong></p>
    618. 

  618. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello&quot;</span>
    619. 

  619. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ello&quot;</span>
    620. 

  620. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
    621. 

  621. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;World&quot;</span></pre>
    622. 

  622.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L235" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    623. 

  623. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L235" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    624. 

  624. 

  625.   </dd>
    626. 

  626. </div>
    627. 

  627. <div id="parseIdent,openArray[char],string">
    628. 

  628.   <dt><pre><span class="Keyword">proc</span> <a href="#parseIdent%2CopenArray%5Bchar%5D%2Cstring"><span class="Identifier">parseIdent</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">ident</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <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>
    629. 

  629.     <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>
    630. 

  630.   <dd>
    631. 

  631.     
    632. 

  632.     Parses an identifier and stores it in <tt class="docutils literal"><span class="pre">ident</span></tt>. Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre"><span class="Identifier">ident</span></span></tt> is not changed.
    633. 

  633. <p><strong class="examples_text">Example:</strong></p>
    634. 

  634. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    635. 

  635. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    636. 

  636. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello&quot;</span>
    637. 

  637. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    638. 

  638. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="StringLit">&quot;ello&quot;</span>
    639. 

  639. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    640. 

  640. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="StringLit">&quot;World&quot;</span></pre>
    641. 

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

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

  643. 

  644.   </dd>
    645. 

  645. </div>
    646. 

  646. <div id="parseIdent,string,string,int">
    647. 

  647.   <dt><pre><span class="Keyword">proc</span> <a href="#parseIdent%2Cstring%2Cstring%2Cint"><span class="Identifier">parseIdent</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">ident</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="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><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>
    648. 

  648.     <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>
    649. 

  649.   <dd>
    650. 

  650.     
    651. 

  651.     Parses an identifier and stores it in <tt class="docutils literal"><span class="pre">ident</span></tt>. Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre"><span class="Identifier">ident</span></span></tt> is not changed.
    652. 

  652. <p><strong class="examples_text">Example:</strong></p>
    653. 

  653. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    654. 

  654. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    655. 

  655. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello&quot;</span>
    656. 

  656. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    657. 

  657. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="StringLit">&quot;ello&quot;</span>
    658. 

  658. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    659. 

  659. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="StringLit">&quot;World&quot;</span></pre>
    660. 

  660.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L844" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    661. 

  661. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L844" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    662. 

  662. 

  663.   </dd>
    664. 

  664. </div>
    665. 

  665. <div id="parseIdent,string,int">
    666. 

  666.   <dt><pre><span class="Keyword">proc</span> <a href="#parseIdent%2Cstring%2Cint"><span class="Identifier">parseIdent</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">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> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    667. 

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

  668.   <dd>
    669. 

  669.     
    670. 

  670.     Parses an identifier and returns it or an empty string in case of an error.
    671. 

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

  672. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello&quot;</span>
    673. 

  673. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ello&quot;</span>
    674. 

  674. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
    675. 

  675. <span class="Identifier">doAssert</span> <span class="Identifier">parseIdent</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;World&quot;</span></pre>
    676. 

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

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

  678. 

  679.   </dd>
    680. 

  680. </div>
    681. 

  681. 

  682. </div>
    683. 

  683. <div id="parseInt-procs-all">
    684. 

  684.   <div id="parseInt,openArray[char],int">
    685. 

  685.   <dt><pre><span class="Keyword">proc</span> <a href="#parseInt%2CopenArray%5Bchar%5D%2Cint"><span class="Identifier">parseInt</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</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">gcsafe</span><span class="Other">,</span>
    686. 

  686.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npuParseInt&quot;</span><span class="Other">,</span> </span><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    687. 

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

  688.   <dd>
    689. 

  689.     
    690. 

  690.     Parses an integer and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if there is no integer. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    691. 

  691. <p><strong class="examples_text">Example:</strong></p>
    692. 

  692. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    693. 

  693. <span class="Identifier">doAssert</span> <span class="Identifier">parseInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;-2024_05_02&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    694. 

  694. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">20240502</span></pre>
    695. 

  695.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L484" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    696. 

  696. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L484" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    697. 

  697. 

  698.   </dd>
    699. 

  699. </div>
    700. 

  700. <div id="parseInt,string,int,int">
    701. 

  701.   <dt><pre><span class="Keyword">proc</span> <a href="#parseInt%2Cstring%2Cint%2Cint"><span class="Identifier">parseInt</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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int"><span class="Identifier">int</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">noSideEffect</span><span class="Other">,</span>
    702. 

  702.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    703. 

  703.   <dd>
    704. 

  704.     
    705. 

  705.     Parses an integer starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. Result is the number of processed chars or 0 if there is no integer. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    706. 

  706. <p><strong class="examples_text">Example:</strong></p>
    707. 

  707. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    708. 

  708. <span class="Identifier">doAssert</span> <span class="Identifier">parseInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;-2024_05_02&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    709. 

  709. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">20240502</span>
    710. 

  710. <span class="Identifier">doAssert</span> <span class="Identifier">parseInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;-2024_05_02&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    711. 

  711. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">502</span></pre>
    712. 

  712.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L1017" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    713. 

  713. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L1017" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    714. 

  714. 

  715.   </dd>
    716. 

  716. </div>
    717. 

  717. 

  718. </div>
    719. 

  719. <div id="parseOct-procs-all">
    720. 

  720.   <div id="parseOct,openArray[char],T,int">
    721. 

  721.   <dt><pre><span class="Keyword">proc</span> <a href="#parseOct%2CopenArray%5Bchar%5D%2CT%2Cint"><span class="Identifier">parseOct</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">maxLen</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> {.
    722. 

  722.     <span class="Identifier">noSideEffect</span>.}</pre></dt>
    723. 

  723.   <dd>
    724. 

  724.     
    725. 

  725.     <p>Parses an octal number and stores its value in <tt class="docutils literal"><span class="pre">number</span></tt>.</p>
    726. 

  726. <p>Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre">number</span></tt> is not changed.</p>
    727. 

  727. <p>If <tt class="docutils literal"><span class="pre">maxLen == 0</span></tt>, the parsing continues until the first non-oct character or to the end of the string. Otherwise, no more than <tt class="docutils literal"><span class="pre">maxLen</span></tt> characters are parsed starting from the <tt class="docutils literal"><span class="pre">start</span></tt> position.</p>
    728. 

  728. <p>It does not check for overflow. If the value represented by the string is too big to fit into <tt class="docutils literal"><span class="pre">number</span></tt>, only the value of last fitting characters will be stored in <tt class="docutils literal"><span class="pre">number</span></tt> without producing an error.</p>
    729. 

  729. 

  730. <p><strong class="examples_text">Example:</strong></p>
    731. 

  731. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">num</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    732. 

  732. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;0o23464755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">10</span>
    733. 

  733. <span class="Identifier">doAssert</span> <span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">5138925</span>
    734. 

  734. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;8&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    735. 

  735. <span class="Keyword">var</span> <span class="Identifier">num8</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    736. 

  736. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;0o_1464_755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    737. 

  737. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">19</span>
    738. 

  738. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;0o_1464_755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    739. 

  739. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="DecNumber">102</span>
    740. 

  740. <span class="Keyword">var</span> <span class="Identifier">num8u</span><span class="Punctuation">:</span> <span class="Identifier">uint8</span>
    741. 

  741. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;1464755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8u</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">7</span>
    742. 

  742. <span class="Identifier">doAssert</span> <span class="Identifier">num8u</span> <span class="Operator">==</span> <span class="DecNumber">237</span>
    743. 

  743. <span class="Keyword">var</span> <span class="Identifier">num64</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>
    744. 

  744. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;2346475523464755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num64</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">16</span>
    745. 

  745. <span class="Identifier">doAssert</span> <span class="Identifier">num64</span> <span class="Operator">==</span> <span class="DecNumber">86216859871725</span></pre>
    746. 

  746.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L111" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    747. 

  747. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L111" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    748. 

  748. 

  749.   </dd>
    750. 

  750. </div>
    751. 

  751. <div id="parseOct,string,T,int,int">
    752. 

  752.   <dt><pre><span class="Keyword">proc</span> <a href="#parseOct%2Cstring%2CT%2Cint%2Cint"><span class="Identifier">parseOct</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</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="Identifier">maxLen</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> {.
    753. 

  753.     <span class="Identifier">noSideEffect</span>.}</pre></dt>
    754. 

  754.   <dd>
    755. 

  755.     
    756. 

  756.     <p>Parses an octal number and stores its value in <tt class="docutils literal"><span class="pre">number</span></tt>.</p>
    757. 

  757. <p>Returns the number of the parsed characters or 0 in case of an error. If error, the value of <tt class="docutils literal"><span class="pre">number</span></tt> is not changed.</p>
    758. 

  758. <p>If <tt class="docutils literal"><span class="pre">maxLen == 0</span></tt>, the parsing continues until the first non-oct character or to the end of the string. Otherwise, no more than <tt class="docutils literal"><span class="pre">maxLen</span></tt> characters are parsed starting from the <tt class="docutils literal"><span class="pre">start</span></tt> position.</p>
    759. 

  759. <p>It does not check for overflow. If the value represented by the string is too big to fit into <tt class="docutils literal"><span class="pre">number</span></tt>, only the value of last fitting characters will be stored in <tt class="docutils literal"><span class="pre">number</span></tt> without producing an error.</p>
    760. 

  760. 

  761. <p><strong class="examples_text">Example:</strong></p>
    762. 

  762. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">num</span><span class="Punctuation">:</span> <span class="Identifier">int</span>
    763. 

  763. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;0o23464755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">10</span>
    764. 

  764. <span class="Identifier">doAssert</span> <span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">5138925</span>
    765. 

  765. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;8&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    766. 

  766. <span class="Keyword">var</span> <span class="Identifier">num8</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    767. 

  767. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;0o_1464_755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span>
    768. 

  768. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">19</span>
    769. 

  769. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;0o_1464_755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    770. 

  770. <span class="Identifier">doAssert</span> <span class="Identifier">num8</span> <span class="Operator">==</span> <span class="DecNumber">102</span>
    771. 

  771. <span class="Keyword">var</span> <span class="Identifier">num8u</span><span class="Punctuation">:</span> <span class="Identifier">uint8</span>
    772. 

  772. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;1464755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num8u</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">7</span>
    773. 

  773. <span class="Identifier">doAssert</span> <span class="Identifier">num8u</span> <span class="Operator">==</span> <span class="DecNumber">237</span>
    774. 

  774. <span class="Keyword">var</span> <span class="Identifier">num64</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>
    775. 

  775. <span class="Identifier">doAssert</span> <span class="Identifier">parseOct</span><span class="Punctuation">(</span><span class="StringLit">&quot;2346475523464755&quot;</span><span class="Punctuation">,</span> <span class="Identifier">num64</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">16</span>
    776. 

  776. <span class="Identifier">doAssert</span> <span class="Identifier">num64</span> <span class="Operator">==</span> <span class="DecNumber">86216859871725</span></pre>
    777. 

  777.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L779" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    778. 

  778. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L779" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    779. 

  779. 

  780.   </dd>
    781. 

  781. </div>
    782. 

  782. 

  783. </div>
    784. 

  784. <div id="parseSaturatedNatural-procs-all">
    785. 

  785.   <div id="parseSaturatedNatural,openArray[char],int">
    786. 

  786.   <dt><pre><span class="Keyword">proc</span> <a href="#parseSaturatedNatural%2CopenArray%5Bchar%5D%2Cint"><span class="Identifier">parseSaturatedNatural</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Keyword">var</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>
    787. 

  787.     <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>
    788. 

  788.   <dd>
    789. 

  789.     
    790. 

  790.     Parses a natural number into <tt class="docutils literal"><span class="pre">b</span></tt>. This cannot raise an overflow error. <tt class="docutils literal"><span class="pre">high(int)</span></tt> is returned for an overflow. The number of processed character is returned. This is usually what you really want to use instead of <span id="parseint_1">parseInt</span>.
    791. 

  791. <p><strong class="examples_text">Example:</strong></p>
    792. 

  792. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
    793. 

  793. <span class="Keyword">discard</span> <span class="Identifier">parseSaturatedNatural</span><span class="Punctuation">(</span><span class="StringLit">&quot;848&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span>
    794. 

  794. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">848</span></pre>
    795. 

  795.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L501" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    796. 

  796. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L501" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    797. 

  797. 

  798.   </dd>
    799. 

  799. </div>
    800. 

  800. <div id="parseSaturatedNatural,string,int,int">
    801. 

  801.   <dt><pre><span class="Keyword">proc</span> <a href="#parseSaturatedNatural%2Cstring%2Cint%2Cint"><span class="Identifier">parseSaturatedNatural</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">b</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int"><span class="Identifier">int</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><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>
    802. 

  802.     <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>
    803. 

  803.   <dd>
    804. 

  804.     
    805. 

  805.     Parses a natural number into <tt class="docutils literal"><span class="pre">b</span></tt>. This cannot raise an overflow error. <tt class="docutils literal"><span class="pre">high(int)</span></tt> is returned for an overflow. The number of processed character is returned. This is usually what you really want to use instead of <span id="parseint_2">parseInt</span>.
    806. 

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

  807. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span> <span class="Operator">=</span> <span class="DecNumber">0</span>
    808. 

  808. <span class="Keyword">discard</span> <span class="Identifier">parseSaturatedNatural</span><span class="Punctuation">(</span><span class="StringLit">&quot;848&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span>
    809. 

  809. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">848</span></pre>
    810. 

  810.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L1030" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    811. 

  811. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L1030" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    812. 

  812. 

  813.   </dd>
    814. 

  814. </div>
    815. 

  815. 

  816. </div>
    817. 

  817. <div id="parseSize-procs-all">
    818. 

  818.   <div id="parseSize,openArray[char],int64">
    819. 

  819.   <dt><pre><span class="Keyword">func</span> <a href="#parseSize%2CopenArray%5Bchar%5D%2Cint64"><span class="Identifier">parseSize</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">;</span> <span class="Identifier">alwaysBin</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    820. 

  820.     <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>
    821. 

  821.   <dd>
    822. 

  822.     
    823. 

  823.     <p>Parse a size qualified by binary or metric units into <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt>.  This format is often called &quot;human readable&quot;.  Result is the number of processed chars or 0 on parse errors and size is rounded to the nearest integer.  Trailing garbage like &quot;/s&quot; in &quot;1k/s&quot; is allowed and detected by <tt class="docutils literal"><span class="pre"><span class="Identifier">result</span> <span class="Operator">&lt;</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt>.</p>
    824. 

  824. <p>To simplify use, following non-rare wild conventions, and since fractional data like milli-bytes is so rare, unit matching is case-insensitive but for the 'i' distinguishing binary-metric from metric (which cannot be 'I').</p>
    825. 

  825. <p>An optional trailing 'B|b' is ignored but processed.  I.e., you must still know if units are bytes | bits or infer this fact via the case of s<sup><strong><a class="reference internal" href="#footnote-1">[1]</a></strong></sup> (if users can even be relied upon to use 'B' for byte and 'b' for bit or have that be s<sup><strong><a class="reference internal" href="#footnote-1">[1]</a></strong></sup>).</p>
    826. 

  826. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">alwaysBin</span><span class="Operator">==</span><span class="Identifier">true</span></span></tt> then scales are always binary-metric, but e.g. &quot;KiB&quot; is still accepted for clarity.  If the value would exceed the range of <tt class="docutils literal"><span class="pre"><span class="Identifier">int64</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> saturates to <tt class="docutils literal"><span class="pre"><span class="Identifier">int64</span><span class="Operator">.</span><span class="Identifier">high</span></span></tt>.  Supported metric prefix chars include k, m, g, t, p, e, z, y (but z &amp; y saturate unless the number is a small fraction).</p>
    827. 

  827. <p><strong>See also:</strong></p>
    828. 

  828. <ul class="simple"><li><a class="reference external" href="https://en.wikipedia.org/wiki/Binary_prefix">https://en.wikipedia.org/wiki/Binary_prefix</a></li>
    829. 

  829. <li><a class="reference external" href="strutils.html">formatSize module</a> for formatting</li>
    830. 

  830. </ul>
    831. 

  831. 

  832. <p><strong class="examples_text">Example:</strong></p>
    833. 

  833. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">int64</span>  <span class="Comment"># caller must still know if 'b' refers to bytes|bits</span>
    834. 

  834. <span class="Identifier">doAssert</span> <span class="Identifier">parseSize</span><span class="Punctuation">(</span><span class="StringLit">&quot;10.5 MB&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">7</span>
    835. 

  835. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">10_500_000</span>  <span class="Comment"># decimal metric Mega prefix</span>
    836. 

  836. <span class="Identifier">doAssert</span> <span class="Identifier">parseSize</span><span class="Punctuation">(</span><span class="StringLit">&quot;64 mib&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    837. 

  837. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">67108864</span>    <span class="Comment"># 64 shl 20</span>
    838. 

  838. <span class="Identifier">doAssert</span> <span class="Identifier">parseSize</span><span class="Punctuation">(</span><span class="StringLit">&quot;1G/h&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="Identifier">true</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment"># '/' stops parse</span>
    839. 

  839. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">1073741824</span>  <span class="Comment"># 1 shl 30, forced binary metric</span></pre>
    840. 

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

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

  842. 

  843.   </dd>
    844. 

  844. </div>
    845. 

  845. 

  846. </div>
    847. 

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

  848.   <div id="parseUInt,openArray[char],uint">
    849. 

  849.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUInt%2CopenArray%5Bchar%5D%2Cuint"><span class="Identifier">parseUInt</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    850. 

  850.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npuParseUInt&quot;</span><span class="Other">,</span> </span><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    851. 

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

  852.   <dd>
    853. 

  853.     
    854. 

  854.     Parses an unsigned integer and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    855. 

  855. <p><strong class="examples_text">Example:</strong></p>
    856. 

  856. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">uint</span>
    857. 

  857. <span class="Identifier">doAssert</span> <span class="Identifier">parseUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;3450&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    858. 

  858. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">3450</span>
    859. 

  859. <span class="Identifier">doAssert</span> <span class="Identifier">parseUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;3450&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    860. 

  860. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">50</span></pre>
    861. 

  861.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L567" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    862. 

  862. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L567" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    863. 

  863. 

  864.   </dd>
    865. 

  865. </div>
    866. 

  866. <div id="parseUInt,string,uint,int">
    867. 

  867.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUInt%2Cstring%2Cuint%2Cint"><span class="Identifier">parseUInt</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">number</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#uint"><span class="Identifier">uint</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">noSideEffect</span><span class="Other">,</span>
    868. 

  868.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a><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>
    869. 

  869.   <dd>
    870. 

  870.     
    871. 

  871.     Parses an unsigned integer starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">start</span></span></tt> and stores the value into <tt class="docutils literal"><span class="pre"><span class="Identifier">number</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised if the parsed integer is out of the valid range.
    872. 

  872. <p><strong class="examples_text">Example:</strong></p>
    873. 

  873. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">uint</span>
    874. 

  874. <span class="Identifier">doAssert</span> <span class="Identifier">parseUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;3450&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    875. 

  875. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">3450</span>
    876. 

  876. <span class="Identifier">doAssert</span> <span class="Identifier">parseUInt</span><span class="Punctuation">(</span><span class="StringLit">&quot;3450&quot;</span><span class="Punctuation">,</span> <span class="Identifier">res</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    877. 

  877. <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="DecNumber">50</span></pre>
    878. 

  878.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L1055" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    879. 

  879. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L1055" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    880. 

  880. 

  881.   </dd>
    882. 

  882. </div>
    883. 

  883. 

  884. </div>
    885. 

  885. <div id="parseUntil-procs-all">
    886. 

  886.   <div id="parseUntil,openArray[char],string,char">
    887. 

  887.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUntil%2CopenArray%5Bchar%5D%2Cstring%2Cchar"><span class="Identifier">parseUntil</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    888. 

  888.     <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>
    889. 

  889.   <dd>
    890. 

  890.     
    891. 

  891.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of any character that is not the <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt> character.
    892. 

  892. <p><strong class="examples_text">Example:</strong></p>
    893. 

  893. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    894. 

  894. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="CharLit">'W'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    895. 

  895. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello &quot;</span>
    896. 

  896. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    897. 

  897. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hell&quot;</span>
    898. 

  898. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    899. 

  899. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;ll&quot;</span></pre>
    900. 

  900.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    901. 

  901. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    902. 

  902. 

  903.   </dd>
    904. 

  904. </div>
    905. 

  905. <div id="parseUntil,openArray[char],string,set[char]">
    906. 

  906.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUntil%2CopenArray%5Bchar%5D%2Cstring%2Cset%5Bchar%5D"><span class="Identifier">parseUntil</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    907. 

  907.     <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>
    908. 

  908.   <dd>
    909. 

  909.     
    910. 

  910.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of the characters notin <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt>.
    911. 

  911. <p><strong class="examples_text">Example:</strong></p>
    912. 

  912. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    913. 

  913. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}) == 4</span>
    914. 

  914. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hell&quot;</span>
    915. 

  915. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}) == 6</span>
    916. 

  916. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello &quot;</span>
    917. 

  917. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 3) == 3</span>
    918. 

  918. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;lo &quot;</span></pre>
    919. 

  919.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L340" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    920. 

  920. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L340" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    921. 

  921. 

  922.   </dd>
    923. 

  923. </div>
    924. 

  924. <div id="parseUntil,openArray[char],string,string">
    925. 

  925.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUntil%2CopenArray%5Bchar%5D%2Cstring%2Cstring"><span class="Identifier">parseUntil</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">until</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#int"><span class="Identifier">int</span></a> {.
    926. 

  926.     <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>
    927. 

  927.   <dd>
    928. 

  928.     
    929. 

  929.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of any character that comes before the <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt>  token.
    930. 

  930. <p><strong class="examples_text">Example:</strong></p>
    931. 

  931. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    932. 

  932. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Wor&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    933. 

  933. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello &quot;</span>
    934. 

  934. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Wor&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    935. 

  935. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;llo &quot;</span></pre>
    936. 

  936.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L376" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    937. 

  937. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L376" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    938. 

  938. 

  939.   </dd>
    940. 

  940. </div>
    941. 

  941. <div id="parseUntil,string,string,char,int">
    942. 

  942.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUntil%2Cstring%2Cstring%2Cchar%2Cint"><span class="Identifier">parseUntil</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">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</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> {.
    943. 

  943.     <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>
    944. 

  944.   <dd>
    945. 

  945.     
    946. 

  946.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of any character that is not the <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt> character.
    947. 

  947. <p><strong class="examples_text">Example:</strong></p>
    948. 

  948. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    949. 

  949. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="CharLit">'W'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    950. 

  950. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello &quot;</span>
    951. 

  951. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    952. 

  952. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hell&quot;</span>
    953. 

  953. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    954. 

  954. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;ll&quot;</span></pre>
    955. 

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

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

  957. 

  958.   </dd>
    959. 

  959. </div>
    960. 

  960. <div id="parseUntil,string,string,set[char],int">
    961. 

  961.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUntil%2Cstring%2Cstring%2Cset%5Bchar%5D%2Cint"><span class="Identifier">parseUntil</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">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">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> {.
    962. 

  962.     <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>
    963. 

  963.   <dd>
    964. 

  964.     
    965. 

  965.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of the characters notin <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt>.
    966. 

  966. <p><strong class="examples_text">Example:</strong></p>
    967. 

  967. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    968. 

  968. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}) == 4</span>
    969. 

  969. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hell&quot;</span>
    970. 

  970. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}) == 6</span>
    971. 

  971. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello &quot;</span>
    972. 

  972. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 3) == 3</span>
    973. 

  973. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;lo &quot;</span></pre>
    974. 

  974.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L938" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    975. 

  975. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L938" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    976. 

  976. 

  977.   </dd>
    978. 

  978. </div>
    979. 

  979. <div id="parseUntil,string,string,string,int">
    980. 

  980.   <dt><pre><span class="Keyword">proc</span> <a href="#parseUntil%2Cstring%2Cstring%2Cstring%2Cint"><span class="Identifier">parseUntil</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">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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> {.
    981. 

  981.     <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>
    982. 

  982.   <dd>
    983. 

  983.     
    984. 

  984.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of any character that comes before the <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt>  token.
    985. 

  985. <p><strong class="examples_text">Example:</strong></p>
    986. 

  986. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    987. 

  987. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Wor&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    988. 

  988. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hello &quot;</span>
    989. 

  989. <span class="Identifier">doAssert</span> <span class="Identifier">parseUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Wor&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    990. 

  990. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;llo &quot;</span></pre>
    991. 

  991.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L968" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    992. 

  992. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L968" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    993. 

  993. 

  994.   </dd>
    995. 

  995. </div>
    996. 

  996. 

  997. </div>
    998. 

  998. <div id="parseWhile-procs-all">
    999. 

  999.   <div id="parseWhile,openArray[char],string,set[char]">
    1000. 

  1000.   <dt><pre><span class="Keyword">proc</span> <a href="#parseWhile%2CopenArray%5Bchar%5D%2Cstring%2Cset%5Bchar%5D"><span class="Identifier">parseWhile</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">validChars</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1001. 

  1001.     <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>
    1002. 

  1002.   <dd>
    1003. 

  1003.     
    1004. 

  1004.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of the characters in <tt class="docutils literal"><span class="pre"><span class="Identifier">validChars</span></span></tt>.
    1005. 

  1005. <p><strong class="examples_text">Example:</strong></p>
    1006. 

  1006. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    1007. 

  1007. <span class="Identifier">doAssert</span> <span class="Identifier">parseWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 0) == 0</span>
    1008. 

  1008. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1009. 

  1009. <span class="Identifier">doAssert</span> <span class="Identifier">parseWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 6) == 3</span>
    1010. 

  1010. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Wor&quot;</span></pre>
    1011. 

  1011.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L402" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1012. 

  1012. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L402" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1013. 

  1013. 

  1014.   </dd>
    1015. 

  1015. </div>
    1016. 

  1016. <div id="parseWhile,string,string,set[char],int">
    1017. 

  1017.   <dt><pre><span class="Keyword">proc</span> <a href="#parseWhile%2Cstring%2Cstring%2Cset%5Bchar%5D%2Cint"><span class="Identifier">parseWhile</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">token</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">validChars</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">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> {.
    1018. 

  1018.     <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>
    1019. 

  1019.   <dd>
    1020. 

  1020.     
    1021. 

  1021.     Parses a token and stores it in <tt class="docutils literal"><span class="pre">token</span></tt>. Returns the number of the parsed characters or 0 in case of an error. A token consists of the characters in <tt class="docutils literal"><span class="pre"><span class="Identifier">validChars</span></span></tt>.
    1022. 

  1022. <p><strong class="examples_text">Example:</strong></p>
    1023. 

  1023. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myToken</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    1024. 

  1024. <span class="Identifier">doAssert</span> <span class="Identifier">parseWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 0) == 0</span>
    1025. 

  1025. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1026. 

  1026. <span class="Identifier">doAssert</span> <span class="Identifier">parseWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Identifier">myToken</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 6) == 3</span>
    1027. 

  1027. <span class="Identifier">doAssert</span> <span class="Identifier">myToken</span> <span class="Operator">==</span> <span class="StringLit">&quot;Wor&quot;</span></pre>
    1028. 

  1028.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L981" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1029. 

  1029. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L981" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1030. 

  1030. 

  1031.   </dd>
    1032. 

  1032. </div>
    1033. 

  1033. 

  1034. </div>
    1035. 

  1035. <div id="skip-procs-all">
    1036. 

  1036.   <div id="skip,openArray[char],openArray[char]">
    1037. 

  1037.   <dt><pre><span class="Keyword">proc</span> <a href="#skip%2CopenArray%5Bchar%5D%2CopenArray%5Bchar%5D"><span class="Identifier">skip</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">token</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
    1038. 

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

  1039.   <dd>
    1040. 

  1040.     
    1041. 

  1041.     Skips the <tt class="docutils literal"><span class="pre"><span class="Identifier">token</span></span></tt> starting at <tt class="docutils literal"><span class="pre">s[start]</span></tt>. Returns the length of <tt class="docutils literal"><span class="pre"><span class="Identifier">token</span></span></tt> or 0 if there was no <tt class="docutils literal"><span class="pre"><span class="Identifier">token</span></span></tt> at <tt class="docutils literal"><span class="pre">s[start]</span></tt>.
    1042. 

  1042. <p><strong class="examples_text">Example:</strong></p>
    1043. 

  1043. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;2019-01-22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2019&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1044. 

  1044. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;2019-01-22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;19&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1045. 

  1045. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;2019-01-22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;19&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    1046. 

  1046. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;CAP&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    1047. 

  1047. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;cap&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span></pre>
    1048. 

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

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

  1050. 

  1051.   </dd>
    1052. 

  1052. </div>
    1053. 

  1053. <div id="skip,string,string,int">
    1054. 

  1054.   <dt><pre><span class="Keyword">proc</span> <a href="#skip%2Cstring%2Cstring%2Cint"><span class="Identifier">skip</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">token</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1055. 

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

  1056.   <dd>
    1057. 

  1057.     
    1058. 

  1058.     Skips the <tt class="docutils literal"><span class="pre"><span class="Identifier">token</span></span></tt> starting at <tt class="docutils literal"><span class="pre">s[start]</span></tt>. Returns the length of <tt class="docutils literal"><span class="pre"><span class="Identifier">token</span></span></tt> or 0 if there was no <tt class="docutils literal"><span class="pre"><span class="Identifier">token</span></span></tt> at <tt class="docutils literal"><span class="pre">s[start]</span></tt>.
    1059. 

  1059. <p><strong class="examples_text">Example:</strong></p>
    1060. 

  1060. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;2019-01-22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2019&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1061. 

  1061. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;2019-01-22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;19&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1062. 

  1062. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;2019-01-22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;19&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    1063. 

  1063. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;CAP&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    1064. 

  1064. <span class="Identifier">doAssert</span> <span class="Identifier">skip</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;cap&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span></pre>
    1065. 

  1065.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L890" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1066. 

  1066. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L890" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1067. 

  1067. 

  1068.   </dd>
    1069. 

  1069. </div>
    1070. 

  1070. 

  1071. </div>
    1072. 

  1072. <div id="skipIgnoreCase-procs-all">
    1073. 

  1073.   <div id="skipIgnoreCase,openArray[char],openArray[char]">
    1074. 

  1074.   <dt><pre><span class="Keyword">proc</span> <a href="#skipIgnoreCase%2CopenArray%5Bchar%5D%2CopenArray%5Bchar%5D"><span class="Identifier">skipIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">token</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
    1075. 

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

  1076.   <dd>
    1077. 

  1077.     
    1078. 

  1078.     Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">skip</span></span></tt> but case is ignored for token matching.
    1079. 

  1079. <p><strong class="examples_text">Example:</strong></p>
    1080. 

  1080. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;CAP&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    1081. 

  1081. <span class="Identifier">doAssert</span> <span class="Identifier">skipIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;cap&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
    1082. 

  1082.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L293" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1083. 

  1083. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L293" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1084. 

  1084. 

  1085.   </dd>
    1086. 

  1086. </div>
    1087. 

  1087. <div id="skipIgnoreCase,string,string,int">
    1088. 

  1088.   <dt><pre><span class="Keyword">proc</span> <a href="#skipIgnoreCase%2Cstring%2Cstring%2Cint"><span class="Identifier">skipIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">token</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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><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>
    1089. 

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

  1090.   <dd>
    1091. 

  1091.     
    1092. 

  1092.     Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">skip</span></span></tt> but case is ignored for token matching.
    1093. 

  1093. <p><strong class="examples_text">Example:</strong></p>
    1094. 

  1094. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;CAP&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    1095. 

  1095. <span class="Identifier">doAssert</span> <span class="Identifier">skipIgnoreCase</span><span class="Punctuation">(</span><span class="StringLit">&quot;CAPlow&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;cap&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
    1096. 

  1096.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L901" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1097. 

  1097. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L901" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1098. 

  1098. 

  1099.   </dd>
    1100. 

  1100. </div>
    1101. 

  1101. 

  1102. </div>
    1103. 

  1103. <div id="skipUntil-procs-all">
    1104. 

  1104.   <div id="skipUntil,openArray[char],char">
    1105. 

  1105.   <dt><pre><span class="Keyword">proc</span> <a href="#skipUntil%2CopenArray%5Bchar%5D%2Cchar"><span class="Identifier">skipUntil</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</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>
    1106. 

  1106.     <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>
    1107. 

  1107.   <dd>
    1108. 

  1108.     
    1109. 

  1109.     Skips all characters until the char <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt> is found or the end is reached. Returns number of characters skipped.
    1110. 

  1110. <p><strong class="examples_text">Example:</strong></p>
    1111. 

  1111. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1112. 

  1112. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1113. 

  1113. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'W'</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    1114. 

  1114. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'w'</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span></pre>
    1115. 

  1115.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L314" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1116. 

  1116. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L314" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1117. 

  1117. 

  1118.   </dd>
    1119. 

  1119. </div>
    1120. 

  1120. <div id="skipUntil,openArray[char],set[char]">
    1121. 

  1121.   <dt><pre><span class="Keyword">proc</span> <a href="#skipUntil%2CopenArray%5Bchar%5D%2Cset%5Bchar%5D"><span class="Identifier">skipUntil</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">until</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
    1122. 

  1122.     <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>
    1123. 

  1123.   <dd>
    1124. 

  1124.     
    1125. 

  1125.     Skips all characters until one char from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt> is found or the end is reached. Returns number of characters skipped.
    1126. 

  1126. <p><strong class="examples_text">Example:</strong></p>
    1127. 

  1127. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">'}, 0) == 1</span>
    1128. 

  1128. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">'}, 0) == 6</span>
    1129. 

  1129. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">'}, 0) == 6</span></pre>
    1130. 

  1130.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L303" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1131. 

  1131. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L303" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1132. 

  1132. 

  1133.   </dd>
    1134. 

  1134. </div>
    1135. 

  1135. <div id="skipUntil,string,char,int">
    1136. 

  1136.   <dt><pre><span class="Keyword">proc</span> <a href="#skipUntil%2Cstring%2Cchar%2Cint"><span class="Identifier">skipUntil</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">until</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</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>
    1137. 

  1137.     <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>
    1138. 

  1138.   <dd>
    1139. 

  1139.     
    1140. 

  1140.     Skips all characters until the char <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt> is found or the end is reached. Returns number of characters skipped.
    1141. 

  1141. <p><strong class="examples_text">Example:</strong></p>
    1142. 

  1142. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1143. 

  1143. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'o'</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1144. 

  1144. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'W'</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    1145. 

  1145. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'w'</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">11</span></pre>
    1146. 

  1146.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L918" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1147. 

  1147. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L918" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1148. 

  1148. 

  1149.   </dd>
    1150. 

  1150. </div>
    1151. 

  1151. <div id="skipUntil,string,set[char],int">
    1152. 

  1152.   <dt><pre><span class="Keyword">proc</span> <a href="#skipUntil%2Cstring%2Cset%5Bchar%5D%2Cint"><span class="Identifier">skipUntil</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">until</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">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>
    1153. 

  1153.     <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>
    1154. 

  1154.   <dd>
    1155. 

  1155.     
    1156. 

  1156.     Skips all characters until one char from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">until</span></span></tt> is found or the end is reached. Returns number of characters skipped.
    1157. 

  1157. <p><strong class="examples_text">Example:</strong></p>
    1158. 

  1158. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">'}, 0) == 1</span>
    1159. 

  1159. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">'}, 0) == 6</span>
    1160. 

  1160. <span class="Identifier">doAssert</span> <span class="Identifier">skipUntil</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">'}, 0) == 6</span></pre>
    1161. 

  1161.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L908" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1162. 

  1162. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L908" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1163. 

  1163. 

  1164.   </dd>
    1165. 

  1165. </div>
    1166. 

  1166. 

  1167. </div>
    1168. 

  1168. <div id="skipWhile-procs-all">
    1169. 

  1169.   <div id="skipWhile,openArray[char],set[char]">
    1170. 

  1170.   <dt><pre><span class="Keyword">proc</span> <a href="#skipWhile%2CopenArray%5Bchar%5D%2Cset%5Bchar%5D"><span class="Identifier">skipWhile</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">toSkip</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
    1171. 

  1171.     <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>
    1172. 

  1172.   <dd>
    1173. 

  1173.     
    1174. 

  1174.     Skips all characters while one char from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">toSkip</span></span></tt> is found. Returns number of characters skipped.
    1175. 

  1175. <p><strong class="examples_text">Example:</strong></p>
    1176. 

  1176. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">H</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">'}) == 2</span>
    1177. 

  1177. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">e</span><span class="CharLit">'}) == 0</span>
    1178. 

  1178. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 6) == 3</span></pre>
    1179. 

  1179.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L326" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1180. 

  1180. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L326" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1181. 

  1181. 

  1182.   </dd>
    1183. 

  1183. </div>
    1184. 

  1184. <div id="skipWhile,string,set[char],int">
    1185. 

  1185.   <dt><pre><span class="Keyword">proc</span> <a href="#skipWhile%2Cstring%2Cset%5Bchar%5D%2Cint"><span class="Identifier">skipWhile</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">toSkip</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">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>
    1186. 

  1186.     <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>
    1187. 

  1187.   <dd>
    1188. 

  1188.     
    1189. 

  1189.     Skips all characters while one char from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">toSkip</span></span></tt> is found. Returns number of characters skipped.
    1190. 

  1190. <p><strong class="examples_text">Example:</strong></p>
    1191. 

  1191. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">H</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">'}) == 2</span>
    1192. 

  1192. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">e</span><span class="CharLit">'}) == 0</span>
    1193. 

  1193. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhile</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}, 6) == 3</span></pre>
    1194. 

  1194.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L929" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1195. 

  1195. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L929" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1196. 

  1196. 

  1197.   </dd>
    1198. 

  1198. </div>
    1199. 

  1199. 

  1200. </div>
    1201. 

  1201. <div id="skipWhitespace-procs-all">
    1202. 

  1202.   <div id="skipWhitespace,openArray[char]">
    1203. 

  1203.   <dt><pre><span class="Keyword">proc</span> <a href="#skipWhitespace%2CopenArray%5Bchar%5D"><span class="Identifier">skipWhitespace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="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>
    1204. 

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

  1205.   <dd>
    1206. 

  1206.     
    1207. 

  1207.     Skips the whitespace starting at <tt class="docutils literal"><span class="pre">s[start]</span></tt>. Returns the number of skipped characters.
    1208. 

  1208. <p><strong class="examples_text">Example:</strong></p>
    1209. 

  1209. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1210. 

  1210. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot; Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1211. 

  1211. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1212. 

  1212. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello  World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    1213. 

  1213.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L267" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1214. 

  1214. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L267" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1215. 

  1215. 

  1216.   </dd>
    1217. 

  1217. </div>
    1218. 

  1218. <div id="skipWhitespace,string,int">
    1219. 

  1219.   <dt><pre><span class="Keyword">proc</span> <a href="#skipWhitespace%2Cstring%2Cint"><span class="Identifier">skipWhitespace</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">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>
    1220. 

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

  1221.   <dd>
    1222. 

  1222.     
    1223. 

  1223.     Skips the whitespace starting at <tt class="docutils literal"><span class="pre">s[start]</span></tt>. Returns the number of skipped characters.
    1224. 

  1224. <p><strong class="examples_text">Example:</strong></p>
    1225. 

  1225. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1226. 

  1226. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot; Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1227. 

  1227. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1228. 

  1228. <span class="Identifier">doAssert</span> <span class="Identifier">skipWhitespace</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello  World&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    1229. 

  1229.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L880" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1230. 

  1230. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L880" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1231. 

  1231. 

  1232.   </dd>
    1233. 

  1233. </div>
    1234. 

  1234. 

  1235. </div>
    1236. 

  1236. 

  1237.   </dl>
    1238. 

  1238. </div>
    1239. 

  1239. <div class="section" id="15">
    1240. 

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

  1241.   <dl class="item">
    1242. 

  1242.     <div id="interpolatedFragments-iterators-all">
    1243. 

  1243.   <div id="interpolatedFragments.i,openArray[char]">
    1244. 

  1244.   <dt><pre><span class="Keyword">iterator</span> <a href="#interpolatedFragments.i%2CopenArray%5Bchar%5D"><span class="Identifier">interpolatedFragments</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span>
    1245. 

  1245.     <span class="Identifier">kind</span><span class="Other">:</span> <a href="parseutils.html#InterpolatedKind"><span class="Identifier">InterpolatedKind</span></a><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">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>
    1246. 

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

  1247.   <dd>
    1248. 

  1248.     
    1249. 

  1249.     Tokenizes the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into substrings for interpolation purposes. 
    1250. 

  1250. <p><strong class="examples_text">Example:</strong></p>
    1251. 

  1251. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">outp</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">kind</span><span class="Punctuation">:</span> <span class="Identifier">InterpolatedKind</span><span class="Punctuation">,</span> <span class="Identifier">value</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">]</span>
    1252. 

  1252. <span class="Keyword">for</span> <span class="Identifier">k</span><span class="Punctuation">,</span> <span class="Identifier">v</span> <span class="Keyword">in</span> <span class="Identifier">interpolatedFragments</span><span class="Punctuation">(</span><span class="StringLit">&quot;  $this is ${an  example}  $$&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    1253. 

  1253.   <span class="Identifier">outp</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Punctuation">(</span><span class="Identifier">k</span><span class="Punctuation">,</span> <span class="Identifier">v</span><span class="Punctuation">)</span>
    1254. 

  1254. <span class="Identifier">doAssert</span> <span class="Identifier">outp</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">(</span><span class="Identifier">ikStr</span><span class="Punctuation">,</span> <span class="StringLit">&quot;  &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1255. 

  1255.                    <span class="Punctuation">(</span><span class="Identifier">ikVar</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1256. 

  1256.                    <span class="Punctuation">(</span><span class="Identifier">ikStr</span><span class="Punctuation">,</span> <span class="StringLit">&quot; is &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1257. 

  1257.                    <span class="Punctuation">(</span><span class="Identifier">ikExpr</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an  example&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1258. 

  1258.                    <span class="Punctuation">(</span><span class="Identifier">ikStr</span><span class="Punctuation">,</span> <span class="StringLit">&quot;  &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1259. 

  1259.                    <span class="Punctuation">(</span><span class="Identifier">ikDollar</span><span class="Punctuation">,</span> <span class="StringLit">&quot;$&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span></pre>
    1260. 

  1260.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L684" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1261. 

  1261. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L684" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1262. 

  1262. 

  1263.   </dd>
    1264. 

  1264. </div>
    1265. 

  1265. <div id="interpolatedFragments.i,string">
    1266. 

  1266.   <dt><pre><span class="Keyword">iterator</span> <a href="#interpolatedFragments.i%2Cstring"><span class="Identifier">interpolatedFragments</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> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">kind</span><span class="Other">:</span> <a href="parseutils.html#InterpolatedKind"><span class="Identifier">InterpolatedKind</span></a><span class="Other">,</span>
    1267. 

  1267.     <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">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>
    1268. 

  1268.   <dd>
    1269. 

  1269.     
    1270. 

  1270.     Tokenizes the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into substrings for interpolation purposes. 
    1271. 

  1271. <p><strong class="examples_text">Example:</strong></p>
    1272. 

  1272. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">outp</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">kind</span><span class="Punctuation">:</span> <span class="Identifier">InterpolatedKind</span><span class="Punctuation">,</span> <span class="Identifier">value</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">]</span>
    1273. 

  1273. <span class="Keyword">for</span> <span class="Identifier">k</span><span class="Punctuation">,</span> <span class="Identifier">v</span> <span class="Keyword">in</span> <span class="Identifier">interpolatedFragments</span><span class="Punctuation">(</span><span class="StringLit">&quot;  $this is ${an  example}  $$&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    1274. 

  1274.   <span class="Identifier">outp</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Punctuation">(</span><span class="Identifier">k</span><span class="Punctuation">,</span> <span class="Identifier">v</span><span class="Punctuation">)</span>
    1275. 

  1275. <span class="Identifier">doAssert</span> <span class="Identifier">outp</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">(</span><span class="Identifier">ikStr</span><span class="Punctuation">,</span> <span class="StringLit">&quot;  &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1276. 

  1276.                    <span class="Punctuation">(</span><span class="Identifier">ikVar</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1277. 

  1277.                    <span class="Punctuation">(</span><span class="Identifier">ikStr</span><span class="Punctuation">,</span> <span class="StringLit">&quot; is &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1278. 

  1278.                    <span class="Punctuation">(</span><span class="Identifier">ikExpr</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an  example&quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1279. 

  1279.                    <span class="Punctuation">(</span><span class="Identifier">ikStr</span><span class="Punctuation">,</span> <span class="StringLit">&quot;  &quot;</span><span class="Punctuation">)</span><span class="Punctuation">,</span>
    1280. 

  1280.                    <span class="Punctuation">(</span><span class="Identifier">ikDollar</span><span class="Punctuation">,</span> <span class="StringLit">&quot;$&quot;</span><span class="Punctuation">)</span><span class="Punctuation">]</span></pre>
    1281. 

  1281.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseutils.nim#L1087" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1282. 

  1282. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseutils.nim#L1087" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1283. 

  1283. 

  1284.   </dd>
    1285. 

  1285. </div>
    1286. 

  1286. 

  1287. </div>
    1288. 

  1288. 

  1289.   </dl>
    1290. 

  1290. </div>
    1291. 

  1291. 

  1292.   </div>
    1293. 

  1293. </div>
    1294. 

  1294. 

  1295.       <div class="twelve-columns footer">
    1296. 

  1296.         <span class="nim-sprite"></span>
    1297. 

  1297.         <br>
    1298. 

  1298.         <small style="color: var(--hint);">Made with Nim. Generated: 2024-12-25 08:35:55 UTC</small>
    1299. 

  1299.       </div>
    1300. 

  1300.     </div>
    1301. 

  1301.   </div>
    1302. 

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

  1303.     
    1304. 

  1304. </body>
    1305. 

  1305. </html>
    1306. 

  1306.