Home Explore Help
Sign In
levovix
/
Nim
mirror of https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Tree: 1a4643a625
Branches Tags
Nim
/
unicode.html

unicode.html 254 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951 
  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/unicode</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/unicode</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li>
    55. 

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

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

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

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

  61.       <li><a class="reference" href="#Rune" title="Rune = distinct RuneImpl">Rune</a></li>
    62. 

  62. 

  63.     </ul>
    64. 

  64.   </details>
    65. 

  65. </li>
    66. 

  66. <li>
    67. 

  67.   <details open>
    68. 

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

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

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

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

  72. <li><a class="reference" href="#%24%2Cseq%5BRune%5D" title="`$`(runes: seq[Rune]): string">`$`(runes: seq[Rune]): string</a></li>
    73. 

  73. 

  74. </ul>
    75. 

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

  76.   <li><a class="reference" href="#%3C%25%2CRune%2CRune" title="`&lt;%`(a, b: Rune): bool">`&lt;%`(a, b: Rune): bool</a></li>
    77. 

  77. 

  78. </ul>
    79. 

  79. <ul class="simple nested-toc-section"><=%
    80. 

  80.   <li><a class="reference" href="#%3C%3D%25%2CRune%2CRune" title="`&lt;=%`(a, b: Rune): bool">`&lt;=%`(a, b: Rune): bool</a></li>
    81. 

  81. 

  82. </ul>
    83. 

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

  84.   <li><a class="reference" href="#%3D%3D%2CRune%2CRune" title="`==`(a, b: Rune): bool">`==`(a, b: Rune): bool</a></li>
    85. 

  85. 

  86. </ul>
    87. 

  87. <ul class="simple nested-toc-section">add
    88. 

  88.   <li><a class="reference" href="#add%2Cstring%2CRune" title="add(s: var string; c: Rune)">add(s: var string; c: Rune)</a></li>
    89. 

  89. 

  90. </ul>
    91. 

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

  92.   <li><a class="reference" href="#align%2CopenArray%5Bchar%5D%2CNatural" title="align(s: openArray[char]; count: Natural; padding = ' '.Rune): string">align(s: openArray[char]; count: Natural; padding = ' '.Rune): string</a></li>
    93. 

  93. <li><a class="reference" href="#align%2Cstring%2CNatural" title="align(s: string; count: Natural; padding = ' '.Rune): string">align(s: string; count: Natural; padding = ' '.Rune): string</a></li>
    94. 

  94. 

  95. </ul>
    96. 

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

  97.   <li><a class="reference" href="#alignLeft%2CopenArray%5Bchar%5D%2CNatural" title="alignLeft(s: openArray[char]; count: Natural; padding = ' '.Rune): string">alignLeft(s: openArray[char]; count: Natural; padding = ' '.Rune): string</a></li>
    98. 

  98. <li><a class="reference" href="#alignLeft%2Cstring%2CNatural" title="alignLeft(s: string; count: Natural; padding = ' '.Rune): string">alignLeft(s: string; count: Natural; padding = ' '.Rune): string</a></li>
    99. 

  99. 

  100. </ul>
    101. 

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

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

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

  104. 

  105. </ul>
    106. 

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

  107.   <li><a class="reference" href="#cmpRunesIgnoreCase%2CopenArray%5Bchar%5D%2CopenArray%5Bchar%5D" title="cmpRunesIgnoreCase(a, b: openArray[char]): int">cmpRunesIgnoreCase(a, b: openArray[char]): int</a></li>
    108. 

  108. <li><a class="reference" href="#cmpRunesIgnoreCase%2Cstring%2Cstring" title="cmpRunesIgnoreCase(a, b: string): int">cmpRunesIgnoreCase(a, b: string): int</a></li>
    109. 

  109. 

  110. </ul>
    111. 

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

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

  113. <li><a class="reference" href="#graphemeLen%2Cstring%2CNatural" title="graphemeLen(s: string; i: Natural): Natural">graphemeLen(s: string; i: Natural): Natural</a></li>
    114. 

  114. 

  115. </ul>
    116. 

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

  117.   <li><a class="reference" href="#isAlpha%2CRune" title="isAlpha(c: Rune): bool">isAlpha(c: Rune): bool</a></li>
    118. 

  118. <li><a class="reference" href="#isAlpha%2CopenArray%5Bchar%5D" title="isAlpha(s: openArray[char]): bool">isAlpha(s: openArray[char]): bool</a></li>
    119. 

  119. <li><a class="reference" href="#isAlpha%2Cstring" title="isAlpha(s: string): bool">isAlpha(s: string): bool</a></li>
    120. 

  120. 

  121. </ul>
    122. 

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

  123.   <li><a class="reference" href="#isCombining%2CRune" title="isCombining(c: Rune): bool">isCombining(c: Rune): bool</a></li>
    124. 

  124. 

  125. </ul>
    126. 

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

  127.   <li><a class="reference" href="#isLower%2CRune" title="isLower(c: Rune): bool">isLower(c: Rune): bool</a></li>
    128. 

  128. 

  129. </ul>
    130. 

  130. <ul class="simple nested-toc-section">isSpace
    131. 

  131.   <li><a class="reference" href="#isSpace%2CopenArray%5Bchar%5D" title="isSpace(s: openArray[char]): bool">isSpace(s: openArray[char]): bool</a></li>
    132. 

  132. <li><a class="reference" href="#isSpace%2Cstring" title="isSpace(s: string): bool">isSpace(s: string): bool</a></li>
    133. 

  133. 

  134. </ul>
    135. 

  135. <ul class="simple nested-toc-section">isTitle
    136. 

  136.   <li><a class="reference" href="#isTitle%2CRune" title="isTitle(c: Rune): bool">isTitle(c: Rune): bool</a></li>
    137. 

  137. 

  138. </ul>
    139. 

  139. <ul class="simple nested-toc-section">isUpper
    140. 

  140.   <li><a class="reference" href="#isUpper%2CRune" title="isUpper(c: Rune): bool">isUpper(c: Rune): bool</a></li>
    141. 

  141. 

  142. </ul>
    143. 

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

  144.   <li><a class="reference" href="#isWhiteSpace%2CRune" title="isWhiteSpace(c: Rune): bool">isWhiteSpace(c: Rune): bool</a></li>
    145. 

  145. 

  146. </ul>
    147. 

  147. <ul class="simple nested-toc-section">lastRune
    148. 

  148.   <li><a class="reference" href="#lastRune%2CopenArray%5Bchar%5D%2Cint" title="lastRune(s: openArray[char]; last: int): (Rune, int)">lastRune(s: openArray[char]; last: int): (Rune, int)</a></li>
    149. 

  149. <li><a class="reference" href="#lastRune%2Cstring%2Cint" title="lastRune(s: string; last: int): (Rune, int)">lastRune(s: string; last: int): (Rune, int)</a></li>
    150. 

  150. 

  151. </ul>
    152. 

  152. <ul class="simple nested-toc-section">repeat
    153. 

  153.   <li><a class="reference" href="#repeat%2CRune%2CNatural" title="repeat(c: Rune; count: Natural): string">repeat(c: Rune; count: Natural): string</a></li>
    154. 

  154. 

  155. </ul>
    156. 

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

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

  158. <li><a class="reference" href="#reversed%2Cstring" title="reversed(s: string): string">reversed(s: string): string</a></li>
    159. 

  159. 

  160. </ul>
    161. 

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

  162.   <li><a class="reference" href="#runeAt%2CopenArray%5Bchar%5D%2CNatural" title="runeAt(s: openArray[char]; i: Natural): Rune">runeAt(s: openArray[char]; i: Natural): Rune</a></li>
    163. 

  163. <li><a class="reference" href="#runeAt%2Cstring%2CNatural" title="runeAt(s: string; i: Natural): Rune">runeAt(s: string; i: Natural): Rune</a></li>
    164. 

  164. 

  165. </ul>
    166. 

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

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

  168. <li><a class="reference" href="#runeAtPos%2Cstring%2Cint" title="runeAtPos(s: string; pos: int): Rune">runeAtPos(s: string; pos: int): Rune</a></li>
    169. 

  169. 

  170. </ul>
    171. 

  171. <ul class="simple nested-toc-section">runeLen
    172. 

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

  173. <li><a class="reference" href="#runeLen%2Cstring" title="runeLen(s: string): int">runeLen(s: string): int</a></li>
    174. 

  174. 

  175. </ul>
    176. 

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

  177.   <li><a class="reference" href="#runeLenAt%2CopenArray%5Bchar%5D%2CNatural" title="runeLenAt(s: openArray[char]; i: Natural): int">runeLenAt(s: openArray[char]; i: Natural): int</a></li>
    178. 

  178. <li><a class="reference" href="#runeLenAt%2Cstring%2CNatural" title="runeLenAt(s: string; i: Natural): int">runeLenAt(s: string; i: Natural): int</a></li>
    179. 

  179. 

  180. </ul>
    181. 

  181. <ul class="simple nested-toc-section">runeOffset
    182. 

  182.   <li><a class="reference" href="#runeOffset%2CopenArray%5Bchar%5D%2CNatural%2CNatural" title="runeOffset(s: openArray[char]; pos: Natural; start: Natural = 0): int">runeOffset(s: openArray[char]; pos: Natural; start: Natural = 0): int</a></li>
    183. 

  183. <li><a class="reference" href="#runeOffset%2Cstring%2CNatural%2CNatural" title="runeOffset(s: string; pos: Natural; start: Natural = 0): int">runeOffset(s: string; pos: Natural; start: Natural = 0): int</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">runeReverseOffset
    187. 

  187.   <li><a class="reference" href="#runeReverseOffset%2CopenArray%5Bchar%5D%2CPositive" title="runeReverseOffset(s: openArray[char]; rev: Positive): (int, int)">runeReverseOffset(s: openArray[char]; rev: Positive): (int, int)</a></li>
    188. 

  188. <li><a class="reference" href="#runeReverseOffset%2Cstring%2CPositive" title="runeReverseOffset(s: string; rev: Positive): (int, int)">runeReverseOffset(s: string; rev: Positive): (int, int)</a></li>
    189. 

  189. 

  190. </ul>
    191. 

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

  192.   <li><a class="reference" href="#runeStrAtPos%2CopenArray%5Bchar%5D%2CNatural" title="runeStrAtPos(s: openArray[char]; pos: Natural): string">runeStrAtPos(s: openArray[char]; pos: Natural): string</a></li>
    193. 

  193. <li><a class="reference" href="#runeStrAtPos%2Cstring%2CNatural" title="runeStrAtPos(s: string; pos: Natural): string">runeStrAtPos(s: string; pos: Natural): string</a></li>
    194. 

  194. 

  195. </ul>
    196. 

  196. <ul class="simple nested-toc-section">runeSubStr
    197. 

  197.   <li><a class="reference" href="#runeSubStr%2CopenArray%5Bchar%5D%2Cint%2Cint" title="runeSubStr(s: openArray[char]; pos: int; len: int = int.high): string">runeSubStr(s: openArray[char]; pos: int; len: int = int.high): string</a></li>
    198. 

  198. <li><a class="reference" href="#runeSubStr%2Cstring%2Cint%2Cint" title="runeSubStr(s: string; pos: int; len: int = int.high): string">runeSubStr(s: string; pos: int; len: int = int.high): string</a></li>
    199. 

  199. 

  200. </ul>
    201. 

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

  202.   <li><a class="reference" href="#size%2CRune" title="size(r: Rune): int">size(r: Rune): int</a></li>
    203. 

  203. 

  204. </ul>
    205. 

  205. <ul class="simple nested-toc-section">split
    206. 

  206.   <li><a class="reference" href="#split%2CopenArray%5Bchar%5D%2CRune%2Cint" title="split(s: openArray[char]; sep: Rune; maxsplit: int = -1): seq[string]">split(s: openArray[char]; sep: Rune; maxsplit: int = -1): seq[string]</a></li>
    207. 

  207. <li><a class="reference" href="#split%2CopenArray%5Bchar%5D%2CopenArray%5BRune%5D%2Cint" title="split(s: openArray[char]; seps: openArray[Rune] = unicodeSpaces;
    208. 

  208.       maxsplit: int = -1): seq[string]">split(s: openArray[char]; seps: openArray[Rune] = unicodeSpaces;
    209. 

  209.       maxsplit: int = -1): seq[string]</a></li>
    210. 

  210. <li><a class="reference" href="#split%2Cstring%2CRune%2Cint" title="split(s: string; sep: Rune; maxsplit: int = -1): seq[string]">split(s: string; sep: Rune; maxsplit: int = -1): seq[string]</a></li>
    211. 

  211. <li><a class="reference" href="#split%2Cstring%2CopenArray%5BRune%5D%2Cint" title="split(s: string; seps: openArray[Rune] = unicodeSpaces; maxsplit: int = -1): seq[
    212. 

  212.     string]">split(s: string; seps: openArray[Rune] = unicodeSpaces; maxsplit: int = -1): seq[
    213. 

  213.     string]</a></li>
    214. 

  214. 

  215. </ul>
    216. 

  216. <ul class="simple nested-toc-section">splitWhitespace
    217. 

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

  218. <li><a class="reference" href="#splitWhitespace%2Cstring" title="splitWhitespace(s: string): seq[string]">splitWhitespace(s: string): seq[string]</a></li>
    219. 

  219. 

  220. </ul>
    221. 

  221. <ul class="simple nested-toc-section">strip
    222. 

  222.   <li><a class="reference" href="#strip%2CopenArray%5Bchar%5D%2CopenArray%5BRune%5D" title="strip(s: openArray[char]; leading = true; trailing = true;
    223. 

  223.       runes: openArray[Rune] = unicodeSpaces): string">strip(s: openArray[char]; leading = true; trailing = true;
    224. 

  224.       runes: openArray[Rune] = unicodeSpaces): string</a></li>
    225. 

  225. <li><a class="reference" href="#strip%2Cstring%2CopenArray%5BRune%5D" title="strip(s: string; leading = true; trailing = true;
    226. 

  226.       runes: openArray[Rune] = unicodeSpaces): string">strip(s: string; leading = true; trailing = true;
    227. 

  227.       runes: openArray[Rune] = unicodeSpaces): string</a></li>
    228. 

  228. 

  229. </ul>
    230. 

  230. <ul class="simple nested-toc-section">swapCase
    231. 

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

  232. <li><a class="reference" href="#swapCase%2Cstring" title="swapCase(s: string): string">swapCase(s: string): string</a></li>
    233. 

  233. 

  234. </ul>
    235. 

  235. <ul class="simple nested-toc-section">title
    236. 

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

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

  238. 

  239. </ul>
    240. 

  240. <ul class="simple nested-toc-section">toLower
    241. 

  241.   <li><a class="reference" href="#toLower%2CRune" title="toLower(c: Rune): Rune">toLower(c: Rune): Rune</a></li>
    242. 

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

  243. <li><a class="reference" href="#toLower%2Cstring" title="toLower(s: string): string">toLower(s: string): string</a></li>
    244. 

  244. 

  245. </ul>
    246. 

  246. <ul class="simple nested-toc-section">toRunes
    247. 

  247.   <li><a class="reference" href="#toRunes%2CopenArray%5Bchar%5D" title="toRunes(s: openArray[char]): seq[Rune]">toRunes(s: openArray[char]): seq[Rune]</a></li>
    248. 

  248. <li><a class="reference" href="#toRunes%2Cstring" title="toRunes(s: string): seq[Rune]">toRunes(s: string): seq[Rune]</a></li>
    249. 

  249. 

  250. </ul>
    251. 

  251. <ul class="simple nested-toc-section">toTitle
    252. 

  252.   <li><a class="reference" href="#toTitle%2CRune" title="toTitle(c: Rune): Rune">toTitle(c: Rune): Rune</a></li>
    253. 

  253. 

  254. </ul>
    255. 

  255. <ul class="simple nested-toc-section">toUpper
    256. 

  256.   <li><a class="reference" href="#toUpper%2CRune" title="toUpper(c: Rune): Rune">toUpper(c: Rune): Rune</a></li>
    257. 

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

  258. <li><a class="reference" href="#toUpper%2Cstring" title="toUpper(s: string): string">toUpper(s: string): string</a></li>
    259. 

  259. 

  260. </ul>
    261. 

  261. <ul class="simple nested-toc-section">toUTF8
    262. 

  262.   <li><a class="reference" href="#toUTF8%2CRune" title="toUTF8(c: Rune): string">toUTF8(c: Rune): string</a></li>
    263. 

  263. 

  264. </ul>
    265. 

  265. <ul class="simple nested-toc-section">translate
    266. 

  266.   <li><a class="reference" href="#translate%2CopenArray%5Bchar%5D%2Cproc%28string%29" title="translate(s: openArray[char]; replacements: proc (key: string): string): string">translate(s: openArray[char]; replacements: proc (key: string): string): string</a></li>
    267. 

  267. <li><a class="reference" href="#translate%2Cstring%2Cproc%28string%29" title="translate(s: string; replacements: proc (key: string): string): string">translate(s: string; replacements: proc (key: string): string): string</a></li>
    268. 

  268. 

  269. </ul>
    270. 

  270. <ul class="simple nested-toc-section">validateUtf8
    271. 

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

  272. <li><a class="reference" href="#validateUtf8%2Cstring" title="validateUtf8(s: string): int">validateUtf8(s: string): int</a></li>
    273. 

  273. 

  274. </ul>
    275. 

  275. 

  276.     </ul>
    277. 

  277.   </details>
    278. 

  278. </li>
    279. 

  279. <li>
    280. 

  280.   <details open>
    281. 

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

  282.     <ul class="simple simple-toc-section">
    283. 

  283.       <ul class="simple nested-toc-section">runes
    284. 

  284.   <li><a class="reference" href="#runes.i%2CopenArray%5Bchar%5D" title="runes(s: openArray[char]): Rune">runes(s: openArray[char]): Rune</a></li>
    285. 

  285. <li><a class="reference" href="#runes.i%2Cstring" title="runes(s: string): Rune">runes(s: string): Rune</a></li>
    286. 

  286. 

  287. </ul>
    288. 

  288. <ul class="simple nested-toc-section">split
    289. 

  289.   <li><a class="reference" href="#split.i%2CopenArray%5Bchar%5D%2CRune%2Cint" title="split(s: openArray[char]; sep: Rune; maxsplit: int = -1): string">split(s: openArray[char]; sep: Rune; maxsplit: int = -1): string</a></li>
    290. 

  290. <li><a class="reference" href="#split.i%2CopenArray%5Bchar%5D%2CopenArray%5BRune%5D%2Cint" title="split(s: openArray[char]; seps: openArray[Rune] = unicodeSpaces;
    291. 

  291.       maxsplit: int = -1): string">split(s: openArray[char]; seps: openArray[Rune] = unicodeSpaces;
    292. 

  292.       maxsplit: int = -1): string</a></li>
    293. 

  293. <li><a class="reference" href="#split.i%2Cstring%2CRune%2Cint" title="split(s: string; sep: Rune; maxsplit: int = -1): string">split(s: string; sep: Rune; maxsplit: int = -1): string</a></li>
    294. 

  294. <li><a class="reference" href="#split.i%2Cstring%2CopenArray%5BRune%5D%2Cint" title="split(s: string; seps: openArray[Rune] = unicodeSpaces; maxsplit: int = -1): string">split(s: string; seps: openArray[Rune] = unicodeSpaces; maxsplit: int = -1): string</a></li>
    295. 

  295. 

  296. </ul>
    297. 

  297. <ul class="simple nested-toc-section">splitWhitespace
    298. 

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

  299. <li><a class="reference" href="#splitWhitespace.i%2Cstring" title="splitWhitespace(s: string): string">splitWhitespace(s: string): string</a></li>
    300. 

  300. 

  301. </ul>
    302. 

  302. <ul class="simple nested-toc-section">utf8
    303. 

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

  304. <li><a class="reference" href="#utf8.i%2Cstring" title="utf8(s: string): string">utf8(s: string): string</a></li>
    305. 

  305. 

  306. </ul>
    307. 

  307. 

  308.     </ul>
    309. 

  309.   </details>
    310. 

  310. </li>
    311. 

  311. <li>
    312. 

  312.   <details open>
    313. 

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

  314.     <ul class="simple simple-toc-section">
    315. 

  315.       <ul class="simple nested-toc-section">fastRuneAt
    316. 

  316.   <li><a class="reference" href="#fastRuneAt.t%2C%2Cint%2Cuntyped" title="fastRuneAt(s: openArray[char] or string; i: int; result: untyped; doInc = true)">fastRuneAt(s: openArray[char] or string; i: int; result: untyped; doInc = true)</a></li>
    317. 

  317. 

  318. </ul>
    319. 

  319. <ul class="simple nested-toc-section">fastToUTF8Copy
    320. 

  320.   <li><a class="reference" href="#fastToUTF8Copy.t%2CRune%2Cstring%2Cint" title="fastToUTF8Copy(c: Rune; s: var string; pos: int; doInc = true)">fastToUTF8Copy(c: Rune; s: var string; pos: int; doInc = true)</a></li>
    321. 

  321. 

  322. </ul>
    323. 

  323. 

  324.     </ul>
    325. 

  325.   </details>
    326. 

  326. </li>
    327. 

  327. 

  328. </ul>
    329. 

  329. 

  330.   </div>
    331. 

  331.   <div class="nine columns" id="content">
    332. 

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

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

  334. 

  335.     <div id="tocRoot"></div>
    336. 

  336.     
    337. 

  337.     <p class="module-desc"><p>This module provides support to handle the Unicode UTF-8 encoding.</p>
    338. 

  338. <p>There are no specialized <tt class="docutils literal"><span class="pre">insert</span></tt>, <tt class="docutils literal"><span class="pre">delete</span></tt>, <tt class="docutils literal"><span class="pre">add</span></tt> and <tt class="docutils literal"><span class="pre">contains</span></tt> procedures for <tt class="docutils literal"><span class="pre">seq[Rune]</span></tt> in this module because the generic variants of these procedures in the system module already work with it.</p>
    339. 

  339. <p>The current version is compatible with Unicode v12.0.0.</p>
    340. 

  340. <p><strong>See also:</strong></p>
    341. 

  341. <ul class="simple"><li><a class="reference external" href="strutils.html">strutils module</a></li>
    342. 

  342. <li><a class="reference external" href="unidecode.html">unidecode module</a></li>
    343. 

  343. <li><a class="reference external" href="encodings.html">encodings module</a></li>
    344. 

  344. </ul>
    345. 

  345. </p>
    346. 

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

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

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

  349.     <a class="reference external" href="strbasics.html">strbasics</a>
    350. 

  350.   </dl>
    351. 

  351. </div>
    352. 

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

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

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

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

  356.   <dt><pre><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">RuneImpl</span></pre></dt>
    357. 

  357.   <dd>
    358. 

  358.     
    359. 

  359.     <p>
    360. 

  360. Type that can hold a single Unicode code point.</p>
    361. 

  361. <p>A Rune may be composed with other Runes to a character on the screen. <tt class="docutils literal"><span class="pre"><span class="Identifier">RuneImpl</span></span></tt> is the underlying type used to store Runes, currently <tt class="docutils literal"><span class="pre"><span class="Identifier">int32</span></span></tt>.</p>
    362. 

  362. 

  363.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L37" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    364. 

  364. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L37" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    365. 

  365. 

  366.   </dd>
    367. 

  367. </div>
    368. 

  368. 

  369.   </dl>
    370. 

  370. </div>
    371. 

  371. <div class="section" id="12">
    372. 

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

  373.   <dl class="item">
    374. 

  374.     <div id="$-procs-all">
    375. 

  375.   <div id="$,Rune">
    376. 

  376.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CRune"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">rune</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    377. 

  377.   <dd>
    378. 

  378.     
    379. 

  379.     <p>An alias for <a class="reference external" href="#toUTF8,Rune">toUTF8</a>.</p>
    380. 

  380. <p>See also:</p>
    381. 

  381. <ul class="simple"><li><a class="reference external" href="#validateUtf8,string">validateUtf8 proc</a></li>
    382. 

  382. <li><a class="reference external" href="#fastToUTF8Copy.t,Rune,string,int">fastToUTF8Copy template</a></li>
    383. 

  383. </ul>
    384. 

  384. 

  385.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L290" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    386. 

  386. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L290" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    387. 

  387. 

  388.   </dd>
    389. 

  389. </div>
    390. 

  390. <div id="$,seq[Rune]">
    391. 

  391.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2Cseq%5BRune%5D"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">runes</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</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>
    392. 

  392.   <dd>
    393. 

  393.     
    394. 

  394.     <p>Converts a sequence of Runes to a string.</p>
    395. 

  395. <p>See also:</p>
    396. 

  396. <ul class="simple"><li><a class="reference external" href="#toRunes,string">toRunes</a> for a reverse operation</li>
    397. 

  397. </ul>
    398. 

  398. 

  399. <p><strong class="examples_text">Example:</strong></p>
    400. 

  400. <pre class="listing"><span class="Keyword">let</span>
    401. 

  401.   <span class="Identifier">someString</span> <span class="Operator">=</span> <span class="StringLit">&quot;öÑ&quot;</span>
    402. 

  402.   <span class="Identifier">someRunes</span> <span class="Operator">=</span> <span class="Identifier">toRunes</span><span class="Punctuation">(</span><span class="Identifier">someString</span><span class="Punctuation">)</span>
    403. 

  403. <span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">someRunes</span> <span class="Operator">==</span> <span class="Identifier">someString</span></pre>
    404. 

  404.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L298" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    405. 

  405. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L298" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    406. 

  406. 

  407.   </dd>
    408. 

  408. </div>
    409. 

  409. 

  410. </div>
    411. 

  411. <div id="&lt;%-procs-all">
    412. 

  412.   <div id="<%,Rune,Rune">
    413. 

  413.   <dt><pre><span class="Keyword">proc</span> <a href="#%3C%25%2CRune%2CRune"><span class="Identifier">`&lt;%`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    414. 

  414.   <dd>
    415. 

  415.     
    416. 

  416.     Checks if code point of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> is smaller than code point of <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>.
    417. 

  417. <p><strong class="examples_text">Example:</strong></p>
    418. 

  418. <pre class="listing"><span class="Keyword">let</span>
    419. 

  419.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;ú&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    420. 

  420.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="StringLit">&quot;ü&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    421. 

  421. <span class="Identifier">doAssert</span> <span class="Identifier">a</span> <span class="Operator">&lt;%</span> <span class="Identifier">b</span></pre>
    422. 

  422.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L451" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    423. 

  423. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L451" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    424. 

  424. 

  425.   </dd>
    426. 

  426. </div>
    427. 

  427. 

  428. </div>
    429. 

  429. <div id="&lt;=%-procs-all">
    430. 

  430.   <div id="<=%,Rune,Rune">
    431. 

  431.   <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%25%2CRune%2CRune"><span class="Identifier">`&lt;=%`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    432. 

  432.   <dd>
    433. 

  433.     
    434. 

  434.     Checks if code point of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> is smaller or equal to code point of <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>.
    435. 

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

  436. <pre class="listing"><span class="Keyword">let</span>
    437. 

  437.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;ú&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    438. 

  438.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="StringLit">&quot;ü&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    439. 

  439. <span class="Identifier">doAssert</span> <span class="Identifier">a</span> <span class="Operator">&lt;=%</span> <span class="Identifier">b</span></pre>
    440. 

  440.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L442" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    441. 

  441. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L442" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    442. 

  442. 

  443.   </dd>
    444. 

  444. </div>
    445. 

  445. 

  446. </div>
    447. 

  447. <div id="==-procs-all">
    448. 

  448.   <div id="==,Rune,Rune">
    449. 

  449.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CRune%2CRune"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    450. 

  450.   <dd>
    451. 

  451.     
    452. 

  452.     Checks if two runes are equal.
    453. 

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

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

  455. 

  456.   </dd>
    457. 

  457. </div>
    458. 

  458. 

  459. </div>
    460. 

  460. <div id="add-procs-all">
    461. 

  461.   <div id="add,string,Rune">
    462. 

  462.   <dt><pre><span class="Keyword">proc</span> <a href="#add%2Cstring%2CRune"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">s</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">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    463. 

  463.   <dd>
    464. 

  464.     
    465. 

  465.     Adds a rune <tt class="docutils literal"><span class="pre">c</span></tt> to a string <tt class="docutils literal"><span class="pre">s</span></tt>.
    466. 

  466. <p><strong class="examples_text">Example:</strong></p>
    467. 

  467. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">&quot;abc&quot;</span>
    468. 

  468. <span class="Keyword">let</span> <span class="Identifier">c</span> <span class="Operator">=</span> <span class="StringLit">&quot;ä&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    469. 

  469. <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">)</span>
    470. 

  470. <span class="Identifier">doAssert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="StringLit">&quot;abcä&quot;</span></pre>
    471. 

  471.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L279" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    472. 

  472. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L279" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    473. 

  473. 

  474.   </dd>
    475. 

  475. </div>
    476. 

  476. 

  477. </div>
    478. 

  478. <div id="align-procs-all">
    479. 

  479.   <div id="align,openArray[char],Natural">
    480. 

  480.   <dt><pre><span class="Keyword">proc</span> <a href="#align%2CopenArray%5Bchar%5D%2CNatural"><span class="Identifier">align</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">count</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">padding</span> <span class="Other">=</span> <span class="CharLit">' '</span><span class="Other">.</span><span class="Identifier">Rune</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    481. 

  481.     <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nucAlignString&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    482. 

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

  483.   <dd>
    484. 

  484.     
    485. 

  485.     <p>Aligns a unicode string <tt class="docutils literal"><span class="pre">s</span></tt> with <tt class="docutils literal"><span class="pre">padding</span></tt>, so that it has a rune-length of <tt class="docutils literal"><span class="pre">count</span></tt>.</p>
    486. 

  486. <p><tt class="docutils literal"><span class="pre">padding</span></tt> characters (by default spaces) are added before <tt class="docutils literal"><span class="pre">s</span></tt> resulting in right alignment. If <tt class="docutils literal"><span class="pre">s.runelen &gt;= count</span></tt>, no spaces are added and <tt class="docutils literal"><span class="pre">s</span></tt> is returned unchanged. If you need to left align a string use the <a class="reference external" href="#alignLeft,string,Natural">alignLeft proc</a>.</p>
    487. 

  487. 

  488. <p><strong class="examples_text">Example:</strong></p>
    489. 

  489. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot; abc&quot;</span>
    490. 

  490. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
    491. 

  491. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;  1232&quot;</span>
    492. 

  492. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="CharLit">'#'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;##1232&quot;</span>
    493. 

  493. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;Åge&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;  Åge&quot;</span>
    494. 

  494. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;×&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="CharLit">'_'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;___×&quot;</span></pre>
    495. 

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

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

  497. 

  498.   </dd>
    499. 

  499. </div>
    500. 

  500. <div id="align,string,Natural">
    501. 

  501.   <dt><pre><span class="Keyword">proc</span> <a href="#align%2Cstring%2CNatural"><span class="Identifier">align</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">count</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">padding</span> <span class="Other">=</span> <span class="CharLit">' '</span><span class="Other">.</span><span class="Identifier">Rune</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    502. 

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

  503.   <dd>
    504. 

  504.     
    505. 

  505.     <p>Aligns a unicode string <tt class="docutils literal"><span class="pre">s</span></tt> with <tt class="docutils literal"><span class="pre">padding</span></tt>, so that it has a rune-length of <tt class="docutils literal"><span class="pre">count</span></tt>.</p>
    506. 

  506. <p><tt class="docutils literal"><span class="pre">padding</span></tt> characters (by default spaces) are added before <tt class="docutils literal"><span class="pre">s</span></tt> resulting in right alignment. If <tt class="docutils literal"><span class="pre">s.runelen &gt;= count</span></tt>, no spaces are added and <tt class="docutils literal"><span class="pre">s</span></tt> is returned unchanged. If you need to left align a string use the <a class="reference external" href="#alignLeft,string,Natural">alignLeft proc</a>.</p>
    507. 

  507. 

  508. <p><strong class="examples_text">Example:</strong></p>
    509. 

  509. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot; abc&quot;</span>
    510. 

  510. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
    511. 

  511. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;  1232&quot;</span>
    512. 

  512. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="CharLit">'#'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;##1232&quot;</span>
    513. 

  513. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;Åge&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;  Åge&quot;</span>
    514. 

  514. <span class="Identifier">assert</span> <span class="Identifier">align</span><span class="Punctuation">(</span><span class="StringLit">&quot;×&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="CharLit">'_'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;___×&quot;</span></pre>
    515. 

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

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

  517. 

  518.   </dd>
    519. 

  519. </div>
    520. 

  520. 

  521. </div>
    522. 

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

  523.   <div id="alignLeft,openArray[char],Natural">
    524. 

  524.   <dt><pre><span class="Keyword">proc</span> <a href="#alignLeft%2CopenArray%5Bchar%5D%2CNatural"><span class="Identifier">alignLeft</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">count</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">padding</span> <span class="Other">=</span> <span class="CharLit">' '</span><span class="Other">.</span><span class="Identifier">Rune</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    525. 

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

  526.   <dd>
    527. 

  527.     
    528. 

  528.     <p>Left-aligns a unicode string <tt class="docutils literal"><span class="pre">s</span></tt> with <tt class="docutils literal"><span class="pre">padding</span></tt>, so that it has a rune-length of <tt class="docutils literal"><span class="pre">count</span></tt>.</p>
    529. 

  529. <p><tt class="docutils literal"><span class="pre">padding</span></tt> characters (by default spaces) are added after <tt class="docutils literal"><span class="pre">s</span></tt> resulting in left alignment. If <tt class="docutils literal"><span class="pre">s.runelen &gt;= count</span></tt>, no spaces are added and <tt class="docutils literal"><span class="pre">s</span></tt> is returned unchanged. If you need to right align a string use the <a class="reference external" href="#align,string,Natural">align proc</a>.</p>
    530. 

  530. 

  531. <p><strong class="examples_text">Example:</strong></p>
    532. 

  532. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;abc &quot;</span>
    533. 

  533. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
    534. 

  534. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1232  &quot;</span>
    535. 

  535. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="CharLit">'#'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1232##&quot;</span>
    536. 

  536. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;Åge&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Åge  &quot;</span>
    537. 

  537. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;×&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="CharLit">'_'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;×___&quot;</span></pre>
    538. 

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

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

  540. 

  541.   </dd>
    542. 

  542. </div>
    543. 

  543. <div id="alignLeft,string,Natural">
    544. 

  544.   <dt><pre><span class="Keyword">proc</span> <a href="#alignLeft%2Cstring%2CNatural"><span class="Identifier">alignLeft</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">count</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">padding</span> <span class="Other">=</span> <span class="CharLit">' '</span><span class="Other">.</span><span class="Identifier">Rune</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    545. 

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

  546.   <dd>
    547. 

  547.     
    548. 

  548.     <p>Left-aligns a unicode string <tt class="docutils literal"><span class="pre">s</span></tt> with <tt class="docutils literal"><span class="pre">padding</span></tt>, so that it has a rune-length of <tt class="docutils literal"><span class="pre">count</span></tt>.</p>
    549. 

  549. <p><tt class="docutils literal"><span class="pre">padding</span></tt> characters (by default spaces) are added after <tt class="docutils literal"><span class="pre">s</span></tt> resulting in left alignment. If <tt class="docutils literal"><span class="pre">s.runelen &gt;= count</span></tt>, no spaces are added and <tt class="docutils literal"><span class="pre">s</span></tt> is returned unchanged. If you need to right align a string use the <a class="reference external" href="#align,string,Natural">align proc</a>.</p>
    550. 

  550. 

  551. <p><strong class="examples_text">Example:</strong></p>
    552. 

  552. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;abc&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;abc &quot;</span>
    553. 

  553. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
    554. 

  554. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1232  &quot;</span>
    555. 

  555. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;1232&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="CharLit">'#'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1232##&quot;</span>
    556. 

  556. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;Åge&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Åge  &quot;</span>
    557. 

  557. <span class="Identifier">assert</span> <span class="Identifier">alignLeft</span><span class="Punctuation">(</span><span class="StringLit">&quot;×&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="CharLit">'_'</span><span class="Operator">.</span><span class="Identifier">Rune</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;×___&quot;</span></pre>
    558. 

  558.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1508" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    559. 

  559. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1508" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    560. 

  560. 

  561.   </dd>
    562. 

  562. </div>
    563. 

  563. 

  564. </div>
    565. 

  565. <div id="capitalize-procs-all">
    566. 

  566.   <div id="capitalize,openArray[char]">
    567. 

  567.   <dt><pre><span class="Keyword">proc</span> <a href="#capitalize%2CopenArray%5Bchar%5D"><span class="Identifier">capitalize</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    568. 

  568.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    569. 

  569.   <dd>
    570. 

  570.     
    571. 

  571.     Converts the first character of <tt class="docutils literal"><span class="pre">s</span></tt> into an upper-case rune.
    572. 

  572. <p><strong class="examples_text">Example:</strong></p>
    573. 

  573. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">capitalize</span><span class="Punctuation">(</span><span class="StringLit">&quot;βeta&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Βeta&quot;</span></pre>
    574. 

  574.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L712" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    575. 

  575. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L712" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    576. 

  576. 

  577.   </dd>
    578. 

  578. </div>
    579. 

  579. <div id="capitalize,string">
    580. 

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

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

  582.   <dd>
    583. 

  583.     
    584. 

  584.     Converts the first character of <tt class="docutils literal"><span class="pre">s</span></tt> into an upper-case rune.
    585. 

  585. <p><strong class="examples_text">Example:</strong></p>
    586. 

  586. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">capitalize</span><span class="Punctuation">(</span><span class="StringLit">&quot;βeta&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Βeta&quot;</span></pre>
    587. 

  587.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1324" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    588. 

  588. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1324" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    589. 

  589. 

  590.   </dd>
    591. 

  591. </div>
    592. 

  592. 

  593. </div>
    594. 

  594. <div id="cmpRunesIgnoreCase-procs-all">
    595. 

  595.   <div id="cmpRunesIgnoreCase,openArray[char],openArray[char]">
    596. 

  596.   <dt><pre><span class="Keyword">proc</span> <a href="#cmpRunesIgnoreCase%2CopenArray%5Bchar%5D%2CopenArray%5Bchar%5D"><span class="Identifier">cmpRunesIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span>
    597. 

  597.     <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>
    598. 

  598.   <dd>
    599. 

  599.     
    600. 

  600.     Compares two UTF-8 strings and ignores the case. Returns:<p><tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt> if a == b<br/><tt class="docutils literal"><span class="pre"><span class="Operator">&lt;</span> <span class="DecNumber">0</span></span></tt> if a &lt; b<br/><tt class="docutils literal"><span class="pre"><span class="Operator">&gt;</span> <span class="DecNumber">0</span></span></tt> if a &gt; b<br/></p>
    601. 

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

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

  603. 

  604.   </dd>
    605. 

  605. </div>
    606. 

  606. <div id="cmpRunesIgnoreCase,string,string">
    607. 

  607.   <dt><pre><span class="Keyword">proc</span> <a href="#cmpRunesIgnoreCase%2Cstring%2Cstring"><span class="Identifier">cmpRunesIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#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 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>
    608. 

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

  609.   <dd>
    610. 

  610.     
    611. 

  611.     Compares two UTF-8 strings and ignores the case. Returns:<p><tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt> if a == b<br/><tt class="docutils literal"><span class="pre"><span class="Operator">&lt;</span> <span class="DecNumber">0</span></span></tt> if a &lt; b<br/><tt class="docutils literal"><span class="pre"><span class="Operator">&gt;</span> <span class="DecNumber">0</span></span></tt> if a &gt; b<br/></p>
    612. 

  612.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1383" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    613. 

  613. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1383" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    614. 

  614. 

  615.   </dd>
    616. 

  616. </div>
    617. 

  617. 

  618. </div>
    619. 

  619. <div id="graphemeLen-procs-all">
    620. 

  620.   <div id="graphemeLen,openArray[char],Natural">
    621. 

  621.   <dt><pre><span class="Keyword">proc</span> <a href="#graphemeLen%2CopenArray%5Bchar%5D%2CNatural"><span class="Identifier">graphemeLen</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">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</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>
    622. 

  622.     <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>
    623. 

  623.   <dd>
    624. 

  624.     
    625. 

  625.     The number of bytes belonging to byte index <tt class="docutils literal"><span class="pre">s[i]</span></tt>, including following combining code units.
    626. 

  626. <p><strong class="examples_text">Example:</strong></p>
    627. 

  627. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    628. 

  628. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">graphemeLen</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment">## ñ</span>
    629. 

  629. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">graphemeLen</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    630. 

  630. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">graphemeLen</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment">## ó</span></pre>
    631. 

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

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

  633. 

  634.   </dd>
    635. 

  635. </div>
    636. 

  636. <div id="graphemeLen,string,Natural">
    637. 

  637.   <dt><pre><span class="Keyword">proc</span> <a href="#graphemeLen%2Cstring%2CNatural"><span class="Identifier">graphemeLen</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">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</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>
    638. 

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

  639.   <dd>
    640. 

  640.     
    641. 

  641.     The number of bytes belonging to byte index <tt class="docutils literal"><span class="pre">s[i]</span></tt>, including following combining code unit.
    642. 

  642. <p><strong class="examples_text">Example:</strong></p>
    643. 

  643. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    644. 

  644. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">graphemeLen</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment">## ñ</span>
    645. 

  645. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">graphemeLen</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    646. 

  646. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">graphemeLen</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment">## ó</span></pre>
    647. 

  647.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1402" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    648. 

  648. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1402" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    649. 

  649. 

  650.   </dd>
    651. 

  651. </div>
    652. 

  652. 

  653. </div>
    654. 

  654. <div id="isAlpha-procs-all">
    655. 

  655.   <div id="isAlpha,Rune">
    656. 

  656.   <dt><pre><span class="Keyword">proc</span> <a href="#isAlpha%2CRune"><span class="Identifier">isAlpha</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    657. 

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

  658.   <dd>
    659. 

  659.     
    660. 

  660.     <p>Returns true if <tt class="docutils literal"><span class="pre">c</span></tt> is an <em>alpha</em> rune (i.e., a letter).</p>
    661. 

  661. <p>See also:</p>
    662. 

  662. <ul class="simple"><li><a class="reference external" href="#isLower,Rune">isLower proc</a></li>
    663. 

  663. <li><a class="reference external" href="#isTitle,Rune">isTitle proc</a></li>
    664. 

  664. <li><a class="reference external" href="#isAlpha,Rune">isAlpha proc</a></li>
    665. 

  665. <li><a class="reference external" href="#isWhiteSpace,Rune">isWhiteSpace proc</a></li>
    666. 

  666. <li><a class="reference external" href="#isCombining,Rune">isCombining proc</a></li>
    667. 

  667. </ul>
    668. 

  668. 

  669.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L573" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    670. 

  670. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L573" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    671. 

  671. 

  672.   </dd>
    673. 

  673. </div>
    674. 

  674. <div id="isAlpha,openArray[char]">
    675. 

  675.   <dt><pre><span class="Keyword">proc</span> <a href="#isAlpha%2CopenArray%5Bchar%5D"><span class="Identifier">isAlpha</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#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    676. 

  676.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1Str&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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>
    677. 

  677.   <dd>
    678. 

  678.     
    679. 

  679.     Returns true if <tt class="docutils literal"><span class="pre">s</span></tt> contains all alphabetic runes.
    680. 

  680. <p><strong class="examples_text">Example:</strong></p>
    681. 

  681. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    682. 

  682. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">isAlpha</span></pre>
    683. 

  683.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L647" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    684. 

  684. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L647" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    685. 

  685. 

  686.   </dd>
    687. 

  687. </div>
    688. 

  688. <div id="isAlpha,string">
    689. 

  689.   <dt><pre><span class="Keyword">proc</span> <a href="#isAlpha%2Cstring"><span class="Identifier">isAlpha</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    690. 

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

  691.   <dd>
    692. 

  692.     
    693. 

  693.     Returns true if <tt class="docutils literal"><span class="pre">s</span></tt> contains all alphabetic runes.
    694. 

  694. <p><strong class="examples_text">Example:</strong></p>
    695. 

  695. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    696. 

  696. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">isAlpha</span></pre>
    697. 

  697.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1288" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    698. 

  698. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1288" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    699. 

  699. 

  700.   </dd>
    701. 

  701. </div>
    702. 

  702. 

  703. </div>
    704. 

  704. <div id="isCombining-procs-all">
    705. 

  705.   <div id="isCombining,Rune">
    706. 

  706.   <dt><pre><span class="Keyword">proc</span> <a href="#isCombining%2CRune"><span class="Identifier">isCombining</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    707. 

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

  708.   <dd>
    709. 

  709.     
    710. 

  710.     <p>Returns true if <tt class="docutils literal"><span class="pre">c</span></tt> is a Unicode combining code unit.</p>
    711. 

  711. <p>See also:</p>
    712. 

  712. <ul class="simple"><li><a class="reference external" href="#isLower,Rune">isLower proc</a></li>
    713. 

  713. <li><a class="reference external" href="#isUpper,Rune">isUpper proc</a></li>
    714. 

  714. <li><a class="reference external" href="#isTitle,Rune">isTitle proc</a></li>
    715. 

  715. <li><a class="reference external" href="#isAlpha,Rune">isAlpha proc</a></li>
    716. 

  716. </ul>
    717. 

  717. 

  718.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L620" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    719. 

  719. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L620" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    720. 

  720. 

  721.   </dd>
    722. 

  722. </div>
    723. 

  723. 

  724. </div>
    725. 

  725. <div id="isLower-procs-all">
    726. 

  726.   <div id="isLower,Rune">
    727. 

  727.   <dt><pre><span class="Keyword">proc</span> <a href="#isLower%2CRune"><span class="Identifier">isLower</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    728. 

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

  729.   <dd>
    730. 

  730.     
    731. 

  731.     <p>Returns true if <tt class="docutils literal"><span class="pre">c</span></tt> is a lower case rune.</p>
    732. 

  732. <p>If possible, prefer <tt class="docutils literal"><span class="pre">isLower</span></tt> over <tt class="docutils literal"><span class="pre">isUpper</span></tt>.</p>
    733. 

  733. <p>See also:</p>
    734. 

  734. <ul class="simple"><li><a class="reference external" href="#toLower,Rune">toLower proc</a></li>
    735. 

  735. <li><a class="reference external" href="#isUpper,Rune">isUpper proc</a></li>
    736. 

  736. <li><a class="reference external" href="#isTitle,Rune">isTitle proc</a></li>
    737. 

  737. </ul>
    738. 

  738. 

  739.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L531" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    740. 

  740. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L531" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    741. 

  741. 

  742.   </dd>
    743. 

  743. </div>
    744. 

  744. 

  745. </div>
    746. 

  746. <div id="isSpace-procs-all">
    747. 

  747.   <div id="isSpace,openArray[char]">
    748. 

  748.   <dt><pre><span class="Keyword">proc</span> <a href="#isSpace%2CopenArray%5Bchar%5D"><span class="Identifier">isSpace</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#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    749. 

  749.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1Str&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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>
    750. 

  750.   <dd>
    751. 

  751.     
    752. 

  752.     Returns true if <tt class="docutils literal"><span class="pre">s</span></tt> contains all whitespace runes.
    753. 

  753. <p><strong class="examples_text">Example:</strong></p>
    754. 

  754. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="EscapeSequence">\l</span><span class="StringLit"> </span><span class="EscapeSequence">\v</span><span class="EscapeSequence">\r</span><span class="EscapeSequence">\f</span><span class="StringLit">&quot;</span>
    755. 

  755. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">isSpace</span></pre>
    756. 

  756.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L655" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    757. 

  757. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L655" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    758. 

  758. 

  759.   </dd>
    760. 

  760. </div>
    761. 

  761. <div id="isSpace,string">
    762. 

  762.   <dt><pre><span class="Keyword">proc</span> <a href="#isSpace%2Cstring"><span class="Identifier">isSpace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    763. 

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

  764.   <dd>
    765. 

  765.     
    766. 

  766.     Returns true if <tt class="docutils literal"><span class="pre">s</span></tt> contains all whitespace runes.
    767. 

  767. <p><strong class="examples_text">Example:</strong></p>
    768. 

  768. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="EscapeSequence">\l</span><span class="StringLit"> </span><span class="EscapeSequence">\v</span><span class="EscapeSequence">\r</span><span class="EscapeSequence">\f</span><span class="StringLit">&quot;</span>
    769. 

  769. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">isSpace</span></pre>
    770. 

  770.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1295" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    771. 

  771. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1295" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    772. 

  772. 

  773.   </dd>
    774. 

  774. </div>
    775. 

  775. 

  776. </div>
    777. 

  777. <div id="isTitle-procs-all">
    778. 

  778.   <div id="isTitle,Rune">
    779. 

  779.   <dt><pre><span class="Keyword">proc</span> <a href="#isTitle%2CRune"><span class="Identifier">isTitle</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    780. 

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

  781.   <dd>
    782. 

  782.     
    783. 

  783.     <p>Returns true if <tt class="docutils literal"><span class="pre">c</span></tt> is a Unicode titlecase code point.</p>
    784. 

  784. <p>See also:</p>
    785. 

  785. <ul class="simple"><li><a class="reference external" href="#toTitle,Rune">toTitle proc</a></li>
    786. 

  786. <li><a class="reference external" href="#isLower,Rune">isLower proc</a></li>
    787. 

  787. <li><a class="reference external" href="#isUpper,Rune">isUpper proc</a></li>
    788. 

  788. <li><a class="reference external" href="#isAlpha,Rune">isAlpha proc</a></li>
    789. 

  789. <li><a class="reference external" href="#isWhiteSpace,Rune">isWhiteSpace proc</a></li>
    790. 

  790. </ul>
    791. 

  791. 

  792.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L594" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    793. 

  793. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L594" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    794. 

  794. 

  795.   </dd>
    796. 

  796. </div>
    797. 

  797. 

  798. </div>
    799. 

  799. <div id="isUpper-procs-all">
    800. 

  800.   <div id="isUpper,Rune">
    801. 

  801.   <dt><pre><span class="Keyword">proc</span> <a href="#isUpper%2CRune"><span class="Identifier">isUpper</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    802. 

  802.                               <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.     <p>Returns true if <tt class="docutils literal"><span class="pre">c</span></tt> is a upper case rune.</p>
    806. 

  806. <p>If possible, prefer <tt class="docutils literal"><span class="pre">isLower</span></tt> over <tt class="docutils literal"><span class="pre">isUpper</span></tt>.</p>
    807. 

  807. <p>See also:</p>
    808. 

  808. <ul class="simple"><li><a class="reference external" href="#toUpper,Rune">toUpper proc</a></li>
    809. 

  809. <li><a class="reference external" href="#isLower,Rune">isLower proc</a></li>
    810. 

  810. <li><a class="reference external" href="#isTitle,Rune">isTitle proc</a></li>
    811. 

  811. <li><a class="reference external" href="#isAlpha,Rune">isAlpha proc</a></li>
    812. 

  812. <li><a class="reference external" href="#isWhiteSpace,Rune">isWhiteSpace proc</a></li>
    813. 

  813. </ul>
    814. 

  814. 

  815.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L551" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    816. 

  816. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L551" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    817. 

  817. 

  818.   </dd>
    819. 

  819. </div>
    820. 

  820. 

  821. </div>
    822. 

  822. <div id="isWhiteSpace-procs-all">
    823. 

  823.   <div id="isWhiteSpace,Rune">
    824. 

  824.   <dt><pre><span class="Keyword">proc</span> <a href="#isWhiteSpace%2CRune"><span class="Identifier">isWhiteSpace</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    825. 

  825.                                    <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>
    826. 

  826.   <dd>
    827. 

  827.     
    828. 

  828.     <p>Returns true if <tt class="docutils literal"><span class="pre">c</span></tt> is a Unicode whitespace code point.</p>
    829. 

  829. <p>See also:</p>
    830. 

  830. <ul class="simple"><li><a class="reference external" href="#isLower,Rune">isLower proc</a></li>
    831. 

  831. <li><a class="reference external" href="#isUpper,Rune">isUpper proc</a></li>
    832. 

  832. <li><a class="reference external" href="#isTitle,Rune">isTitle proc</a></li>
    833. 

  833. <li><a class="reference external" href="#isAlpha,Rune">isAlpha proc</a></li>
    834. 

  834. </ul>
    835. 

  835. 

  836.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L605" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    837. 

  837. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L605" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    838. 

  838. 

  839.   </dd>
    840. 

  840. </div>
    841. 

  841. 

  842. </div>
    843. 

  843. <div id="lastRune-procs-all">
    844. 

  844.   <div id="lastRune,openArray[char],int">
    845. 

  845.   <dt><pre><span class="Keyword">proc</span> <a href="#lastRune%2CopenArray%5Bchar%5D%2Cint"><span class="Identifier">lastRune</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">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    846. 

  846.     <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>
    847. 

  847.   <dd>
    848. 

  848.     
    849. 

  849.     Length of the last rune in <tt class="docutils literal"><span class="pre">s[0..last]</span></tt>. Returns the rune and its length in bytes.
    850. 

  850.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L920" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    851. 

  851. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L920" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    852. 

  852. 

  853.   </dd>
    854. 

  854. </div>
    855. 

  855. <div id="lastRune,string,int">
    856. 

  856.   <dt><pre><span class="Keyword">proc</span> <a href="#lastRune%2Cstring%2Cint"><span class="Identifier">lastRune</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">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    857. 

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

  858.   <dd>
    859. 

  859.     
    860. 

  860.     Length of the last rune in <tt class="docutils literal"><span class="pre">s[0..last]</span></tt>. Returns the rune and its length in bytes.
    861. 

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

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

  863. 

  864.   </dd>
    865. 

  865. </div>
    866. 

  866. 

  867. </div>
    868. 

  868. <div id="repeat-procs-all">
    869. 

  869.   <div id="repeat,Rune,Natural">
    870. 

  870.   <dt><pre><span class="Keyword">proc</span> <a href="#repeat%2CRune%2CNatural"><span class="Identifier">repeat</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">;</span> <span class="Identifier">count</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    871. 

  871.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nucRepeatRune&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    872. 

  872.   <dd>
    873. 

  873.     
    874. 

  874.     <p>Returns a string of <tt class="docutils literal"><span class="pre">count</span></tt> Runes <tt class="docutils literal"><span class="pre">c</span></tt>.</p>
    875. 

  875. <p>The returned string will have a rune-length of <tt class="docutils literal"><span class="pre">count</span></tt>.</p>
    876. 

  876. 

  877. <p><strong class="examples_text">Example:</strong></p>
    878. 

  878. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;ñ&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    879. 

  879. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">repeat</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ñññññ&quot;</span></pre>
    880. 

  880.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1097" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    881. 

  881. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1097" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    882. 

  882. 

  883.   </dd>
    884. 

  884. </div>
    885. 

  885. 

  886. </div>
    887. 

  887. <div id="reversed-procs-all">
    888. 

  888.   <div id="reversed,openArray[char]">
    889. 

  889.   <dt><pre><span class="Keyword">proc</span> <a href="#reversed%2CopenArray%5Bchar%5D"><span class="Identifier">reversed</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>
    890. 

  890.   <dd>
    891. 

  891.     
    892. 

  892.     <p>Returns the reverse of <tt class="docutils literal"><span class="pre">s</span></tt>, interpreting it as runes.</p>
    893. 

  893. <p>Unicode combining characters are correctly interpreted as well.</p>
    894. 

  894. 

  895. <p><strong class="examples_text">Example:</strong></p>
    896. 

  896. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;Reverse this!&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;!siht esreveR&quot;</span>
    897. 

  897. <span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;先秦兩漢&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;漢兩秦先&quot;</span>
    898. 

  898. <span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;as⃝df̅&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;f̅ds⃝a&quot;</span>
    899. 

  899. <span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;a⃞b⃞c⃞&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;c⃞b⃞a⃞&quot;</span></pre>
    900. 

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

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

  902. 

  903.   </dd>
    904. 

  904. </div>
    905. 

  905. <div id="reversed,string">
    906. 

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

  907.   <dd>
    908. 

  908.     
    909. 

  909.     <p>Returns the reverse of <tt class="docutils literal"><span class="pre">s</span></tt>, interpreting it as runes.</p>
    910. 

  910. <p>Unicode combining characters are correctly interpreted as well.</p>
    911. 

  911. 

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

  913. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;Reverse this!&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;!siht esreveR&quot;</span>
    914. 

  914. <span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;先秦兩漢&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;漢兩秦先&quot;</span>
    915. 

  915. <span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;as⃝df̅&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;f̅ds⃝a&quot;</span>
    916. 

  916. <span class="Identifier">assert</span> <span class="Identifier">reversed</span><span class="Punctuation">(</span><span class="StringLit">&quot;a⃞b⃞c⃞&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;c⃞b⃞a⃞&quot;</span></pre>
    917. 

  917.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1391" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    918. 

  918. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1391" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    919. 

  919. 

  920.   </dd>
    921. 

  921. </div>
    922. 

  922. 

  923. </div>
    924. 

  924. <div id="runeAt-procs-all">
    925. 

  925.   <div id="runeAt,openArray[char],Natural">
    926. 

  926.   <dt><pre><span class="Keyword">proc</span> <a href="#runeAt%2CopenArray%5Bchar%5D%2CNatural"><span class="Identifier">runeAt</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">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</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>
    927. 

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

  928.   <dd>
    929. 

  929.     
    930. 

  930.     <p>Returns the rune in <tt class="docutils literal"><span class="pre">s</span></tt> at <strong>byte index</strong> <tt class="docutils literal"><span class="pre">i</span></tt>.</p>
    931. 

  931. <p>See also:</p>
    932. 

  932. <ul class="simple"><li><a class="reference external" href="#runeAtPos,string,int">runeAtPos proc</a></li>
    933. 

  933. <li><a class="reference external" href="#runeStrAtPos,string,Natural">runeStrAtPos proc</a></li>
    934. 

  934. <li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    935. 

  935. </ul>
    936. 

  936. 

  937. <p><strong class="examples_text">Example:</strong></p>
    938. 

  938. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    939. 

  939. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ñ&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    940. 

  940. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ñ&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
    941. 

  941. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;y&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span></pre>
    942. 

  942.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L162" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    943. 

  943. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L162" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    944. 

  944. 

  945.   </dd>
    946. 

  946. </div>
    947. 

  947. <div id="runeAt,string,Natural">
    948. 

  948.   <dt><pre><span class="Keyword">proc</span> <a href="#runeAt%2Cstring%2CNatural"><span class="Identifier">runeAt</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">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</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>
    949. 

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

  950.   <dd>
    951. 

  951.     
    952. 

  952.     <p>Returns the rune in <tt class="docutils literal"><span class="pre">s</span></tt> at <strong>byte index</strong> <tt class="docutils literal"><span class="pre">i</span></tt>.</p>
    953. 

  953. <p>See also:</p>
    954. 

  954. <ul class="simple"><li><a class="reference external" href="#runeAtPos,string,int">runeAtPos proc</a></li>
    955. 

  955. <li><a class="reference external" href="#runeStrAtPos,string,Natural">runeStrAtPos proc</a></li>
    956. 

  956. <li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    957. 

  957. </ul>
    958. 

  958. 

  959. <p><strong class="examples_text">Example:</strong></p>
    960. 

  960. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    961. 

  961. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ñ&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    962. 

  962. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ñ&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
    963. 

  963. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;y&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span></pre>
    964. 

  964.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1184" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    965. 

  965. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1184" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    966. 

  966. 

  967.   </dd>
    968. 

  968. </div>
    969. 

  969. 

  970. </div>
    971. 

  971. <div id="runeAtPos-procs-all">
    972. 

  972.   <div id="runeAtPos,openArray[char],int">
    973. 

  973.   <dt><pre><span class="Keyword">proc</span> <a href="#runeAtPos%2CopenArray%5Bchar%5D%2Cint"><span class="Identifier">runeAtPos</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">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</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>
    974. 

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

  975.   <dd>
    976. 

  976.     
    977. 

  977.     <p>Returns the rune at position <tt class="docutils literal"><span class="pre">pos</span></tt>.</p>
    978. 

  978. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    979. 

  979. <p>See also:</p>
    980. 

  980. <ul class="simple"><li><a class="reference external" href="#runeAt,string,Natural">runeAt proc</a></li>
    981. 

  981. <li><a class="reference external" href="#runeStrAtPos,string,Natural">runeStrAtPos proc</a></li>
    982. 

  982. <li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    983. 

  983. </ul>
    984. 

  984. 

  985.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L368" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    986. 

  986. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L368" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    987. 

  987. 

  988.   </dd>
    989. 

  989. </div>
    990. 

  990. <div id="runeAtPos,string,int">
    991. 

  991.   <dt><pre><span class="Keyword">proc</span> <a href="#runeAtPos%2Cstring%2Cint"><span class="Identifier">runeAtPos</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">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</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>
    992. 

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

  993.   <dd>
    994. 

  994.     
    995. 

  995.     <p>Returns the rune at position <tt class="docutils literal"><span class="pre">pos</span></tt>.</p>
    996. 

  996. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    997. 

  997. <p>See also:</p>
    998. 

  998. <ul class="simple"><li><a class="reference external" href="#runeAt,string,Natural">runeAt proc</a></li>
    999. 

  999. <li><a class="reference external" href="#runeStrAtPos,string,Natural">runeStrAtPos proc</a></li>
    1000. 

  1000. <li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    1001. 

  1001. </ul>
    1002. 

  1002. 

  1003.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1243" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1004. 

  1004. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1243" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1005. 

  1005. 

  1006.   </dd>
    1007. 

  1007. </div>
    1008. 

  1008. 

  1009. </div>
    1010. 

  1010. <div id="runeLen-procs-all">
    1011. 

  1011.   <div id="runeLen,openArray[char]">
    1012. 

  1012.   <dt><pre><span class="Keyword">proc</span> <a href="#runeLen%2CopenArray%5Bchar%5D"><span class="Identifier">runeLen</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><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;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1013. 

  1013.                                         <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>
    1014. 

  1014.   <dd>
    1015. 

  1015.     
    1016. 

  1016.     Returns the number of runes of the string <tt class="docutils literal"><span class="pre">s</span></tt>.
    1017. 

  1017. <p><strong class="examples_text">Example:</strong></p>
    1018. 

  1018. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1019. 

  1019. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeLen</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    1020. 

  1020. <span class="Comment">## note: a.len == 8</span></pre>
    1021. 

  1021.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L45" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1022. 

  1022. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L45" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1023. 

  1023. 

  1024.   </dd>
    1025. 

  1025. </div>
    1026. 

  1026. <div id="runeLen,string">
    1027. 

  1027.   <dt><pre><span class="Keyword">proc</span> <a href="#runeLen%2Cstring"><span class="Identifier">runeLen</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1028. 

  1028.   <dd>
    1029. 

  1029.     
    1030. 

  1030.     Returns the number of runes of the string <tt class="docutils literal"><span class="pre">s</span></tt>.
    1031. 

  1031. <p><strong class="examples_text">Example:</strong></p>
    1032. 

  1032. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1033. 

  1033. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeLen</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
    1034. 

  1034. <span class="Comment">## note: a.len == 8</span></pre>
    1035. 

  1035.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1165" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1036. 

  1036. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1165" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1037. 

  1037. 

  1038.   </dd>
    1039. 

  1039. </div>
    1040. 

  1040. 

  1041. </div>
    1042. 

  1042. <div id="runeLenAt-procs-all">
    1043. 

  1043.   <div id="runeLenAt,openArray[char],Natural">
    1044. 

  1044.   <dt><pre><span class="Keyword">proc</span> <a href="#runeLenAt%2CopenArray%5Bchar%5D%2CNatural"><span class="Identifier">runeLenAt</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">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</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>
    1045. 

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

  1046.   <dd>
    1047. 

  1047.     
    1048. 

  1048.     <p>Returns the number of bytes the rune starting at <tt class="docutils literal"><span class="pre">s[i]</span></tt> takes.</p>
    1049. 

  1049. <p>See also:</p>
    1050. 

  1050. <ul class="simple"><li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    1051. 

  1051. </ul>
    1052. 

  1052. 

  1053. <p><strong class="examples_text">Example:</strong></p>
    1054. 

  1054. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1055. 

  1055. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeLenAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1056. 

  1056. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeLenAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    1057. 

  1057.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L64" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1058. 

  1058. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L64" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1059. 

  1059. 

  1060.   </dd>
    1061. 

  1061. </div>
    1062. 

  1062. <div id="runeLenAt,string,Natural">
    1063. 

  1063.   <dt><pre><span class="Keyword">proc</span> <a href="#runeLenAt%2Cstring%2CNatural"><span class="Identifier">runeLenAt</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">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1064. 

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

  1065.   <dd>
    1066. 

  1066.     
    1067. 

  1067.     <p>Returns the number of bytes the rune starting at <tt class="docutils literal"><span class="pre">s[i]</span></tt> takes.</p>
    1068. 

  1068. <p>See also:</p>
    1069. 

  1069. <ul class="simple"><li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    1070. 

  1070. </ul>
    1071. 

  1071. 

  1072. <p><strong class="examples_text">Example:</strong></p>
    1073. 

  1073. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1074. 

  1074. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeLenAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1075. 

  1075. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeLenAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    1076. 

  1076.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1173" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1077. 

  1077. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1173" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1078. 

  1078. 

  1079.   </dd>
    1080. 

  1080. </div>
    1081. 

  1081. 

  1082. </div>
    1083. 

  1083. <div id="runeOffset-procs-all">
    1084. 

  1084.   <div id="runeOffset,openArray[char],Natural,Natural">
    1085. 

  1085.   <dt><pre><span class="Keyword">proc</span> <a href="#runeOffset%2CopenArray%5Bchar%5D%2CNatural%2CNatural"><span class="Identifier">runeOffset</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">pos</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a> <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> {.
    1086. 

  1086.     <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>
    1087. 

  1087.   <dd>
    1088. 

  1088.     
    1089. 

  1089.     <p>Returns the byte position of rune at position <tt class="docutils literal"><span class="pre">pos</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt> with an optional start byte position. Returns the special value -1 if it runs out of the string.</p>
    1090. 

  1090. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    1091. 

  1091. <p>See also:</p>
    1092. 

  1092. <ul class="simple"><li><a class="reference external" href="#runeReverseOffset,string,Positive">runeReverseOffset proc</a></li>
    1093. 

  1093. </ul>
    1094. 

  1094. 

  1095. <p><strong class="examples_text">Example:</strong></p>
    1096. 

  1096. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1097. 

  1097. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeOffset</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1098. 

  1098. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeOffset</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1099. 

  1099. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeOffset</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span></pre>
    1100. 

  1100.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L313" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1101. 

  1101. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L313" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1102. 

  1102. 

  1103.   </dd>
    1104. 

  1104. </div>
    1105. 

  1105. <div id="runeOffset,string,Natural,Natural">
    1106. 

  1106.   <dt><pre><span class="Keyword">proc</span> <a href="#runeOffset%2Cstring%2CNatural%2CNatural"><span class="Identifier">runeOffset</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">pos</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a> <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>
    1107. 

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

  1108.   <dd>
    1109. 

  1109.     
    1110. 

  1110.     <p>Returns the byte position of rune at position <tt class="docutils literal"><span class="pre">pos</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt> with an optional start byte position. Returns the special value -1 if it runs out of the string.</p>
    1111. 

  1111. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    1112. 

  1112. <p>See also:</p>
    1113. 

  1113. <ul class="simple"><li><a class="reference external" href="#runeReverseOffset,string,Positive">runeReverseOffset proc</a></li>
    1114. 

  1114. </ul>
    1115. 

  1115. 

  1116. <p><strong class="examples_text">Example:</strong></p>
    1117. 

  1117. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1118. 

  1118. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeOffset</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1119. 

  1119. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeOffset</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1120. 

  1120. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeOffset</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span></pre>
    1121. 

  1121.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1208" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1122. 

  1122. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1208" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1123. 

  1123. 

  1124.   </dd>
    1125. 

  1125. </div>
    1126. 

  1126. 

  1127. </div>
    1128. 

  1128. <div id="runeReverseOffset-procs-all">
    1129. 

  1129.   <div id="runeReverseOffset,openArray[char],Positive">
    1130. 

  1130.   <dt><pre><span class="Keyword">proc</span> <a href="#runeReverseOffset%2CopenArray%5Bchar%5D%2CPositive"><span class="Identifier">runeReverseOffset</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">rev</span><span class="Other">:</span> <a href="system.html#Positive"><span class="Identifier">Positive</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="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.
    1131. 

  1131.     <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>
    1132. 

  1132.   <dd>
    1133. 

  1133.     
    1134. 

  1134.     <p>Returns a tuple with the byte offset of the rune at position <tt class="docutils literal"><span class="pre">rev</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt>, counting from the end (starting with 1) and the total number of runes in the string.</p>
    1135. 

  1135. <p>Returns a negative value for offset if there are too few runes in the string to satisfy the request.</p>
    1136. 

  1136. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    1137. 

  1137. <p>See also:</p>
    1138. 

  1138. <ul class="simple"><li><a class="reference external" href="#runeOffset,string,Natural,Natural">runeOffset proc</a></li>
    1139. 

  1139. </ul>
    1140. 

  1140. 

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

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

  1143. 

  1144.   </dd>
    1145. 

  1145. </div>
    1146. 

  1146. <div id="runeReverseOffset,string,Positive">
    1147. 

  1147.   <dt><pre><span class="Keyword">proc</span> <a href="#runeReverseOffset%2Cstring%2CPositive"><span class="Identifier">runeReverseOffset</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">rev</span><span class="Other">:</span> <a href="system.html#Positive"><span class="Identifier">Positive</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="Other">,</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    1148. 

  1148.     <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>
    1149. 

  1149.   <dd>
    1150. 

  1150.     
    1151. 

  1151.     <p>Returns a tuple with the byte offset of the rune at position <tt class="docutils literal"><span class="pre">rev</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt>, counting from the end (starting with 1) and the total number of runes in the string.</p>
    1152. 

  1152. <p>Returns a negative value for offset if there are too few runes in the string to satisfy the request.</p>
    1153. 

  1153. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    1154. 

  1154. <p>See also:</p>
    1155. 

  1155. <ul class="simple"><li><a class="reference external" href="#runeOffset,string,Natural,Natural">runeOffset proc</a></li>
    1156. 

  1156. </ul>
    1157. 

  1157. 

  1158.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1226" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1159. 

  1159. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1226" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1160. 

  1160. 

  1161.   </dd>
    1162. 

  1162. </div>
    1163. 

  1163. 

  1164. </div>
    1165. 

  1165. <div id="runeStrAtPos-procs-all">
    1166. 

  1166.   <div id="runeStrAtPos,openArray[char],Natural">
    1167. 

  1167.   <dt><pre><span class="Keyword">proc</span> <a href="#runeStrAtPos%2CopenArray%5Bchar%5D%2CNatural"><span class="Identifier">runeStrAtPos</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">pos</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1168. 

  1168.     <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>
    1169. 

  1169.   <dd>
    1170. 

  1170.     
    1171. 

  1171.     <p>Returns the rune at position <tt class="docutils literal"><span class="pre">pos</span></tt> as UTF8 String.</p>
    1172. 

  1172. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    1173. 

  1173. <p>See also:</p>
    1174. 

  1174. <ul class="simple"><li><a class="reference external" href="#runeAt,string,Natural">runeAt proc</a></li>
    1175. 

  1175. <li><a class="reference external" href="#runeAtPos,string,int">runeAtPos proc</a></li>
    1176. 

  1176. <li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    1177. 

  1177. </ul>
    1178. 

  1178. 

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

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

  1181. 

  1182.   </dd>
    1183. 

  1183. </div>
    1184. 

  1184. <div id="runeStrAtPos,string,Natural">
    1185. 

  1185.   <dt><pre><span class="Keyword">proc</span> <a href="#runeStrAtPos%2Cstring%2CNatural"><span class="Identifier">runeStrAtPos</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">pos</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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>
    1186. 

  1186.     <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.     <p>Returns the rune at position <tt class="docutils literal"><span class="pre">pos</span></tt> as UTF8 String.</p>
    1190. 

  1190. <p><strong>Beware:</strong> This can lead to unoptimized code and slow execution! Most problems can be solved more efficiently by using an iterator or conversion to a seq of Rune.</p>
    1191. 

  1191. <p>See also:</p>
    1192. 

  1192. <ul class="simple"><li><a class="reference external" href="#runeAt,string,Natural">runeAt proc</a></li>
    1193. 

  1193. <li><a class="reference external" href="#runeAtPos,string,int">runeAtPos proc</a></li>
    1194. 

  1194. <li><a class="reference external" href="#fastRuneAt.t,string,int,untyped">fastRuneAt template</a></li>
    1195. 

  1195. </ul>
    1196. 

  1196. 

  1197.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1256" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1198. 

  1198. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1256" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1199. 

  1199. 

  1200.   </dd>
    1201. 

  1201. </div>
    1202. 

  1202. 

  1203. </div>
    1204. 

  1204. <div id="runeSubStr-procs-all">
    1205. 

  1205.   <div id="runeSubStr,openArray[char],int,int">
    1206. 

  1206.   <dt><pre><span class="Keyword">proc</span> <a href="#runeSubStr%2CopenArray%5Bchar%5D%2Cint%2Cint"><span class="Identifier">runeSubStr</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">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1207. 

  1207.     <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>
    1208. 

  1208.   <dd>
    1209. 

  1209.     
    1210. 

  1210.     <p>Returns the UTF-8 substring starting at code point <tt class="docutils literal"><span class="pre">pos</span></tt> with <tt class="docutils literal"><span class="pre">len</span></tt> code points.</p>
    1211. 

  1211. <p>If <tt class="docutils literal"><span class="pre">pos</span></tt> or <tt class="docutils literal"><span class="pre">len</span></tt> is negative they count from the end of the string. If <tt class="docutils literal"><span class="pre">len</span></tt> is not given it means the longest possible string.</p>
    1212. 

  1212. 

  1213. <p><strong class="examples_text">Example:</strong></p>
    1214. 

  1214. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">&quot;Hänsel  ««: 10,00€&quot;</span>
    1215. 

  1215. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hä&quot;</span><span class="Punctuation">)</span>
    1216. 

  1216. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;:&quot;</span><span class="Punctuation">)</span>
    1217. 

  1217. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;10,00€&quot;</span><span class="Punctuation">)</span>
    1218. 

  1218. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;: 10,00€&quot;</span><span class="Punctuation">)</span>
    1219. 

  1219. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">12</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;10,00&quot;</span><span class="Punctuation">)</span>
    1220. 

  1220. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;10,&quot;</span><span class="Punctuation">)</span></pre>
    1221. 

  1221.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L395" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1222. 

  1222. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L395" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1223. 

  1223. 

  1224.   </dd>
    1225. 

  1225. </div>
    1226. 

  1226. <div id="runeSubStr,string,int,int">
    1227. 

  1227.   <dt><pre><span class="Keyword">proc</span> <a href="#runeSubStr%2Cstring%2Cint%2Cint"><span class="Identifier">runeSubStr</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">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">.</span><span class="Identifier">high</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span>
    1228. 

  1228.     <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>
    1229. 

  1229.   <dd>
    1230. 

  1230.     
    1231. 

  1231.     <p>Returns the UTF-8 substring starting at code point <tt class="docutils literal"><span class="pre">pos</span></tt> with <tt class="docutils literal"><span class="pre">len</span></tt> code points.</p>
    1232. 

  1232. <p>If <tt class="docutils literal"><span class="pre">pos</span></tt> or <tt class="docutils literal"><span class="pre">len</span></tt> is negative they count from the end of the string. If <tt class="docutils literal"><span class="pre">len</span></tt> is not given it means the longest possible string.</p>
    1233. 

  1233. 

  1234. <p><strong class="examples_text">Example:</strong></p>
    1235. 

  1235. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">&quot;Hänsel  ««: 10,00€&quot;</span>
    1236. 

  1236. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Hä&quot;</span><span class="Punctuation">)</span>
    1237. 

  1237. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;:&quot;</span><span class="Punctuation">)</span>
    1238. 

  1238. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;10,00€&quot;</span><span class="Punctuation">)</span>
    1239. 

  1239. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;: 10,00€&quot;</span><span class="Punctuation">)</span>
    1240. 

  1240. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="DecNumber">12</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;10,00&quot;</span><span class="Punctuation">)</span>
    1241. 

  1241. <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">runeSubStr</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;10,&quot;</span><span class="Punctuation">)</span></pre>
    1242. 

  1242.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1270" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1243. 

  1243. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1270" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1244. 

  1244. 

  1245.   </dd>
    1246. 

  1246. </div>
    1247. 

  1247. 

  1248. </div>
    1249. 

  1249. <div id="size-procs-all">
    1250. 

  1250.   <div id="size,Rune">
    1251. 

  1251.   <dt><pre><span class="Keyword">proc</span> <a href="#size%2CRune"><span class="Identifier">size</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><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> <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>
    1252. 

  1252.   <dd>
    1253. 

  1253.     
    1254. 

  1254.     Returns the number of bytes the rune <tt class="docutils literal"><span class="pre">r</span></tt> takes.
    1255. 

  1255. <p><strong class="examples_text">Example:</strong></p>
    1256. 

  1256. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toRunes</span> <span class="StringLit">&quot;aá&quot;</span>
    1257. 

  1257. <span class="Identifier">doAssert</span> <span class="Identifier">size</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
    1258. 

  1258. <span class="Identifier">doAssert</span> <span class="Identifier">size</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
    1259. 

  1259.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L932" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1260. 

  1260. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L932" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1261. 

  1261. 

  1262.   </dd>
    1263. 

  1263. </div>
    1264. 

  1264. 

  1265. </div>
    1266. 

  1266. <div id="split-procs-all">
    1267. 

  1267.   <div id="split,openArray[char],Rune,int">
    1268. 

  1268.   <dt><pre><span class="Keyword">proc</span> <a href="#split%2CopenArray%5Bchar%5D%2CRune%2Cint"><span class="Identifier">split</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">sep</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">;</span> <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    1269. 

  1269.     <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nucSplitRune&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1270. 

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

  1271.   <dd>
    1272. 

  1272.     
    1273. 

  1273.     The same as the <a class="reference external" href="#split.i,string,Rune,int">split iterator</a>, but is a proc that returns a sequence of substrings.
    1274. 

  1274.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1034" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1275. 

  1275. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1034" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1276. 

  1276. 

  1277.   </dd>
    1278. 

  1278. </div>
    1279. 

  1279. <div id="split,openArray[char],openArray[Rune],int">
    1280. 

  1280.   <dt><pre><span class="Keyword">proc</span> <a href="#split%2CopenArray%5Bchar%5D%2CopenArray%5BRune%5D%2Cint"><span class="Identifier">split</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">seps</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">unicodeSpaces</span><span class="Other">;</span>
    1281. 

  1281.            <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1282. 

  1282.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nucSplitRunes&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1283. 

  1283.   <dd>
    1284. 

  1284.     
    1285. 

  1285.     The same as the <a class="reference external" href="#split.i,string,openArray[Rune],int">split iterator</a>, but is a proc that returns a sequence of substrings.
    1286. 

  1286.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1028" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1287. 

  1287. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1028" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1288. 

  1288. 

  1289.   </dd>
    1290. 

  1290. </div>
    1291. 

  1291. <div id="split,string,Rune,int">
    1292. 

  1292.   <dt><pre><span class="Keyword">proc</span> <a href="#split%2Cstring%2CRune%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sep</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">;</span> <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    1293. 

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

  1294.   <dd>
    1295. 

  1295.     
    1296. 

  1296.     The same as the <a class="reference external" href="#split.i,string,Rune,int">split iterator</a>, but is a proc that returns a sequence of substrings.
    1297. 

  1297.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1470" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1298. 

  1298. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1470" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1299. 

  1299. 

  1300.   </dd>
    1301. 

  1301. </div>
    1302. 

  1302. <div id="split,string,openArray[Rune],int">
    1303. 

  1303.   <dt><pre><span class="Keyword">proc</span> <a href="#split%2Cstring%2CopenArray%5BRune%5D%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">seps</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">unicodeSpaces</span><span class="Other">;</span> <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span>
    1304. 

  1304.     <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1305. 

  1305.   <dd>
    1306. 

  1306.     
    1307. 

  1307.     The same as the <a class="reference external" href="#split.i,string,openArray[Rune],int">split iterator</a>, but is a proc that returns a sequence of substrings.
    1308. 

  1308.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1464" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1309. 

  1309. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1464" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1310. 

  1310. 

  1311.   </dd>
    1312. 

  1312. </div>
    1313. 

  1313. 

  1314. </div>
    1315. 

  1315. <div id="splitWhitespace-procs-all">
    1316. 

  1316.   <div id="splitWhitespace,openArray[char]">
    1317. 

  1317.   <dt><pre><span class="Keyword">proc</span> <a href="#splitWhitespace%2CopenArray%5Bchar%5D"><span class="Identifier">splitWhitespace</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#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1318. 

  1318.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;ncuSplitWhitespace&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1319. 

  1319.   <dd>
    1320. 

  1320.     
    1321. 

  1321.     The same as the <a class="reference external" href="#splitWhitespace.i,string">splitWhitespace</a> iterator, but is a proc that returns a sequence of substrings.
    1322. 

  1322.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1011" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1323. 

  1323. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1011" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1324. 

  1324. 

  1325.   </dd>
    1326. 

  1326. </div>
    1327. 

  1327. <div id="splitWhitespace,string">
    1328. 

  1328.   <dt><pre><span class="Keyword">proc</span> <a href="#splitWhitespace%2Cstring"><span class="Identifier">splitWhitespace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1329. 

  1329.     <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>
    1330. 

  1330.   <dd>
    1331. 

  1331.     
    1332. 

  1332.     The same as the <a class="reference external" href="#splitWhitespace.i,string">splitWhitespace</a> iterator, but is a proc that returns a sequence of substrings.
    1333. 

  1333.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1448" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1334. 

  1334. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1448" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1335. 

  1335. 

  1336.   </dd>
    1337. 

  1337. </div>
    1338. 

  1338. 

  1339. </div>
    1340. 

  1340. <div id="strip-procs-all">
    1341. 

  1341.   <div id="strip,openArray[char],openArray[Rune]">
    1342. 

  1342.   <dt><pre><span class="Keyword">proc</span> <a href="#strip%2CopenArray%5Bchar%5D%2CopenArray%5BRune%5D"><span class="Identifier">strip</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">leading</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span> <span class="Identifier">trailing</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
    1343. 

  1343.            <span class="Identifier">runes</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">unicodeSpaces</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span>
    1344. 

  1344.     <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;nucStrip&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1345. 

  1345.   <dd>
    1346. 

  1346.     
    1347. 

  1347.     <p>Strips leading or trailing <tt class="docutils literal"><span class="pre">runes</span></tt> from <tt class="docutils literal"><span class="pre">s</span></tt> and returns the resulting string.</p>
    1348. 

  1348. <p>If <tt class="docutils literal"><span class="pre">leading</span></tt> is true (default), leading <tt class="docutils literal"><span class="pre">runes</span></tt> are stripped. If <tt class="docutils literal"><span class="pre">trailing</span></tt> is true (default), trailing <tt class="docutils literal"><span class="pre">runes</span></tt> are stripped. If both are false, the string is returned unchanged.</p>
    1349. 

  1349. 

  1350. <p><strong class="examples_text">Example:</strong></p>
    1351. 

  1351. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="StringLit">áñyóng   &quot;</span>
    1352. 

  1352. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">strip</span> <span class="Operator">==</span> <span class="StringLit">&quot;áñyóng&quot;</span>
    1353. 

  1353. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">strip</span><span class="Punctuation">(</span><span class="Identifier">leading</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="StringLit">áñyóng&quot;</span>
    1354. 

  1354. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">strip</span><span class="Punctuation">(</span><span class="Identifier">trailing</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;áñyóng   &quot;</span></pre>
    1355. 

  1355.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1040" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1356. 

  1356. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1040" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1357. 

  1357. 

  1358.   </dd>
    1359. 

  1359. </div>
    1360. 

  1360. <div id="strip,string,openArray[Rune]">
    1361. 

  1361.   <dt><pre><span class="Keyword">proc</span> <a href="#strip%2Cstring%2CopenArray%5BRune%5D"><span class="Identifier">strip</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">leading</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span> <span class="Identifier">trailing</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span>
    1362. 

  1362.            <span class="Identifier">runes</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">unicodeSpaces</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span>
    1363. 

  1363.     <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>
    1364. 

  1364.   <dd>
    1365. 

  1365.     
    1366. 

  1366.     <p>Strips leading or trailing <tt class="docutils literal"><span class="pre">runes</span></tt> from <tt class="docutils literal"><span class="pre">s</span></tt> and returns the resulting string.</p>
    1367. 

  1367. <p>If <tt class="docutils literal"><span class="pre">leading</span></tt> is true (default), leading <tt class="docutils literal"><span class="pre">runes</span></tt> are stripped. If <tt class="docutils literal"><span class="pre">trailing</span></tt> is true (default), trailing <tt class="docutils literal"><span class="pre">runes</span></tt> are stripped. If both are false, the string is returned unchanged.</p>
    1368. 

  1368. 

  1369. <p><strong class="examples_text">Example:</strong></p>
    1370. 

  1370. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="StringLit">áñyóng   &quot;</span>
    1371. 

  1371. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">strip</span> <span class="Operator">==</span> <span class="StringLit">&quot;áñyóng&quot;</span>
    1372. 

  1372. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">strip</span><span class="Punctuation">(</span><span class="Identifier">leading</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\t</span><span class="StringLit">áñyóng&quot;</span>
    1373. 

  1373. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">strip</span><span class="Punctuation">(</span><span class="Identifier">trailing</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;áñyóng   &quot;</span></pre>
    1374. 

  1374.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1475" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1375. 

  1375. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1475" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1376. 

  1376. 

  1377.   </dd>
    1378. 

  1378. </div>
    1379. 

  1379. 

  1380. </div>
    1381. 

  1381. <div id="swapCase-procs-all">
    1382. 

  1382.   <div id="swapCase,openArray[char]">
    1383. 

  1383.   <dt><pre><span class="Keyword">proc</span> <a href="#swapCase%2CopenArray%5Bchar%5D"><span class="Identifier">swapCase</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1384. 

  1384.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1385. 

  1385.   <dd>
    1386. 

  1386.     
    1387. 

  1387.     <p>Swaps the case of runes in <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
    1388. 

  1388. <p>Returns a new string such that the cases of all runes are swapped if possible.</p>
    1389. 

  1389. 

  1390. <p><strong class="examples_text">Example:</strong></p>
    1391. 

  1391. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">swapCase</span><span class="Punctuation">(</span><span class="StringLit">&quot;Αlpha Βeta Γamma&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;αLPHA βETA γAMMA&quot;</span></pre>
    1392. 

  1392.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L690" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1393. 

  1393. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L690" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1394. 

  1394. 

  1395.   </dd>
    1396. 

  1396. </div>
    1397. 

  1397. <div id="swapCase,string">
    1398. 

  1398.   <dt><pre><span class="Keyword">proc</span> <a href="#swapCase%2Cstring"><span class="Identifier">swapCase</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1399. 

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

  1400.   <dd>
    1401. 

  1401.     
    1402. 

  1402.     <p>Swaps the case of runes in <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
    1403. 

  1403. <p>Returns a new string such that the cases of all runes are swapped if possible.</p>
    1404. 

  1404. 

  1405. <p><strong class="examples_text">Example:</strong></p>
    1406. 

  1406. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">swapCase</span><span class="Punctuation">(</span><span class="StringLit">&quot;Αlpha Βeta Γamma&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;αLPHA βETA γAMMA&quot;</span></pre>
    1407. 

  1407.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1315" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1408. 

  1408. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1315" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1409. 

  1409. 

  1410.   </dd>
    1411. 

  1411. </div>
    1412. 

  1412. 

  1413. </div>
    1414. 

  1414. <div id="title-procs-all">
    1415. 

  1415.   <div id="title,openArray[char]">
    1416. 

  1416.   <dt><pre><span class="Keyword">proc</span> <a href="#title%2CopenArray%5Bchar%5D"><span class="Identifier">title</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span>
    1417. 

  1417.     <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>
    1418. 

  1418.   <dd>
    1419. 

  1419.     
    1420. 

  1420.     <p>Converts <tt class="docutils literal"><span class="pre">s</span></tt> to a unicode title.</p>
    1421. 

  1421. <p>Returns a new string such that the first character in each word inside <tt class="docutils literal"><span class="pre">s</span></tt> is capitalized.</p>
    1422. 

  1422. 

  1423. <p><strong class="examples_text">Example:</strong></p>
    1424. 

  1424. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">title</span><span class="Punctuation">(</span><span class="StringLit">&quot;αlpha βeta γamma&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Αlpha Βeta Γamma&quot;</span></pre>
    1425. 

  1425.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L782" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1426. 

  1426. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L782" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1427. 

  1427. 

  1428.   </dd>
    1429. 

  1429. </div>
    1430. 

  1430. <div id="title,string">
    1431. 

  1431.   <dt><pre><span class="Keyword">proc</span> <a href="#title%2Cstring"><span class="Identifier">title</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1432. 

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

  1433.   <dd>
    1434. 

  1434.     
    1435. 

  1435.     <p>Converts <tt class="docutils literal"><span class="pre">s</span></tt> to a unicode title.</p>
    1436. 

  1436. <p>Returns a new string such that the first character in each word inside <tt class="docutils literal"><span class="pre">s</span></tt> is capitalized.</p>
    1437. 

  1437. 

  1438. <p><strong class="examples_text">Example:</strong></p>
    1439. 

  1439. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">title</span><span class="Punctuation">(</span><span class="StringLit">&quot;αlpha βeta γamma&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Αlpha Βeta Γamma&quot;</span></pre>
    1440. 

  1440.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1347" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1441. 

  1441. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1347" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1442. 

  1442. 

  1443.   </dd>
    1444. 

  1444. </div>
    1445. 

  1445. 

  1446. </div>
    1447. 

  1447. <div id="toLower-procs-all">
    1448. 

  1448.   <div id="toLower,Rune">
    1449. 

  1449.   <dt><pre><span class="Keyword">proc</span> <a href="#toLower%2CRune"><span class="Identifier">toLower</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1450. 

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

  1451.   <dd>
    1452. 

  1452.     
    1453. 

  1453.     <p>Converts <tt class="docutils literal"><span class="pre">c</span></tt> into lower case. This works for any rune.</p>
    1454. 

  1454. <p>If possible, prefer <tt class="docutils literal"><span class="pre">toLower</span></tt> over <tt class="docutils literal"><span class="pre">toUpper</span></tt>.</p>
    1455. 

  1455. <p>See also:</p>
    1456. 

  1456. <ul class="simple"><li><a class="reference external" href="#toUpper,Rune">toUpper proc</a></li>
    1457. 

  1457. <li><a class="reference external" href="#toTitle,Rune">toTitle proc</a></li>
    1458. 

  1458. <li><a class="reference external" href="#isLower,Rune">isLower proc</a></li>
    1459. 

  1459. </ul>
    1460. 

  1460. 

  1461.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L482" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1462. 

  1462. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L482" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1463. 

  1463. 

  1464.   </dd>
    1465. 

  1465. </div>
    1466. 

  1466. <div id="toLower,openArray[char]">
    1467. 

  1467.   <dt><pre><span class="Keyword">proc</span> <a href="#toLower%2CopenArray%5Bchar%5D"><span class="Identifier">toLower</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1468. 

  1468.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1Str&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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>
    1469. 

  1469.   <dd>
    1470. 

  1470.     
    1471. 

  1471.     Converts <tt class="docutils literal"><span class="pre">s</span></tt> into lower-case runes.
    1472. 

  1472. <p><strong class="examples_text">Example:</strong></p>
    1473. 

  1473. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">toLower</span><span class="Punctuation">(</span><span class="StringLit">&quot;ABΓ&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;abγ&quot;</span></pre>
    1474. 

  1474.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L683" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1475. 

  1475. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L683" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1476. 

  1476. 

  1477.   </dd>
    1478. 

  1478. </div>
    1479. 

  1479. <div id="toLower,string">
    1480. 

  1480.   <dt><pre><span class="Keyword">proc</span> <a href="#toLower%2Cstring"><span class="Identifier">toLower</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1481. 

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

  1482.   <dd>
    1483. 

  1483.     
    1484. 

  1484.     Converts <tt class="docutils literal"><span class="pre">s</span></tt> into lower-case runes.
    1485. 

  1485. <p><strong class="examples_text">Example:</strong></p>
    1486. 

  1486. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">toLower</span><span class="Punctuation">(</span><span class="StringLit">&quot;ABΓ&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;abγ&quot;</span></pre>
    1487. 

  1487.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1488. 

  1488. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1489. 

  1489. 

  1490.   </dd>
    1491. 

  1491. </div>
    1492. 

  1492. 

  1493. </div>
    1494. 

  1494. <div id="toRunes-procs-all">
    1495. 

  1495.   <div id="toRunes,openArray[char]">
    1496. 

  1496.   <dt><pre><span class="Keyword">proc</span> <a href="#toRunes%2CopenArray%5Bchar%5D"><span class="Identifier">toRunes</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#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1497. 

  1497.   <dd>
    1498. 

  1498.     
    1499. 

  1499.     <p>Obtains a sequence containing the Runes in <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
    1500. 

  1500. <p>See also:</p>
    1501. 

  1501. <ul class="simple"><li><a class="reference external" href="#$,Rune">$ proc</a> for a reverse operation</li>
    1502. 

  1502. </ul>
    1503. 

  1503. 

  1504. <p><strong class="examples_text">Example:</strong></p>
    1505. 

  1505. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toRunes</span><span class="Punctuation">(</span><span class="StringLit">&quot;aáä&quot;</span><span class="Punctuation">)</span>
    1506. 

  1506. <span class="Identifier">doAssert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;á&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;ä&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">]</span></pre>
    1507. 

  1507.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L831" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1508. 

  1508. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L831" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1509. 

  1509. 

  1510.   </dd>
    1511. 

  1511. </div>
    1512. 

  1512. <div id="toRunes,string">
    1513. 

  1513.   <dt><pre><span class="Keyword">proc</span> <a href="#toRunes%2Cstring"><span class="Identifier">toRunes</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1514. 

  1514.   <dd>
    1515. 

  1515.     
    1516. 

  1516.     <p>Obtains a sequence containing the Runes in <tt class="docutils literal"><span class="pre">s</span></tt>.</p>
    1517. 

  1517. <p>See also:</p>
    1518. 

  1518. <ul class="simple"><li><a class="reference external" href="#$,Rune">$ proc</a> for a reverse operation</li>
    1519. 

  1519. </ul>
    1520. 

  1520. 

  1521. <p><strong class="examples_text">Example:</strong></p>
    1522. 

  1522. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toRunes</span><span class="Punctuation">(</span><span class="StringLit">&quot;aáä&quot;</span><span class="Punctuation">)</span>
    1523. 

  1523. <span class="Identifier">doAssert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;á&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;ä&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">]</span></pre>
    1524. 

  1524.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1373" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1525. 

  1525. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1373" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1526. 

  1526. 

  1527.   </dd>
    1528. 

  1528. </div>
    1529. 

  1529. 

  1530. </div>
    1531. 

  1531. <div id="toTitle-procs-all">
    1532. 

  1532.   <div id="toTitle,Rune">
    1533. 

  1533.   <dt><pre><span class="Keyword">proc</span> <a href="#toTitle%2CRune"><span class="Identifier">toTitle</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1534. 

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

  1535.   <dd>
    1536. 

  1536.     
    1537. 

  1537.     <p>Converts <tt class="docutils literal"><span class="pre">c</span></tt> to title case.</p>
    1538. 

  1538. <p>See also:</p>
    1539. 

  1539. <ul class="simple"><li><a class="reference external" href="#toLower,Rune">toLower proc</a></li>
    1540. 

  1540. <li><a class="reference external" href="#toUpper,Rune">toUpper proc</a></li>
    1541. 

  1541. <li><a class="reference external" href="#isTitle,Rune">isTitle proc</a></li>
    1542. 

  1542. </ul>
    1543. 

  1543. 

  1544.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L518" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1545. 

  1545. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L518" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1546. 

  1546. 

  1547.   </dd>
    1548. 

  1548. </div>
    1549. 

  1549. 

  1550. </div>
    1551. 

  1551. <div id="toUpper-procs-all">
    1552. 

  1552.   <div id="toUpper,Rune">
    1553. 

  1553.   <dt><pre><span class="Keyword">proc</span> <a href="#toUpper%2CRune"><span class="Identifier">toUpper</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1554. 

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

  1555.   <dd>
    1556. 

  1556.     
    1557. 

  1557.     <p>Converts <tt class="docutils literal"><span class="pre">c</span></tt> into upper case. This works for any rune.</p>
    1558. 

  1558. <p>If possible, prefer <tt class="docutils literal"><span class="pre">toLower</span></tt> over <tt class="docutils literal"><span class="pre">toUpper</span></tt>.</p>
    1559. 

  1559. <p>See also:</p>
    1560. 

  1560. <ul class="simple"><li><a class="reference external" href="#toLower,Rune">toLower proc</a></li>
    1561. 

  1561. <li><a class="reference external" href="#toTitle,Rune">toTitle proc</a></li>
    1562. 

  1562. <li><a class="reference external" href="#isUpper,Rune">isUpper proc</a></li>
    1563. 

  1563. </ul>
    1564. 

  1564. 

  1565.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L500" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1566. 

  1566. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L500" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1567. 

  1567. 

  1568.   </dd>
    1569. 

  1569. </div>
    1570. 

  1570. <div id="toUpper,openArray[char]">
    1571. 

  1571.   <dt><pre><span class="Keyword">proc</span> <a href="#toUpper%2CopenArray%5Bchar%5D"><span class="Identifier">toUpper</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1572. 

  1572.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1Str&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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>
    1573. 

  1573.   <dd>
    1574. 

  1574.     
    1575. 

  1575.     Converts <tt class="docutils literal"><span class="pre">s</span></tt> into upper-case runes.
    1576. 

  1576. <p><strong class="examples_text">Example:</strong></p>
    1577. 

  1577. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">toUpper</span><span class="Punctuation">(</span><span class="StringLit">&quot;abγ&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ABΓ&quot;</span></pre>
    1578. 

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

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

  1580. 

  1581.   </dd>
    1582. 

  1582. </div>
    1583. 

  1583. <div id="toUpper,string">
    1584. 

  1584.   <dt><pre><span class="Keyword">proc</span> <a href="#toUpper%2Cstring"><span class="Identifier">toUpper</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1585. 

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

  1586.   <dd>
    1587. 

  1587.     
    1588. 

  1588.     Converts <tt class="docutils literal"><span class="pre">s</span></tt> into upper-case runes.
    1589. 

  1589. <p><strong class="examples_text">Example:</strong></p>
    1590. 

  1590. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">toUpper</span><span class="Punctuation">(</span><span class="StringLit">&quot;abγ&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ABΓ&quot;</span></pre>
    1591. 

  1591.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1303" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1592. 

  1592. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1303" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1593. 

  1593. 

  1594.   </dd>
    1595. 

  1595. </div>
    1596. 

  1596. 

  1597. </div>
    1598. 

  1598. <div id="toUTF8-procs-all">
    1599. 

  1599.   <div id="toUTF8,Rune">
    1600. 

  1600.   <dt><pre><span class="Keyword">proc</span> <a href="#toUTF8%2CRune"><span class="Identifier">toUTF8</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nuc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1601. 

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

  1602.   <dd>
    1603. 

  1603.     
    1604. 

  1604.     <p>Converts a rune into its UTF-8 representation.</p>
    1605. 

  1605. <p>See also:</p>
    1606. 

  1606. <ul class="simple"><li><a class="reference external" href="#validateUtf8,string">validateUtf8 proc</a></li>
    1607. 

  1607. <li><a class="reference external" href="#$,Rune">$ proc</a> alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">toUTF8</span></span></tt></li>
    1608. 

  1608. <li><a class="reference external" href="#utf8.i,string">utf8 iterator</a></li>
    1609. 

  1609. <li><a class="reference external" href="#fastToUTF8Copy.t,Rune,string,int">fastToUTF8Copy template</a></li>
    1610. 

  1610. </ul>
    1611. 

  1611. 

  1612. <p><strong class="examples_text">Example:</strong></p>
    1613. 

  1613. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;añyóng&quot;</span>
    1614. 

  1614. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">toUTF8</span> <span class="Operator">==</span> <span class="StringLit">&quot;ñ&quot;</span></pre>
    1615. 

  1615.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L264" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1616. 

  1616. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L264" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1617. 

  1617. 

  1618.   </dd>
    1619. 

  1619. </div>
    1620. 

  1620. 

  1621. </div>
    1622. 

  1622. <div id="translate-procs-all">
    1623. 

  1623.   <div id="translate,openArray[char],proc(string)">
    1624. 

  1624.   <dt><pre><span class="Keyword">proc</span> <a href="#translate%2CopenArray%5Bchar%5D%2Cproc%28string%29"><span class="Identifier">translate</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">replacements</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1625. 

  1625.     <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;nuc$1&quot;</span><span class="Other">,</span> </span><span class="Identifier">effectsOf</span><span class="Other">:</span> <span class="Identifier">replacements</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>
    1626. 

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

  1627.   <dd>
    1628. 

  1628.     
    1629. 

  1629.     <p>Translates words in a string using the <tt class="docutils literal"><span class="pre">replacements</span></tt> proc to substitute words inside <tt class="docutils literal"><span class="pre">s</span></tt> with their replacements.</p>
    1630. 

  1630. <p><tt class="docutils literal"><span class="pre">replacements</span></tt> is any proc that takes a word and returns a new word to fill it's place.</p>
    1631. 

  1631. 

  1632. <p><strong class="examples_text">Example:</strong></p>
    1633. 

  1633. <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">wordToNumber</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span>
    1634. 

  1634.   <span class="Keyword">case</span> <span class="Identifier">s</span>
    1635. 

  1635.   <span class="Keyword">of</span> <span class="StringLit">&quot;one&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;1&quot;</span>
    1636. 

  1636.   <span class="Keyword">of</span> <span class="StringLit">&quot;two&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;2&quot;</span>
    1637. 

  1637.   <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">s</span>
    1638. 

  1638. <span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;one two three four&quot;</span>
    1639. 

  1639. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">translate</span><span class="Punctuation">(</span><span class="Identifier">wordToNumber</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1 2 three four&quot;</span></pre>
    1640. 

  1640.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L729" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1641. 

  1641. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L729" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1642. 

  1642. 

  1643.   </dd>
    1644. 

  1644. </div>
    1645. 

  1645. <div id="translate,string,proc(string)">
    1646. 

  1646.   <dt><pre><span class="Keyword">proc</span> <a href="#translate%2Cstring%2Cproc%28string%29"><span class="Identifier">translate</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">replacements</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1647. 

  1647.     <span class="Identifier">effectsOf</span><span class="Other">:</span> <span class="Identifier">replacements</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1648. 

  1648.   <dd>
    1649. 

  1649.     
    1650. 

  1650.     <p>Translates words in a string using the <tt class="docutils literal"><span class="pre">replacements</span></tt> proc to substitute words inside <tt class="docutils literal"><span class="pre">s</span></tt> with their replacements.</p>
    1651. 

  1651. <p><tt class="docutils literal"><span class="pre">replacements</span></tt> is any proc that takes a word and returns a new word to fill it's place.</p>
    1652. 

  1652. 

  1653. <p><strong class="examples_text">Example:</strong></p>
    1654. 

  1654. <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">wordToNumber</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span>
    1655. 

  1655.   <span class="Keyword">case</span> <span class="Identifier">s</span>
    1656. 

  1656.   <span class="Keyword">of</span> <span class="StringLit">&quot;one&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;1&quot;</span>
    1657. 

  1657.   <span class="Keyword">of</span> <span class="StringLit">&quot;two&quot;</span><span class="Punctuation">:</span> <span class="StringLit">&quot;2&quot;</span>
    1658. 

  1658.   <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">s</span>
    1659. 

  1659. <span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;one two three four&quot;</span>
    1660. 

  1660. <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">translate</span><span class="Punctuation">(</span><span class="Identifier">wordToNumber</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1 2 three four&quot;</span></pre>
    1661. 

  1661.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1331" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1662. 

  1662. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1331" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1663. 

  1663. 

  1664.   </dd>
    1665. 

  1665. </div>
    1666. 

  1666. 

  1667. </div>
    1668. 

  1668. <div id="validateUtf8-procs-all">
    1669. 

  1669.   <div id="validateUtf8,openArray[char]">
    1670. 

  1670.   <dt><pre><span class="Keyword">proc</span> <a href="#validateUtf8%2CopenArray%5Bchar%5D"><span class="Identifier">validateUtf8</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><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>
    1671. 

  1671.   <dd>
    1672. 

  1672.     
    1673. 

  1673.     <p>Returns the position of the invalid byte in <tt class="docutils literal"><span class="pre">s</span></tt> if the string <tt class="docutils literal"><span class="pre">s</span></tt> does not hold valid UTF-8 data. Otherwise <tt class="docutils literal"><span class="pre">-1</span></tt> is returned.</p>
    1674. 

  1674. <p>See also:</p>
    1675. 

  1675. <ul class="simple"><li><a class="reference external" href="#toUTF8,Rune">toUTF8 proc</a></li>
    1676. 

  1676. <li><a class="reference external" href="#$,Rune">$ proc</a> alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">toUTF8</span></span></tt></li>
    1677. 

  1677. <li><a class="reference external" href="#fastToUTF8Copy.t,Rune,string,int">fastToUTF8Copy template</a></li>
    1678. 

  1678. </ul>
    1679. 

  1679. 

  1680.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L176" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1681. 

  1681. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L176" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1682. 

  1682. 

  1683.   </dd>
    1684. 

  1684. </div>
    1685. 

  1685. <div id="validateUtf8,string">
    1686. 

  1686.   <dt><pre><span class="Keyword">proc</span> <a href="#validateUtf8%2Cstring"><span class="Identifier">validateUtf8</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1687. 

  1687.   <dd>
    1688. 

  1688.     
    1689. 

  1689.     <p>Returns the position of the invalid byte in <tt class="docutils literal"><span class="pre">s</span></tt> if the string <tt class="docutils literal"><span class="pre">s</span></tt> does not hold valid UTF-8 data. Otherwise <tt class="docutils literal"><span class="pre">-1</span></tt> is returned.</p>
    1690. 

  1690. <p>See also:</p>
    1691. 

  1691. <ul class="simple"><li><a class="reference external" href="#toUTF8,Rune">toUTF8 proc</a></li>
    1692. 

  1692. <li><a class="reference external" href="#$,Rune">$ proc</a> alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">toUTF8</span></span></tt></li>
    1693. 

  1693. <li><a class="reference external" href="#fastToUTF8Copy.t,Rune,string,int">fastToUTF8Copy template</a></li>
    1694. 

  1694. </ul>
    1695. 

  1695. 

  1696.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1198" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1697. 

  1697. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1198" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1698. 

  1698. 

  1699.   </dd>
    1700. 

  1700. </div>
    1701. 

  1701. 

  1702. </div>
    1703. 

  1703. 

  1704.   </dl>
    1705. 

  1705. </div>
    1706. 

  1706. <div class="section" id="15">
    1707. 

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

  1708.   <dl class="item">
    1709. 

  1709.     <div id="runes-iterators-all">
    1710. 

  1710.   <div id="runes.i,openArray[char]">
    1711. 

  1711.   <dt><pre><span class="Keyword">iterator</span> <a href="#runes.i%2CopenArray%5Bchar%5D"><span class="Identifier">runes</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="unicode.html#Rune"><span class="Identifier">Rune</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>
    1712. 

  1712.   <dd>
    1713. 

  1713.     
    1714. 

  1714.     Iterates over any rune of the string <tt class="docutils literal"><span class="pre">s</span></tt> returning runes.
    1715. 

  1715.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L808" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1716. 

  1716. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L808" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1717. 

  1717. 

  1718.   </dd>
    1719. 

  1719. </div>
    1720. 

  1720. <div id="runes.i,string">
    1721. 

  1721.   <dt><pre><span class="Keyword">iterator</span> <a href="#runes.i%2Cstring"><span class="Identifier">runes</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</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>
    1722. 

  1722.   <dd>
    1723. 

  1723.     
    1724. 

  1724.     Iterates over any rune of the string <tt class="docutils literal"><span class="pre">s</span></tt> returning runes.
    1725. 

  1725.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1357" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1726. 

  1726. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1357" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1727. 

  1727. 

  1728.   </dd>
    1729. 

  1729. </div>
    1730. 

  1730. 

  1731. </div>
    1732. 

  1732. <div id="split-iterators-all">
    1733. 

  1733.   <div id="split.i,openArray[char],Rune,int">
    1734. 

  1734.   <dt><pre><span class="Keyword">iterator</span> <a href="#split.i%2CopenArray%5Bchar%5D%2CRune%2Cint"><span class="Identifier">split</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">sep</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">;</span> <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1735. 

  1735.     <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>
    1736. 

  1736.   <dd>
    1737. 

  1737.     
    1738. 

  1738.     Splits the unicode string <tt class="docutils literal"><span class="pre">s</span></tt> into substrings using a single separator. Substrings are separated by the rune <tt class="docutils literal"><span class="pre">sep</span></tt>.
    1739. 

  1739. <p><strong class="examples_text">Example:</strong></p>
    1740. 

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

  1741. 

  1742. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;;;hÃllo;this;is;an;;example;;;是&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;;&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1743. 

  1743.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;hÃllo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;是&quot;</span><span class="Punctuation">]</span></pre>
    1744. 

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

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

  1746. 

  1747.   </dd>
    1748. 

  1748. </div>
    1749. 

  1749. <div id="split.i,openArray[char],openArray[Rune],int">
    1750. 

  1750.   <dt><pre><span class="Keyword">iterator</span> <a href="#split.i%2CopenArray%5Bchar%5D%2CopenArray%5BRune%5D%2Cint"><span class="Identifier">split</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">seps</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">unicodeSpaces</span><span class="Other">;</span>
    1751. 

  1751.                <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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>
    1752. 

  1752.   <dd>
    1753. 

  1753.     
    1754. 

  1754.     <p>Splits the unicode string <tt class="docutils literal"><span class="pre">s</span></tt> into substrings using a group of separators.</p>
    1755. 

  1755. <p>Substrings are separated by a substring containing only <tt class="docutils literal"><span class="pre">seps</span></tt>.</p>
    1756. 

  1756. 

  1757. <p><strong class="examples_text">Example:</strong></p>
    1758. 

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

  1759. 

  1760. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="StringLit">&quot;hÃllo</span><span class="EscapeSequence">\l</span><span class="StringLit">this</span><span class="EscapeSequence">\l</span><span class="StringLit">is an</span><span class="EscapeSequence">\t</span><span class="StringLit">example</span><span class="EscapeSequence">\l</span><span class="StringLit">是&quot;</span><span class="Operator">.</span><span class="Identifier">split</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1761. 

  1761.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;hÃllo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;是&quot;</span><span class="Punctuation">]</span>
    1762. 

  1762. 

  1763. <span class="Comment"># And the following code splits the same string using a sequence of Runes.</span>
    1764. 

  1764. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;añyóng:hÃllo;是$example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;;:$&quot;</span><span class="Operator">.</span><span class="Identifier">toRunes</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1765. 

  1765.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;añyóng&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;hÃllo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;是&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">]</span>
    1766. 

  1766. 

  1767. <span class="Comment"># example with a `Rune` separator and unused one `;`:</span>
    1768. 

  1768. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;ab是de:f:&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;;:是&quot;</span><span class="Operator">.</span><span class="Identifier">toRunes</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;ab&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;de&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;f&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">]</span>
    1769. 

  1769. 

  1770. <span class="Comment"># Another example that splits a string containing a date.</span>
    1771. 

  1771. <span class="Keyword">let</span> <span class="Identifier">date</span> <span class="Operator">=</span> <span class="StringLit">&quot;2012-11-20T22:08:08.398990&quot;</span>
    1772. 

  1772. 

  1773. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="Identifier">date</span><span class="Punctuation">,</span> <span class="StringLit">&quot; -:T&quot;</span><span class="Operator">.</span><span class="Identifier">toRunes</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1774. 

  1774.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;2012&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;11&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;20&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;08&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;08.398990&quot;</span><span class="Punctuation">]</span></pre>
    1775. 

  1775.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L977" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1776. 

  1776. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L977" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1777. 

  1777. 

  1778.   </dd>
    1779. 

  1779. </div>
    1780. 

  1780. <div id="split.i,string,Rune,int">
    1781. 

  1781.   <dt><pre><span class="Keyword">iterator</span> <a href="#split.i%2Cstring%2CRune%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sep</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">;</span> <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1782. 

  1782.     <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>
    1783. 

  1783.   <dd>
    1784. 

  1784.     
    1785. 

  1785.     Splits the unicode string <tt class="docutils literal"><span class="pre">s</span></tt> into substrings using a single separator. Substrings are separated by the rune <tt class="docutils literal"><span class="pre">sep</span></tt>.
    1786. 

  1786. <p><strong class="examples_text">Example:</strong></p>
    1787. 

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

  1788. 

  1789. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;;;hÃllo;this;is;an;;example;;;是&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;;&quot;</span><span class="Operator">.</span><span class="Identifier">runeAt</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1790. 

  1790.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;hÃllo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;是&quot;</span><span class="Punctuation">]</span></pre>
    1791. 

  1791.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1453" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1792. 

  1792. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1453" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1793. 

  1793. 

  1794.   </dd>
    1795. 

  1795. </div>
    1796. 

  1796. <div id="split.i,string,openArray[Rune],int">
    1797. 

  1797.   <dt><pre><span class="Keyword">iterator</span> <a href="#split.i%2Cstring%2CopenArray%5BRune%5D%2Cint"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">seps</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">unicodeSpaces</span><span class="Other">;</span>
    1798. 

  1798.                <span class="Identifier">maxsplit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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>
    1799. 

  1799.   <dd>
    1800. 

  1800.     
    1801. 

  1801.     <p>Splits the unicode string <tt class="docutils literal"><span class="pre">s</span></tt> into substrings using a group of separators.</p>
    1802. 

  1802. <p>Substrings are separated by a substring containing only <tt class="docutils literal"><span class="pre">seps</span></tt>.</p>
    1803. 

  1803. 

  1804. <p><strong class="examples_text">Example:</strong></p>
    1805. 

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

  1806. 

  1807. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="StringLit">&quot;hÃllo</span><span class="EscapeSequence">\l</span><span class="StringLit">this</span><span class="EscapeSequence">\l</span><span class="StringLit">is an</span><span class="EscapeSequence">\t</span><span class="StringLit">example</span><span class="EscapeSequence">\l</span><span class="StringLit">是&quot;</span><span class="Operator">.</span><span class="Identifier">split</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1808. 

  1808.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;hÃllo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;this&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;an&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;是&quot;</span><span class="Punctuation">]</span>
    1809. 

  1809. 

  1810. <span class="Comment"># And the following code splits the same string using a sequence of Runes.</span>
    1811. 

  1811. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;añyóng:hÃllo;是$example&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;;:$&quot;</span><span class="Operator">.</span><span class="Identifier">toRunes</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1812. 

  1812.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;añyóng&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;hÃllo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;是&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;example&quot;</span><span class="Punctuation">]</span>
    1813. 

  1813. 

  1814. <span class="Comment"># example with a `Rune` separator and unused one `;`:</span>
    1815. 

  1815. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;ab是de:f:&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;;:是&quot;</span><span class="Operator">.</span><span class="Identifier">toRunes</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;ab&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;de&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;f&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">]</span>
    1816. 

  1816. 

  1817. <span class="Comment"># Another example that splits a string containing a date.</span>
    1818. 

  1818. <span class="Keyword">let</span> <span class="Identifier">date</span> <span class="Operator">=</span> <span class="StringLit">&quot;2012-11-20T22:08:08.398990&quot;</span>
    1819. 

  1819. 

  1820. <span class="Identifier">assert</span> <span class="Identifier">toSeq</span><span class="Punctuation">(</span><span class="Identifier">split</span><span class="Punctuation">(</span><span class="Identifier">date</span><span class="Punctuation">,</span> <span class="StringLit">&quot; -:T&quot;</span><span class="Operator">.</span><span class="Identifier">toRunes</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span>
    1821. 

  1821.   <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;2012&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;11&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;20&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;22&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;08&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;08.398990&quot;</span><span class="Punctuation">]</span></pre>
    1822. 

  1822.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1417" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1823. 

  1823. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1417" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1824. 

  1824. 

  1825.   </dd>
    1826. 

  1826. </div>
    1827. 

  1827. 

  1828. </div>
    1829. 

  1829. <div id="splitWhitespace-iterators-all">
    1830. 

  1830.   <div id="splitWhitespace.i,openArray[char]">
    1831. 

  1831.   <dt><pre><span class="Keyword">iterator</span> <a href="#splitWhitespace.i%2CopenArray%5Bchar%5D"><span class="Identifier">splitWhitespace</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>
    1832. 

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

  1833.   <dd>
    1834. 

  1834.     
    1835. 

  1835.     Splits a unicode string at whitespace runes.
    1836. 

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

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

  1838. 

  1839.   </dd>
    1840. 

  1840. </div>
    1841. 

  1841. <div id="splitWhitespace.i,string">
    1842. 

  1842.   <dt><pre><span class="Keyword">iterator</span> <a href="#splitWhitespace.i%2Cstring"><span class="Identifier">splitWhitespace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1843. 

  1843.   <dd>
    1844. 

  1844.     
    1845. 

  1845.     Splits a unicode string at whitespace runes.
    1846. 

  1846.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1443" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1847. 

  1847. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1443" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1848. 

  1848. 

  1849.   </dd>
    1850. 

  1850. </div>
    1851. 

  1851. 

  1852. </div>
    1853. 

  1853. <div id="utf8-iterators-all">
    1854. 

  1854.   <div id="utf8.i,openArray[char]">
    1855. 

  1855.   <dt><pre><span class="Keyword">iterator</span> <a href="#utf8.i%2CopenArray%5Bchar%5D"><span class="Identifier">utf8</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>
    1856. 

  1856.   <dd>
    1857. 

  1857.     
    1858. 

  1858.     <p>Iterates over any rune of the string <tt class="docutils literal"><span class="pre">s</span></tt> returning utf8 values.</p>
    1859. 

  1859. <p>See also:</p>
    1860. 

  1860. <ul class="simple"><li><a class="reference external" href="#validateUtf8,string">validateUtf8 proc</a></li>
    1861. 

  1861. <li><a class="reference external" href="#toUTF8,Rune">toUTF8 proc</a></li>
    1862. 

  1862. <li><a class="reference external" href="#$,Rune">$ proc</a> alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">toUTF8</span></span></tt></li>
    1863. 

  1863. <li><a class="reference external" href="#fastToUTF8Copy.t,Rune,string,int">fastToUTF8Copy template</a></li>
    1864. 

  1864. </ul>
    1865. 

  1865. 

  1866.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L817" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1867. 

  1867. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L817" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1868. 

  1868. 

  1869.   </dd>
    1870. 

  1870. </div>
    1871. 

  1871. <div id="utf8.i,string">
    1872. 

  1872.   <dt><pre><span class="Keyword">iterator</span> <a href="#utf8.i%2Cstring"><span class="Identifier">utf8</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1873. 

  1873.   <dd>
    1874. 

  1874.     
    1875. 

  1875.     <p>Iterates over any rune of the string <tt class="docutils literal"><span class="pre">s</span></tt> returning utf8 values.</p>
    1876. 

  1876. <p>See also:</p>
    1877. 

  1877. <ul class="simple"><li><a class="reference external" href="#validateUtf8,string">validateUtf8 proc</a></li>
    1878. 

  1878. <li><a class="reference external" href="#toUTF8,Rune">toUTF8 proc</a></li>
    1879. 

  1879. <li><a class="reference external" href="#$,Rune">$ proc</a> alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">toUTF8</span></span></tt></li>
    1880. 

  1880. <li><a class="reference external" href="#fastToUTF8Copy.t,Rune,string,int">fastToUTF8Copy template</a></li>
    1881. 

  1881. </ul>
    1882. 

  1882. 

  1883.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L1362" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1884. 

  1884. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L1362" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1885. 

  1885. 

  1886.   </dd>
    1887. 

  1887. </div>
    1888. 

  1888. 

  1889. </div>
    1890. 

  1890. 

  1891.   </dl>
    1892. 

  1892. </div>
    1893. 

  1893. <div class="section" id="18">
    1894. 

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

  1895.   <dl class="item">
    1896. 

  1896.     <div id="fastRuneAt-templates-all">
    1897. 

  1897.   <div id="fastRuneAt.t,,int,untyped">
    1898. 

  1898.   <dt><pre><span class="Keyword">template</span> <a href="#fastRuneAt.t%2C%2Cint%2Cuntyped"><span class="Identifier">fastRuneAt</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="Keyword">or</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">result</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">;</span>
    1899. 

  1899.                     <span class="Identifier">doInc</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span></pre></dt>
    1900. 

  1900.   <dd>
    1901. 

  1901.     
    1902. 

  1902.     <p>Returns the rune <tt class="docutils literal"><span class="pre">s[i]</span></tt> in <tt class="docutils literal"><span class="pre">result</span></tt>.</p>
    1903. 

  1903. <p>If <tt class="docutils literal"><span class="pre">doInc == true</span></tt> (default), <tt class="docutils literal"><span class="pre">i</span></tt> is incremented by the number of bytes that have been processed.</p>
    1904. 

  1904. 

  1905.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/unicode.nim#L84" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1906. 

  1906. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/unicode.nim#L84" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1907. 

  1907. 

  1908.   </dd>
    1909. 

  1909. </div>
    1910. 

  1910. 

  1911. </div>
    1912. 

  1912. <div id="fastToUTF8Copy-templates-all">
    1913. 

  1913.   <div id="fastToUTF8Copy.t,Rune,string,int">
    1914. 

  1914.   <dt><pre><span class="Keyword">template</span> <a href="#fastToUTF8Copy.t%2CRune%2Cstring%2Cint"><span class="Identifier">fastToUTF8Copy</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="unicode.html#Rune"><span class="Identifier">Rune</span></a><span class="Other">;</span> <span class="Identifier">s</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">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">doInc</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span></pre></dt>
    1915. 

  1915.   <dd>
    1916. 

  1916.     
    1917. 

  1917.     <p>Copies UTF-8 representation of <tt class="docutils literal"><span class="pre">c</span></tt> into the preallocated string <tt class="docutils literal"><span class="pre">s</span></tt> starting at position <tt class="docutils literal"><span class="pre">pos</span></tt>.</p>
    1918. 

  1918. <p>If <tt class="docutils literal"><span class="pre">doInc == true</span></tt> (default), <tt class="docutils literal"><span class="pre">pos</span></tt> is incremented by the number of bytes that have been processed.</p>
    1919. 

  1919. <p>To be the most efficient, make sure <tt class="docutils literal"><span class="pre">s</span></tt> is preallocated with an additional amount equal to the byte length of <tt class="docutils literal"><span class="pre">c</span></tt>.</p>
    1920. 

  1920. <p>See also:</p>
    1921. 

  1921. <ul class="simple"><li><a class="reference external" href="#validateUtf8,string">validateUtf8 proc</a></li>
    1922. 

  1922. <li><a class="reference external" href="#toUTF8,Rune">toUTF8 proc</a></li>
    1923. 

  1923. <li><a class="reference external" href="#$,Rune">$ proc</a> alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">toUTF8</span></span></tt></li>
    1924. 

  1924. </ul>
    1925. 

  1925. 

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

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

  1928. 

  1929.   </dd>
    1930. 

  1930. </div>
    1931. 

  1931. 

  1932. </div>
    1933. 

  1933. 

  1934.   </dl>
    1935. 

  1935. </div>
    1936. 

  1936. 

  1937.   </div>
    1938. 

  1938. </div>
    1939. 

  1939. 

  1940.       <div class="twelve-columns footer">
    1941. 

  1941.         <span class="nim-sprite"></span>
    1942. 

  1942.         <br>
    1943. 

  1943.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:08 UTC</small>
    1944. 

  1944.       </div>
    1945. 

  1945.     </div>
    1946. 

  1946.   </div>
    1947. 

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

  1948.     
    1949. 

  1949. </body>
    1950. 

  1950. </html>
    1951. 

  1951.