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
Branch: gh-pages
Branches Tags
Nim
/
streams.html

streams.html 258 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913 
  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/streams</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/streams</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li><a class="reference" id="basic-usage_toc" href="#basic-usage">Basic usage</a></li>
    55. 

  55. <ul class="simple"><li><a class="reference" id="basic-usage-stringstream-example_toc" href="#basic-usage-stringstream-example">StringStream example</a></li>
    56. 

  56. <li><a class="reference" id="basic-usage-filestream-example_toc" href="#basic-usage-filestream-example">FileStream example</a></li>
    57. 

  57. </ul><li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
    58. 

  58. <li>
    59. 

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

  60. </li>
    61. 

  61. <li>
    62. 

  62.   <details open>
    63. 

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

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

  65.       <li><a class="reference" href="#FileStream" title="FileStream = ref FileStreamObj">FileStream</a></li>
    66. 

  66. <li><a class="reference" href="#FileStreamObj" title="FileStreamObj = object of Stream">FileStreamObj</a></li>
    67. 

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

  68. <li><a class="reference" href="#StreamObj" title="StreamObj = object of RootObj
    69. 

  69.   closeImpl*: proc (s: Stream) {.nimcall, raises: [IOError, OSError],
    70. 

  70.                                  tags: [WriteIOEffect], gcsafe.}
    71. 

  71.   atEndImpl*: proc (s: Stream): bool {.nimcall,
    72. 

  72.                                        raises: [Defect, IOError, OSError],
    73. 

  73.                                        tags: [], gcsafe.}
    74. 

  74.   setPositionImpl*: proc (s: Stream; pos: int) {.nimcall,
    75. 

  75.       raises: [Defect, IOError, OSError], tags: [], gcsafe.}
    76. 

  76.   getPositionImpl*: proc (s: Stream): int {.nimcall,
    77. 

  77.       raises: [Defect, IOError, OSError], tags: [], gcsafe.}
    78. 

  78.   readDataStrImpl*: proc (s: Stream; buffer: var string; slice: Slice[int]): int {.
    79. 

  79.       nimcall, raises: [Defect, IOError, OSError], tags: [ReadIOEffect], gcsafe.}
    80. 

  80.   readLineImpl*: proc (s: Stream; line: var string): bool {.nimcall,
    81. 

  81.       raises: [Defect, IOError, OSError], tags: [ReadIOEffect], gcsafe.}
    82. 

  82.   readDataImpl*: proc (s: Stream; buffer: pointer; bufLen: int): int {.nimcall,
    83. 

  83.       raises: [Defect, IOError, OSError], tags: [ReadIOEffect], gcsafe.}
    84. 

  84.   peekDataImpl*: proc (s: Stream; buffer: pointer; bufLen: int): int {.nimcall,
    85. 

  85.       raises: [Defect, IOError, OSError], tags: [ReadIOEffect], gcsafe.}
    86. 

  86.   writeDataImpl*: proc (s: Stream; buffer: pointer; bufLen: int) {.nimcall,
    87. 

  87.       raises: [Defect, IOError, OSError], tags: [WriteIOEffect], gcsafe.}
    88. 

  88.   flushImpl*: proc (s: Stream) {.nimcall, raises: [Defect, IOError, OSError],
    89. 

  89.                                  tags: [WriteIOEffect], gcsafe.}">StreamObj</a></li>
    90. 

  90. <li><a class="reference" href="#StringStream" title="StringStream = ref StringStreamObj">StringStream</a></li>
    91. 

  91. <li><a class="reference" href="#StringStreamObj" title="StringStreamObj = object of StreamObj
    92. 

  92.   data*: string              ## A string data.
    93. 

  93.                              ## This is updated when called `writeLine` etc.">StringStreamObj</a></li>
    94. 

  94. 

  95.     </ul>
    96. 

  96.   </details>
    97. 

  97. </li>
    98. 

  98. <li>
    99. 

  99.   <details open>
    100. 

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

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

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

  103.   <li><a class="reference" href="#atEnd%2CStream" title="atEnd(s: Stream): bool">atEnd(s: Stream): bool</a></li>
    104. 

  104. 

  105. </ul>
    106. 

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

  107.   <li><a class="reference" href="#close%2CStream" title="close(s: Stream)">close(s: Stream)</a></li>
    108. 

  108. 

  109. </ul>
    110. 

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

  111.   <li><a class="reference" href="#flush%2CStream" title="flush(s: Stream)">flush(s: Stream)</a></li>
    112. 

  112. 

  113. </ul>
    114. 

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

  115.   <li><a class="reference" href="#getPosition%2CStream" title="getPosition(s: Stream): int">getPosition(s: Stream): int</a></li>
    116. 

  116. 

  117. </ul>
    118. 

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

  119.   <li><a class="reference" href="#newFileStream%2CFile" title="newFileStream(f: File): owned FileStream">newFileStream(f: File): owned FileStream</a></li>
    120. 

  120. <li><a class="reference" href="#newFileStream%2Cstring%2CFileMode%2Cint" title="newFileStream(filename: string; mode: FileMode = fmRead; bufSize: int = -1): owned
    121. 

  121.     FileStream">newFileStream(filename: string; mode: FileMode = fmRead; bufSize: int = -1): owned
    122. 

  122.     FileStream</a></li>
    123. 

  123. 

  124. </ul>
    125. 

  125. <ul class="simple nested-toc-section">newStringStream
    126. 

  126.   <li><a class="reference" href="#newStringStream%2Csinkstring" title="newStringStream(s: sink string = &quot;&quot;): owned StringStream">newStringStream(s: sink string = &quot;&quot;): owned StringStream</a></li>
    127. 

  127. 

  128. </ul>
    129. 

  129. <ul class="simple nested-toc-section">openFileStream
    130. 

  130.   <li><a class="reference" href="#openFileStream%2Cstring%2CFileMode%2Cint" title="openFileStream(filename: string; mode: FileMode = fmRead; bufSize: int = -1): owned
    131. 

  131.     FileStream">openFileStream(filename: string; mode: FileMode = fmRead; bufSize: int = -1): owned
    132. 

  132.     FileStream</a></li>
    133. 

  133. 

  134. </ul>
    135. 

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

  136.   <li><a class="reference" href="#peek%2CStream%2CT" title="peek[T](s: Stream; result: var T)">peek[T](s: Stream; result: var T)</a></li>
    137. 

  137. 

  138. </ul>
    139. 

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

  140.   <li><a class="reference" href="#peekBool%2CStream" title="peekBool(s: Stream): bool">peekBool(s: Stream): bool</a></li>
    141. 

  141. 

  142. </ul>
    143. 

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

  144.   <li><a class="reference" href="#peekChar%2CStream" title="peekChar(s: Stream): char">peekChar(s: Stream): char</a></li>
    145. 

  145. 

  146. </ul>
    147. 

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

  148.   <li><a class="reference" href="#peekData%2CStream%2Cpointer%2Cint" title="peekData(s: Stream; buffer: pointer; bufLen: int): int">peekData(s: Stream; buffer: pointer; bufLen: int): int</a></li>
    149. 

  149. 

  150. </ul>
    151. 

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

  152.   <li><a class="reference" href="#peekFloat32%2CStream" title="peekFloat32(s: Stream): float32">peekFloat32(s: Stream): float32</a></li>
    153. 

  153. 

  154. </ul>
    155. 

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

  156.   <li><a class="reference" href="#peekFloat64%2CStream" title="peekFloat64(s: Stream): float64">peekFloat64(s: Stream): float64</a></li>
    157. 

  157. 

  158. </ul>
    159. 

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

  160.   <li><a class="reference" href="#peekInt8%2CStream" title="peekInt8(s: Stream): int8">peekInt8(s: Stream): int8</a></li>
    161. 

  161. 

  162. </ul>
    163. 

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

  164.   <li><a class="reference" href="#peekInt16%2CStream" title="peekInt16(s: Stream): int16">peekInt16(s: Stream): int16</a></li>
    165. 

  165. 

  166. </ul>
    167. 

  167. <ul class="simple nested-toc-section">peekInt32
    168. 

  168.   <li><a class="reference" href="#peekInt32%2CStream" title="peekInt32(s: Stream): int32">peekInt32(s: Stream): int32</a></li>
    169. 

  169. 

  170. </ul>
    171. 

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

  172.   <li><a class="reference" href="#peekInt64%2CStream" title="peekInt64(s: Stream): int64">peekInt64(s: Stream): int64</a></li>
    173. 

  173. 

  174. </ul>
    175. 

  175. <ul class="simple nested-toc-section">peekLine
    176. 

  176.   <li><a class="reference" href="#peekLine%2CStream" title="peekLine(s: Stream): string">peekLine(s: Stream): string</a></li>
    177. 

  177. <li><a class="reference" href="#peekLine%2CStream%2Cstring" title="peekLine(s: Stream; line: var string): bool">peekLine(s: Stream; line: var string): bool</a></li>
    178. 

  178. 

  179. </ul>
    180. 

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

  181.   <li><a class="reference" href="#peekStr%2CStream%2Cint" title="peekStr(s: Stream; length: int): string">peekStr(s: Stream; length: int): string</a></li>
    182. 

  182. <li><a class="reference" href="#peekStr%2CStream%2Cint%2Cstring" title="peekStr(s: Stream; length: int; str: var string)">peekStr(s: Stream; length: int; str: var string)</a></li>
    183. 

  183. 

  184. </ul>
    185. 

  185. <ul class="simple nested-toc-section">peekUint8
    186. 

  186.   <li><a class="reference" href="#peekUint8%2CStream" title="peekUint8(s: Stream): uint8">peekUint8(s: Stream): uint8</a></li>
    187. 

  187. 

  188. </ul>
    189. 

  189. <ul class="simple nested-toc-section">peekUint16
    190. 

  190.   <li><a class="reference" href="#peekUint16%2CStream" title="peekUint16(s: Stream): uint16">peekUint16(s: Stream): uint16</a></li>
    191. 

  191. 

  192. </ul>
    193. 

  193. <ul class="simple nested-toc-section">peekUint32
    194. 

  194.   <li><a class="reference" href="#peekUint32%2CStream" title="peekUint32(s: Stream): uint32">peekUint32(s: Stream): uint32</a></li>
    195. 

  195. 

  196. </ul>
    197. 

  197. <ul class="simple nested-toc-section">peekUint64
    198. 

  198.   <li><a class="reference" href="#peekUint64%2CStream" title="peekUint64(s: Stream): uint64">peekUint64(s: Stream): uint64</a></li>
    199. 

  199. 

  200. </ul>
    201. 

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

  202.   <li><a class="reference" href="#read%2CStream%2CT" title="read[T](s: Stream; result: var T)">read[T](s: Stream; result: var T)</a></li>
    203. 

  203. 

  204. </ul>
    205. 

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

  206.   <li><a class="reference" href="#readAll%2CStream" title="readAll(s: Stream): string">readAll(s: Stream): string</a></li>
    207. 

  207. 

  208. </ul>
    209. 

  209. <ul class="simple nested-toc-section">readBool
    210. 

  210.   <li><a class="reference" href="#readBool%2CStream" title="readBool(s: Stream): bool">readBool(s: Stream): bool</a></li>
    211. 

  211. 

  212. </ul>
    213. 

  213. <ul class="simple nested-toc-section">readChar
    214. 

  214.   <li><a class="reference" href="#readChar%2CStream" title="readChar(s: Stream): char">readChar(s: Stream): char</a></li>
    215. 

  215. 

  216. </ul>
    217. 

  217. <ul class="simple nested-toc-section">readData
    218. 

  218.   <li><a class="reference" href="#readData%2CStream%2Cpointer%2Cint" title="readData(s: Stream; buffer: pointer; bufLen: int): int">readData(s: Stream; buffer: pointer; bufLen: int): int</a></li>
    219. 

  219. 

  220. </ul>
    221. 

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

  222.   <li><a class="reference" href="#readDataStr%2CStream%2Cstring%2CSlice%5Bint%5D" title="readDataStr(s: Stream; buffer: var string; slice: Slice[int]): int">readDataStr(s: Stream; buffer: var string; slice: Slice[int]): int</a></li>
    223. 

  223. 

  224. </ul>
    225. 

  225. <ul class="simple nested-toc-section">readFloat32
    226. 

  226.   <li><a class="reference" href="#readFloat32%2CStream" title="readFloat32(s: Stream): float32">readFloat32(s: Stream): float32</a></li>
    227. 

  227. 

  228. </ul>
    229. 

  229. <ul class="simple nested-toc-section">readFloat64
    230. 

  230.   <li><a class="reference" href="#readFloat64%2CStream" title="readFloat64(s: Stream): float64">readFloat64(s: Stream): float64</a></li>
    231. 

  231. 

  232. </ul>
    233. 

  233. <ul class="simple nested-toc-section">readInt8
    234. 

  234.   <li><a class="reference" href="#readInt8%2CStream" title="readInt8(s: Stream): int8">readInt8(s: Stream): int8</a></li>
    235. 

  235. 

  236. </ul>
    237. 

  237. <ul class="simple nested-toc-section">readInt16
    238. 

  238.   <li><a class="reference" href="#readInt16%2CStream" title="readInt16(s: Stream): int16">readInt16(s: Stream): int16</a></li>
    239. 

  239. 

  240. </ul>
    241. 

  241. <ul class="simple nested-toc-section">readInt32
    242. 

  242.   <li><a class="reference" href="#readInt32%2CStream" title="readInt32(s: Stream): int32">readInt32(s: Stream): int32</a></li>
    243. 

  243. 

  244. </ul>
    245. 

  245. <ul class="simple nested-toc-section">readInt64
    246. 

  246.   <li><a class="reference" href="#readInt64%2CStream" title="readInt64(s: Stream): int64">readInt64(s: Stream): int64</a></li>
    247. 

  247. 

  248. </ul>
    249. 

  249. <ul class="simple nested-toc-section">readLine
    250. 

  250.   <li><a class="reference" href="#readLine%2CStream" title="readLine(s: Stream): string">readLine(s: Stream): string</a></li>
    251. 

  251. <li><a class="reference" href="#readLine%2CStream%2Cstring" title="readLine(s: Stream; line: var string): bool">readLine(s: Stream; line: var string): bool</a></li>
    252. 

  252. 

  253. </ul>
    254. 

  254. <ul class="simple nested-toc-section">readStr
    255. 

  255.   <li><a class="reference" href="#readStr%2CStream%2Cint" title="readStr(s: Stream; length: int): string">readStr(s: Stream; length: int): string</a></li>
    256. 

  256. <li><a class="reference" href="#readStr%2CStream%2Cint%2Cstring" title="readStr(s: Stream; length: int; str: var string)">readStr(s: Stream; length: int; str: var string)</a></li>
    257. 

  257. 

  258. </ul>
    259. 

  259. <ul class="simple nested-toc-section">readUint8
    260. 

  260.   <li><a class="reference" href="#readUint8%2CStream" title="readUint8(s: Stream): uint8">readUint8(s: Stream): uint8</a></li>
    261. 

  261. 

  262. </ul>
    263. 

  263. <ul class="simple nested-toc-section">readUint16
    264. 

  264.   <li><a class="reference" href="#readUint16%2CStream" title="readUint16(s: Stream): uint16">readUint16(s: Stream): uint16</a></li>
    265. 

  265. 

  266. </ul>
    267. 

  267. <ul class="simple nested-toc-section">readUint32
    268. 

  268.   <li><a class="reference" href="#readUint32%2CStream" title="readUint32(s: Stream): uint32">readUint32(s: Stream): uint32</a></li>
    269. 

  269. 

  270. </ul>
    271. 

  271. <ul class="simple nested-toc-section">readUint64
    272. 

  272.   <li><a class="reference" href="#readUint64%2CStream" title="readUint64(s: Stream): uint64">readUint64(s: Stream): uint64</a></li>
    273. 

  273. 

  274. </ul>
    275. 

  275. <ul class="simple nested-toc-section">setPosition
    276. 

  276.   <li><a class="reference" href="#setPosition%2CStream%2Cint" title="setPosition(s: Stream; pos: int)">setPosition(s: Stream; pos: int)</a></li>
    277. 

  277. 

  278. </ul>
    279. 

  279. <ul class="simple nested-toc-section">write
    280. 

  280.   <li><a class="reference" href="#write%2CStream%2Cvarargs%5Bstring%2C%5D" title="write(s: Stream; args: varargs[string, `$`])">write(s: Stream; args: varargs[string, `$`])</a></li>
    281. 

  281. <li><a class="reference" href="#write%2CStream%2Cstring" title="write(s: Stream; x: string)">write(s: Stream; x: string)</a></li>
    282. 

  282. <li><a class="reference" href="#write%2CStream%2CT" title="write[T](s: Stream; x: T)">write[T](s: Stream; x: T)</a></li>
    283. 

  283. 

  284. </ul>
    285. 

  285. <ul class="simple nested-toc-section">writeData
    286. 

  286.   <li><a class="reference" href="#writeData%2CStream%2Cpointer%2Cint" title="writeData(s: Stream; buffer: pointer; bufLen: int)">writeData(s: Stream; buffer: pointer; bufLen: int)</a></li>
    287. 

  287. 

  288. </ul>
    289. 

  289. <ul class="simple nested-toc-section">writeLine
    290. 

  290.   <li><a class="reference" href="#writeLine%2CStream%2Cvarargs%5Bstring%2C%5D" title="writeLine(s: Stream; args: varargs[string, `$`])">writeLine(s: Stream; args: varargs[string, `$`])</a></li>
    291. 

  291. 

  292. </ul>
    293. 

  293. 

  294.     </ul>
    295. 

  295.   </details>
    296. 

  296. </li>
    297. 

  297. <li>
    298. 

  298.   <details open>
    299. 

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

  300.     <ul class="simple simple-toc-section">
    301. 

  301.       <ul class="simple nested-toc-section">lines
    302. 

  302.   <li><a class="reference" href="#lines.i%2CStream" title="lines(s: Stream): string">lines(s: Stream): string</a></li>
    303. 

  303. 

  304. </ul>
    305. 

  305. 

  306.     </ul>
    307. 

  307.   </details>
    308. 

  308. </li>
    309. 

  309. 

  310. </ul>
    311. 

  311. 

  312.   </div>
    313. 

  313.   <div class="nine columns" id="content">
    314. 

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

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

  316. 

  317.     <div id="tocRoot"></div>
    318. 

  318.     
    319. 

  319.     <p class="module-desc"><p>This module provides a stream interface and two implementations thereof: the <a class="reference external" href="#FileStream">FileStream</a> and the <a class="reference external" href="#StringStream">StringStream</a> which implement the stream interface for Nim file objects (<tt class="docutils literal"><span class="pre"><span class="Identifier">File</span></span></tt>) and strings.</p>
    320. 

  320. <p>Other modules may provide other implementations for this standard stream interface.</p>
    321. 

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

  322. Due to the use of <tt class="docutils literal"><span class="pre"><span class="Identifier">pointer</span></span></tt>, the <tt class="docutils literal"><span class="pre"><span class="Identifier">readData</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">peekData</span></span></tt> and</div>
    323. 

  323. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">writeData</span></span></tt> interfaces are not available on the compile-time VM, and must be cast from a <tt class="docutils literal"><span class="pre"><span class="Keyword">ptr</span> <span class="Identifier">string</span></span></tt> on the JS backend. However, <tt class="docutils literal"><span class="pre"><span class="Identifier">readDataStr</span></span></tt> is available generally in place of <tt class="docutils literal"><span class="pre"><span class="Identifier">readData</span></span></tt>.</p>
    324. 

  324. 

  325. <h1><a class="toc-backref" id="basic-usage" href="#basic-usage">Basic usage</a></h1><p>The basic flow of using this module is:</p>
    326. 

  326. <ol class="simple"><li>Open input stream</li>
    327. 

  327. <li>Read or write stream</li>
    328. 

  328. <li>Close stream</li>
    329. 

  329. </ol>
    330. 

  330. 

  331. <h2><a class="toc-backref" id="basic-usage-stringstream-example" href="#basic-usage-stringstream-example">StringStream example</a></h2><p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">streams</span>
    332. 

  332. 

  333. <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="LongStringLit">&quot;&quot;&quot;The first line
    334. 

  334. the second line
    335. 

  335. the third line&quot;&quot;&quot;</span><span class="Punctuation">)</span>
    336. 

  336. 

  337. <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    338. 

  338. 

  339. <span class="Keyword">while</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    340. 

  340.   <span class="Identifier">echo</span> <span class="Identifier">line</span>
    341. 

  341. 

  342. <span class="Comment"># Output:</span>
    343. 

  343. <span class="Comment"># The first line</span>
    344. 

  344. <span class="Comment"># the second line</span>
    345. 

  345. <span class="Comment"># the third line</span>
    346. 

  346. 

  347. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    348. 

  348. 

  349. <h2><a class="toc-backref" id="basic-usage-filestream-example" href="#basic-usage-filestream-example">FileStream example</a></h2><p>Write file stream example:</p>
    350. 

  350. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">streams</span>
    351. 

  351. 

  352. <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmWrite</span><span class="Punctuation">)</span>
    353. 

  353. <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    354. 

  354. 

  355. <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">isNil</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    356. 

  356.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line&quot;</span><span class="Punctuation">)</span>
    357. 

  357.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="StringLit">&quot;the second line&quot;</span><span class="Punctuation">)</span>
    358. 

  358.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="StringLit">&quot;the third line&quot;</span><span class="Punctuation">)</span>
    359. 

  359.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    360. 

  360. 

  361. <span class="Comment"># Output (somefile.txt):</span>
    362. 

  362. <span class="Comment"># The first line</span>
    363. 

  363. <span class="Comment"># the second line</span>
    364. 

  364. <span class="Comment"># the third line</span></pre></p>
    365. 

  365. <p>Read file stream example:</p>
    366. 

  366. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">streams</span>
    367. 

  367. 

  368. <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmRead</span><span class="Punctuation">)</span>
    369. 

  369. <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    370. 

  370. 

  371. <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">isNil</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    372. 

  372.   <span class="Keyword">while</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    373. 

  373.     <span class="Identifier">echo</span> <span class="Identifier">line</span>
    374. 

  374.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    375. 

  375. 

  376. <span class="Comment"># Output:</span>
    377. 

  377. <span class="Comment"># The first line</span>
    378. 

  378. <span class="Comment"># the second line</span>
    379. 

  379. <span class="Comment"># the third line</span></pre></p>
    380. 

  380. 

  381. <h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="asyncstreams.html">asyncstreams module</a></li>
    382. 

  382. <li><a class="reference external" href="syncio.html">io module</a> for <a class="reference external" href="syncio.html#FileMode">FileMode enum</a></li>
    383. 

  383. </ul>
    384. 

  384. </p>
    385. 

  385.     <div class="section" id="6">
    386. 

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

  387.   <dl class="item">
    388. 

  388.     <a class="reference external" href="since.html">since</a>, <a class="reference external" href="syncio.html">syncio</a>
    389. 

  389.   </dl>
    390. 

  390. </div>
    391. 

  391. <div class="section" id="7">
    392. 

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

  393.   <dl class="item">
    394. 

  394.     <div id="FileStream">
    395. 

  395.   <dt><pre><a href="streams.html#FileStream"><span class="Identifier">FileStream</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="streams.html#FileStreamObj"><span class="Identifier">FileStreamObj</span></a></pre></dt>
    396. 

  396.   <dd>
    397. 

  397.     
    398. 

  398.     <p>A stream that encapsulates a <tt class="docutils literal"><span class="pre"><span class="Identifier">File</span></span></tt>.</p>
    399. 

  399. <p><strong>Note:</strong> Not available for JS backend.</p>
    400. 

  400. 

  401.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1325" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    402. 

  402. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1325" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    403. 

  403. 

  404.   </dd>
    405. 

  405. </div>
    406. 

  406. <div id="FileStreamObj">
    407. 

  407.   <dt><pre><a href="streams.html#FileStreamObj"><span class="Identifier">FileStreamObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a></pre></dt>
    408. 

  408.   <dd>
    409. 

  409.     
    410. 

  410.     <p>A file stream object.</p>
    411. 

  411. <p><strong>Note:</strong> Not available for JS backend.</p>
    412. 

  412. 

  413.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1329" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    414. 

  414. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1329" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    415. 

  415. 

  416.   </dd>
    417. 

  417. </div>
    418. 

  418. <div id="Stream">
    419. 

  419.   <dt><pre><a href="streams.html#Stream"><span class="Identifier">Stream</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="streams.html#StreamObj"><span class="Identifier">StreamObj</span></a></pre></dt>
    420. 

  420.   <dd>
    421. 

  421.     
    422. 

  422.     All procedures of this module use this type. Procedures don't directly use <a class="reference external" href="#StreamObj">StreamObj</a>.
    423. 

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

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

  425. 

  426.   </dd>
    427. 

  427. </div>
    428. 

  428. <div id="StreamObj">
    429. 

  429.   <dt><pre><a href="streams.html#StreamObj"><span class="Identifier">StreamObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a>
    430. 

  430.   <span class="Identifier">closeImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    431. 

  431.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    432. 

  432.   <span class="Identifier">atEndImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    433. 

  433.                                        <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    434. 

  434.                                        <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    435. 

  435.   <span class="Identifier">setPositionImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    436. 

  436.       <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    437. 

  437.   <span class="Identifier">getPositionImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    438. 

  438.       <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    439. 

  439.   <span class="Identifier">readDataStrImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</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">slice</span><span class="Other">:</span> <a href="system.html#Slice"><span class="Identifier">Slice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    440. 

  440.       <span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    441. 

  441.   <span class="Identifier">readLineImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    442. 

  442.       <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    443. 

  443.   <span class="Identifier">readDataImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    444. 

  444.       <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    445. 

  445.   <span class="Identifier">peekDataImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    446. 

  446.       <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    447. 

  447.   <span class="Identifier">writeDataImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span>
    448. 

  448.       <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}
    449. 

  449.   <span class="Identifier">flushImpl</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="system.html#Defect"><span class="Identifier">Defect</span></a><span class="Other">,</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a><span class="Other">,</span> <a href="exceptions.html#OSError"><span class="Identifier">OSError</span></a><span class="Other">]</span><span class="Other">,</span>
    450. 

  450.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></span>.}</pre></dt>
    451. 

  451.   <dd>
    452. 

  452.     
    453. 

  453.     <p>Stream interface that supports writing or reading.</p>
    454. 

  454. <p><strong>Note:</strong></p>
    455. 

  455. <ul class="simple"><li>That these fields here shouldn't be used directly. They are accessible so that a stream implementation can override them.</li>
    456. 

  456. </ul>
    457. 

  457. 

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

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

  460. 

  461.   </dd>
    462. 

  462. </div>
    463. 

  463. <div id="StringStream">
    464. 

  464.   <dt><pre><a href="streams.html#StringStream"><span class="Identifier">StringStream</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="streams.html#StringStreamObj"><span class="Identifier">StringStreamObj</span></a></pre></dt>
    465. 

  465.   <dd>
    466. 

  466.     
    467. 

  467.     A stream that encapsulates a string.
    468. 

  468.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1148" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    469. 

  469. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1148" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    470. 

  470. 

  471.   </dd>
    472. 

  472. </div>
    473. 

  473. <div id="StringStreamObj">
    474. 

  474.   <dt><pre><a href="streams.html#StringStreamObj"><span class="Identifier">StringStreamObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="streams.html#StreamObj"><span class="Identifier">StreamObj</span></a>
    475. 

  475.   <span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>              <span class="Comment">## A string data.</span>
    476. 

  476.                              <span class="Comment">## This is updated when called `writeLine` etc.</span></pre></dt>
    477. 

  477.   <dd>
    478. 

  478.     
    479. 

  479.     A string stream object.
    480. 

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

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

  482. 

  483.   </dd>
    484. 

  484. </div>
    485. 

  485. 

  486.   </dl>
    487. 

  487. </div>
    488. 

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

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

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

  491.     <div id="atEnd-procs-all">
    492. 

  492.   <div id="atEnd,Stream">
    493. 

  493.   <dt><pre><span class="Keyword">proc</span> <a href="#atEnd%2CStream"><span class="Identifier">atEnd</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    494. 

  494.   <dd>
    495. 

  495.     
    496. 

  496.     Checks if more data can be read from <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Returns <tt class="docutils literal"><span class="pre">true</span></tt> if all data has been read.
    497. 

  497. <p><strong class="examples_text">Example:</strong></p>
    498. 

  498. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    499. 

  499. <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    500. 

  500. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">atEnd</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    501. 

  501. <span class="Keyword">while</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    502. 

  502.   <span class="Keyword">discard</span>
    503. 

  503. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">atEnd</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    504. 

  504. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    505. 

  505.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L197" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    506. 

  506. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L197" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    507. 

  507. 

  508.   </dd>
    509. 

  509. </div>
    510. 

  510. 

  511. </div>
    512. 

  512. <div id="close-procs-all">
    513. 

  513.   <div id="close,Stream">
    514. 

  514.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CStream"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    515. 

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

  516.   <dd>
    517. 

  517.     
    518. 

  518.     <p>Closes the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    519. 

  519. <p>See also:</p>
    520. 

  520. <ul class="simple"><li><a class="reference external" href="#flush,Stream">flush proc</a></li>
    521. 

  521. </ul>
    522. 

  522. 

  523. <p><strong class="examples_text">Example:</strong></p>
    524. 

  524. <pre class="listing"><span class="Keyword">block</span><span class="Punctuation">:</span>
    525. 

  525.   <span class="Keyword">let</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    526. 

  526.   <span class="Comment">## do something...</span>
    527. 

  527.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    528. 

  528. 

  529. <span class="Keyword">block</span><span class="Punctuation">:</span>
    530. 

  530.   <span class="Keyword">let</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;amissingfile.txt&quot;</span><span class="Punctuation">)</span>
    531. 

  531.   <span class="Comment"># deferring works even if newFileStream fails</span>
    532. 

  532.   <span class="Keyword">defer</span><span class="Punctuation">:</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    533. 

  533.   <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">isNil</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    534. 

  534.     <span class="Comment">## do something...</span></pre>
    535. 

  535.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L176" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    536. 

  536. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L176" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    537. 

  537. 

  538.   </dd>
    539. 

  539. </div>
    540. 

  540. 

  541. </div>
    542. 

  542. <div id="flush-procs-all">
    543. 

  543.   <div id="flush,Stream">
    544. 

  544.   <dt><pre><span class="Keyword">proc</span> <a href="#flush%2CStream"><span class="Identifier">flush</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    545. 

  545.                         <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>Flushes the buffers that the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> might use.</p>
    549. 

  549. <p>This procedure causes any unwritten data for that stream to be delivered to the host environment to be written to the file.</p>
    550. 

  550. <p>See also:</p>
    551. 

  551. <ul class="simple"><li><a class="reference external" href="#close,Stream">close proc</a></li>
    552. 

  552. </ul>
    553. 

  553. 

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

  555. <pre class="listing"><span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span> <span class="Keyword">import</span> <span class="Identifier">removeFile</span>
    556. 

  556. 

  557. <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmWrite</span><span class="Punctuation">)</span>
    558. 

  558. 

  559. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;Before write:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">readFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;Before write:&quot;</span>
    560. 

  560. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="StringLit">&quot;hello&quot;</span><span class="Punctuation">)</span>
    561. 

  561. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;After  write:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">readFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;After  write:&quot;</span>
    562. 

  562. 

  563. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    564. 

  564. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;After  flush:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">readFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;After  flush:hello&quot;</span>
    565. 

  565. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="StringLit">&quot;HELLO&quot;</span><span class="Punctuation">)</span>
    566. 

  566. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    567. 

  567. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;After  flush:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">readFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;After  flush:helloHELLO&quot;</span>
    568. 

  568. 

  569. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    570. 

  570. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;After  close:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">readFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;After  close:helloHELLO&quot;</span>
    571. 

  571. <span class="Identifier">removeFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span></pre>
    572. 

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

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

  574. 

  575.   </dd>
    576. 

  576. </div>
    577. 

  577. 

  578. </div>
    579. 

  579. <div id="getPosition-procs-all">
    580. 

  580.   <div id="getPosition,Stream">
    581. 

  581.   <dt><pre><span class="Keyword">proc</span> <a href="#getPosition%2CStream"><span class="Identifier">getPosition</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</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>
    582. 

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

  583.   <dd>
    584. 

  584.     
    585. 

  585.     Retrieves the current position in the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
    586. 

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

  587. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    588. 

  588. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">getPosition</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    589. 

  589. <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    590. 

  590. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">getPosition</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">15</span>
    591. 

  591. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    592. 

  592.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L223" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    593. 

  593. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L223" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    594. 

  594. 

  595.   </dd>
    596. 

  596. </div>
    597. 

  597. 

  598. </div>
    599. 

  599. <div id="newFileStream-procs-all">
    600. 

  600.   <div id="newFileStream,File">
    601. 

  601.   <dt><pre><span class="Keyword">proc</span> <a href="#newFileStream%2CFile"><span class="Identifier">newFileStream</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span> <span class="Identifier">FileStream</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>
    602. 

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

  603.   <dd>
    604. 

  604.     
    605. 

  605.     <p>Creates a new stream from the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>.</p>
    606. 

  606. <p><strong>Note:</strong> Not available for JS backend.</p>
    607. 

  607. <p>See also:</p>
    608. 

  608. <ul class="simple"><li><a class="reference external" href="#newStringStream,string">newStringStream proc</a> creates a new stream from string.</li>
    609. 

  609. <li><a class="reference external" href="#newFileStream,string,FileMode,int">newFileStream proc</a> is the same as using <a class="reference external" href="syncio.html#open,File,string,FileMode,int">open proc</a> on Examples.</li>
    610. 

  610. <li><a class="reference external" href="#openFileStream,string,FileMode,int">openFileStream proc</a> creates a file stream from the file name and the mode.</li>
    611. 

  611. </ul>
    612. 

  612. 

  613. <p><strong class="examples_text">Example:</strong></p>
    614. 

  614. <pre class="listing"><span class="Comment">## Input (somefile.txt):</span>
    615. 

  615. <span class="Comment">## The first line</span>
    616. 

  616. <span class="Comment">## the second line</span>
    617. 

  617. <span class="Comment">## the third line</span>
    618. 

  618. <span class="Keyword">var</span> <span class="Identifier">f</span><span class="Punctuation">:</span> <span class="Identifier">File</span>
    619. 

  619. <span class="Keyword">if</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">f</span><span class="Punctuation">,</span> <span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmRead</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    620. 

  620.   <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="Identifier">f</span><span class="Punctuation">)</span>
    621. 

  621.   <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    622. 

  622.   <span class="Keyword">while</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    623. 

  623.     <span class="Identifier">echo</span> <span class="Identifier">line</span>
    624. 

  624.   <span class="Comment">## Output:</span>
    625. 

  625.   <span class="Comment">## The first line</span>
    626. 

  626.   <span class="Comment">## the second line</span>
    627. 

  627.   <span class="Comment">## the third line</span>
    628. 

  628.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    629. 

  629.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1362" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    630. 

  630. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1362" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    631. 

  631. 

  632.   </dd>
    633. 

  633. </div>
    634. 

  634. <div id="newFileStream,string,FileMode,int">
    635. 

  635.   <dt><pre><span class="Keyword">proc</span> <a href="#newFileStream%2Cstring%2CFileMode%2Cint"><span class="Identifier">newFileStream</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">mode</span><span class="Other">:</span> <a href="syncio.html#FileMode"><span class="Identifier">FileMode</span></a> <span class="Other">=</span> <span class="Identifier">fmRead</span><span class="Other">;</span> <span class="Identifier">bufSize</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span>
    636. 

  636.     <span class="Identifier">FileStream</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>
    637. 

  637.   <dd>
    638. 

  638.     
    639. 

  639.     <p>Creates a new stream from the file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> with the mode <tt class="docutils literal"><span class="pre"><span class="Identifier">mode</span></span></tt>.</p>
    640. 

  640. <p>If the file cannot be opened, <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt> is returned. See the <a class="reference external" href="syncio.html">io module</a> for a list of available <a class="reference external" href="syncio.html#FileMode">FileMode enums</a>.</p>
    641. 

  641. <p><strong>Note:</strong></p>
    642. 

  642. <ul class="simple"><li><strong>This function returns nil in case of failure.</strong> To prevent unexpected behavior and ensure proper error handling, use <a class="reference external" href="#openFileStream,string,FileMode,int">openFileStream proc</a> instead.</li>
    643. 

  643. <li>Not available for JS backend.</li>
    644. 

  644. </ul>
    645. 

  645. <p>See also:</p>
    646. 

  646. <ul class="simple"><li><a class="reference external" href="#newStringStream,string">newStringStream proc</a> creates a new stream from string.</li>
    647. 

  647. <li><a class="reference external" href="#newFileStream,File">newFileStream proc</a> creates a file stream from opened File.</li>
    648. 

  648. <li><a class="reference external" href="#openFileStream,string,FileMode,int">openFileStream proc</a> creates a file stream from the file name and the mode.</li>
    649. 

  649. </ul>
    650. 

  650. 

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

  652. <pre class="listing"><span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span> <span class="Keyword">import</span> <span class="Identifier">removeFile</span>
    653. 

  653. <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">,</span> <span class="Identifier">fmWrite</span><span class="Punctuation">)</span>
    654. 

  654. <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">isNil</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    655. 

  655.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line&quot;</span><span class="Punctuation">)</span>
    656. 

  656.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="StringLit">&quot;the second line&quot;</span><span class="Punctuation">)</span>
    657. 

  657.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="StringLit">&quot;the third line&quot;</span><span class="Punctuation">)</span>
    658. 

  658.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    659. 

  659.   <span class="Comment">## Output (somefile.txt)</span>
    660. 

  660.   <span class="Comment">## The first line</span>
    661. 

  661.   <span class="Comment">## the second line</span>
    662. 

  662.   <span class="Comment">## the third line</span>
    663. 

  663.   <span class="Identifier">removeFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span></pre>
    664. 

  664.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1405" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    665. 

  665. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1405" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    666. 

  666. 

  667.   </dd>
    668. 

  668. </div>
    669. 

  669. 

  670. </div>
    671. 

  671. <div id="newStringStream-procs-all">
    672. 

  672.   <div id="newStringStream,sinkstring">
    673. 

  673.   <dt><pre><span class="Keyword">proc</span> <a href="#newStringStream%2Csinkstring"><span class="Identifier">newStringStream</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span> <span class="Identifier">StringStream</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>
    674. 

  674.     <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>
    675. 

  675.   <dd>
    676. 

  676.     
    677. 

  677.     <p>Creates a new stream from the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    678. 

  678. <p>See also:</p>
    679. 

  679. <ul class="simple"><li><a class="reference external" href="#newFileStream,File">newFileStream proc</a> creates a file stream from opened File.</li>
    680. 

  680. <li><a class="reference external" href="#newFileStream,string,FileMode,int">newFileStream proc</a>  creates a file stream from the file name and the mode.</li>
    681. 

  681. <li><a class="reference external" href="#openFileStream,string,FileMode,int">openFileStream proc</a> creates a file stream from the file name and the mode.</li>
    682. 

  682. </ul>
    683. 

  683. 

  684. <p><strong class="examples_text">Example:</strong></p>
    685. 

  685. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    686. 

  686. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    687. 

  687. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;the second line&quot;</span>
    688. 

  688. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;the third line&quot;</span>
    689. 

  689. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    690. 

  690.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1287" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    691. 

  691. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1287" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    692. 

  692. 

  693.   </dd>
    694. 

  694. </div>
    695. 

  695. 

  696. </div>
    697. 

  697. <div id="openFileStream-procs-all">
    698. 

  698.   <div id="openFileStream,string,FileMode,int">
    699. 

  699.   <dt><pre><span class="Keyword">proc</span> <a href="#openFileStream%2Cstring%2CFileMode%2Cint"><span class="Identifier">openFileStream</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">mode</span><span class="Other">:</span> <a href="syncio.html#FileMode"><span class="Identifier">FileMode</span></a> <span class="Other">=</span> <span class="Identifier">fmRead</span><span class="Other">;</span> <span class="Identifier">bufSize</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span>
    700. 

  700.     <span class="Identifier">FileStream</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="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>
    701. 

  701.   <dd>
    702. 

  702.     
    703. 

  703.     <p>Creates a new stream from the file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> with the mode <tt class="docutils literal"><span class="pre"><span class="Identifier">mode</span></span></tt>. If the file cannot be opened, an IO exception is raised.</p>
    704. 

  704. <p><strong>Note:</strong> Not available for JS backend.</p>
    705. 

  705. <p>See also:</p>
    706. 

  706. <ul class="simple"><li><a class="reference external" href="#newStringStream,string">newStringStream proc</a> creates a new stream from string.</li>
    707. 

  707. <li><a class="reference external" href="#newFileStream,File">newFileStream proc</a> creates a file stream from opened File.</li>
    708. 

  708. <li><a class="reference external" href="#newFileStream,string,FileMode,int">newFileStream proc</a>  creates a file stream from the file name and the mode.</li>
    709. 

  709. </ul>
    710. 

  710. 

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

  712. <pre class="listing"><span class="Keyword">try</span><span class="Punctuation">:</span>
    713. 

  713.   <span class="Comment">## Input (somefile.txt):</span>
    714. 

  714.   <span class="Comment">## The first line</span>
    715. 

  715.   <span class="Comment">## the second line</span>
    716. 

  716.   <span class="Comment">## the third line</span>
    717. 

  717.   <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">openFileStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;somefile.txt&quot;</span><span class="Punctuation">)</span>
    718. 

  718.   <span class="Identifier">echo</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    719. 

  719.   <span class="Comment">## Output:</span>
    720. 

  720.   <span class="Comment">## The first line</span>
    721. 

  721.   <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    722. 

  722. <span class="Keyword">except</span><span class="Punctuation">:</span>
    723. 

  723.   <span class="Identifier">stderr</span><span class="Operator">.</span><span class="Identifier">write</span> <span class="Identifier">getCurrentExceptionMsg</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    724. 

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

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

  726. 

  727.   </dd>
    728. 

  728. </div>
    729. 

  729. 

  730. </div>
    731. 

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

  732.   <div id="peek,Stream,T">
    733. 

  733.   <dt><pre><span class="Keyword">proc</span> <a href="#peek%2CStream%2CT"><span class="Identifier">peek</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
    734. 

  734.   <dd>
    735. 

  735.     
    736. 

  736.     <p>Generic peek procedure. Peeks <tt class="docutils literal"><span class="pre"><span class="Identifier">result</span></span></tt> from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    737. 

  737. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    738. 

  738. 

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

  740. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;012&quot;</span><span class="Punctuation">)</span>
    741. 

  741. <span class="Comment">## peekInt</span>
    742. 

  742. <span class="Keyword">var</span> <span class="Identifier">i</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    743. 

  743. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peek</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">)</span>
    744. 

  744. <span class="Identifier">doAssert</span> <span class="Identifier">i</span> <span class="Operator">==</span> <span class="DecNumber">48</span>
    745. 

  745. <span class="Comment">## peekData</span>
    746. 

  746. <span class="Keyword">var</span> <span class="Identifier">buffer</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">]</span>
    747. 

  747. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peek</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">)</span>
    748. 

  748. <span class="Identifier">doAssert</span> <span class="Identifier">buffer</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">'</span><span class="DecNumber">0'</span><span class="Punctuation">,</span> <span class="CharLit">'1'</span><span class="Punctuation">]</span>
    749. 

  749. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    750. 

  750.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L433" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    751. 

  751. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L433" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    752. 

  752. 

  753.   </dd>
    754. 

  754. </div>
    755. 

  755. 

  756. </div>
    757. 

  757. <div id="peekBool-procs-all">
    758. 

  758.   <div id="peekBool,Stream">
    759. 

  759.   <dt><pre><span class="Keyword">proc</span> <a href="#peekBool%2CStream"><span class="Identifier">peekBool</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    760. 

  760.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    761. 

  761.   <dd>
    762. 

  762.     
    763. 

  763.     <p>Peeks a bool from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    764. 

  764. <p>A bool is one byte long and it is <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> for every non-zero (<tt class="docutils literal"><span class="pre"><span class="DecNumber">0000_0000</span></span></tt>) value. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    765. 

  765. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    766. 

  766. 

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

  768. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    769. 

  769. <span class="Comment">## setup for reading data</span>
    770. 

  770. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">true</span><span class="Punctuation">)</span>
    771. 

  771. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">false</span><span class="Punctuation">)</span>
    772. 

  772. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    773. 

  773. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    774. 

  774. <span class="Comment">## get data</span>
    775. 

  775. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    776. 

  776. <span class="Comment">## not false</span>
    777. 

  777. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    778. 

  778. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    779. 

  779. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    780. 

  780. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    781. 

  781.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L517" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    782. 

  782. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L517" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    783. 

  783. 

  784.   </dd>
    785. 

  785. </div>
    786. 

  786. 

  787. </div>
    788. 

  788. <div id="peekChar-procs-all">
    789. 

  789.   <div id="peekChar,Stream">
    790. 

  790.   <dt><pre><span class="Keyword">proc</span> <a href="#peekChar%2CStream"><span class="Identifier">peekChar</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    791. 

  791.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    792. 

  792.   <dd>
    793. 

  793.     
    794. 

  794.     Peeks a char from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred. Returns '\0' as an EOF marker.
    795. 

  795. <p><strong class="examples_text">Example:</strong></p>
    796. 

  796. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;12</span><span class="EscapeSequence">\n</span><span class="StringLit">3&quot;</span><span class="Punctuation">)</span>
    797. 

  797. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'1'</span>
    798. 

  798. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'1'</span>
    799. 

  799. <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readAll</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    800. 

  800. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'\x00'</span>
    801. 

  801. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    802. 

  802.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L473" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    803. 

  803. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L473" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    804. 

  804. 

  805.   </dd>
    806. 

  806. </div>
    807. 

  807. 

  808. </div>
    809. 

  809. <div id="peekData-procs-all">
    810. 

  810.   <div id="peekData,Stream,pointer,int">
    811. 

  811.   <dt><pre><span class="Keyword">proc</span> <a href="#peekData%2CStream%2Cpointer%2Cint"><span class="Identifier">peekData</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    812. 

  812.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    813. 

  813.   <dd>
    814. 

  814.     
    815. 

  815.     <p>Low level proc that reads data into an untyped <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">bufLen</span></span></tt> size without moving stream position.</p>
    816. 

  816. <p><strong>JS note:</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> is treated as a <tt class="docutils literal"><span class="pre">ptr string</span></tt> and written to between <tt class="docutils literal"><span class="pre">0..&lt;bufLen</span></tt>.</p>
    817. 

  817. 

  818. <p><strong class="examples_text">Example:</strong></p>
    819. 

  819. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcde&quot;</span><span class="Punctuation">)</span>
    820. 

  820. <span class="Keyword">var</span> <span class="Identifier">buffer</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">]</span>
    821. 

  821. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekData</span><span class="Punctuation">(</span><span class="Keyword">addr</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="DecNumber">1024</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    822. 

  822. <span class="Identifier">doAssert</span> <span class="Identifier">buffer</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">b</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">', '</span><span class="Operator">\</span><span class="Identifier">x00</span><span class="CharLit">']</span>
    823. 

  823. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">atEnd</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    824. 

  824. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    825. 

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

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

  827. 

  828.   </dd>
    829. 

  829. </div>
    830. 

  830. 

  831. </div>
    832. 

  832. <div id="peekFloat32-procs-all">
    833. 

  833.   <div id="peekFloat32,Stream">
    834. 

  834.   <dt><pre><span class="Keyword">proc</span> <a href="#peekFloat32%2CStream"><span class="Identifier">peekFloat32</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    835. 

  835.                                        <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    836. 

  836.   <dd>
    837. 

  837.     
    838. 

  838.     <p>Peeks a float32 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    839. 

  839. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    840. 

  840. 

  841. <p><strong class="examples_text">Example:</strong></p>
    842. 

  842. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    843. 

  843. <span class="Comment">## setup for reading data</span>
    844. 

  844. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">1'f32</span><span class="Punctuation">)</span>
    845. 

  845. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">2'f32</span><span class="Punctuation">)</span>
    846. 

  846. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    847. 

  847. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    848. 

  848. <span class="Comment">## get data</span>
    849. 

  849. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f32</span>
    850. 

  850. <span class="Comment">## not 2'f32</span>
    851. 

  851. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f32</span>
    852. 

  852. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f32</span>
    853. 

  853. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">2'f32</span>
    854. 

  854. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    855. 

  855.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L884" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    856. 

  856. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L884" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    857. 

  857. 

  858.   </dd>
    859. 

  859. </div>
    860. 

  860. 

  861. </div>
    862. 

  862. <div id="peekFloat64-procs-all">
    863. 

  863.   <div id="peekFloat64,Stream">
    864. 

  864.   <dt><pre><span class="Keyword">proc</span> <a href="#peekFloat64%2CStream"><span class="Identifier">peekFloat64</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    865. 

  865.                                        <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    866. 

  866.   <dd>
    867. 

  867.     
    868. 

  868.     <p>Peeks a float64 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    869. 

  869. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    870. 

  870. 

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

  872. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    873. 

  873. <span class="Comment">## setup for reading data</span>
    874. 

  874. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">1'f64</span><span class="Punctuation">)</span>
    875. 

  875. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">2'f64</span><span class="Punctuation">)</span>
    876. 

  876. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    877. 

  877. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    878. 

  878. <span class="Comment">## get data</span>
    879. 

  879. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f64</span>
    880. 

  880. <span class="Comment">## not 2'f64</span>
    881. 

  881. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f64</span>
    882. 

  882. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f64</span>
    883. 

  883. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">2'f64</span>
    884. 

  884. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    885. 

  885.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L924" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    886. 

  886. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L924" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    887. 

  887. 

  888.   </dd>
    889. 

  889. </div>
    890. 

  890. 

  891. </div>
    892. 

  892. <div id="peekInt8-procs-all">
    893. 

  893.   <div id="peekInt8,Stream">
    894. 

  894.   <dt><pre><span class="Keyword">proc</span> <a href="#peekInt8%2CStream"><span class="Identifier">peekInt8</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    895. 

  895.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    896. 

  896.   <dd>
    897. 

  897.     
    898. 

  898.     <p>Peeks an int8 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    899. 

  899. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    900. 

  900. 

  901. <p><strong class="examples_text">Example:</strong></p>
    902. 

  902. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    903. 

  903. <span class="Comment">## setup for reading data</span>
    904. 

  904. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i8</span><span class="Punctuation">)</span>
    905. 

  905. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i8</span><span class="Punctuation">)</span>
    906. 

  906. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    907. 

  907. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    908. 

  908. <span class="Comment">## get data</span>
    909. 

  909. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i8</span>
    910. 

  910. <span class="Comment">## not 2'i8</span>
    911. 

  911. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i8</span>
    912. 

  912. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i8</span>
    913. 

  913. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i8</span>
    914. 

  914. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    915. 

  915.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L563" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    916. 

  916. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L563" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    917. 

  917. 

  918.   </dd>
    919. 

  919. </div>
    920. 

  920. 

  921. </div>
    922. 

  922. <div id="peekInt16-procs-all">
    923. 

  923.   <div id="peekInt16,Stream">
    924. 

  924.   <dt><pre><span class="Keyword">proc</span> <a href="#peekInt16%2CStream"><span class="Identifier">peekInt16</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    925. 

  925.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    926. 

  926.   <dd>
    927. 

  927.     
    928. 

  928.     <p>Peeks an int16 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    929. 

  929. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    930. 

  930. 

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

  932. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    933. 

  933. <span class="Comment">## setup for reading data</span>
    934. 

  934. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i16</span><span class="Punctuation">)</span>
    935. 

  935. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i16</span><span class="Punctuation">)</span>
    936. 

  936. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    937. 

  937. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    938. 

  938. <span class="Comment">## get data</span>
    939. 

  939. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i16</span>
    940. 

  940. <span class="Comment">## not 2'i16</span>
    941. 

  941. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i16</span>
    942. 

  942. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i16</span>
    943. 

  943. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i16</span>
    944. 

  944. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    945. 

  945.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L603" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    946. 

  946. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L603" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    947. 

  947. 

  948.   </dd>
    949. 

  949. </div>
    950. 

  950. 

  951. </div>
    952. 

  952. <div id="peekInt32-procs-all">
    953. 

  953.   <div id="peekInt32,Stream">
    954. 

  954.   <dt><pre><span class="Keyword">proc</span> <a href="#peekInt32%2CStream"><span class="Identifier">peekInt32</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    955. 

  955.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    956. 

  956.   <dd>
    957. 

  957.     
    958. 

  958.     <p>Peeks an int32 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    959. 

  959. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    960. 

  960. 

  961. <p><strong class="examples_text">Example:</strong></p>
    962. 

  962. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    963. 

  963. <span class="Comment">## setup for reading data</span>
    964. 

  964. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i32</span><span class="Punctuation">)</span>
    965. 

  965. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i32</span><span class="Punctuation">)</span>
    966. 

  966. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    967. 

  967. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    968. 

  968. <span class="Comment">## get data</span>
    969. 

  969. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i32</span>
    970. 

  970. <span class="Comment">## not 2'i32</span>
    971. 

  971. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i32</span>
    972. 

  972. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i32</span>
    973. 

  973. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i32</span>
    974. 

  974. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    975. 

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

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

  977. 

  978.   </dd>
    979. 

  979. </div>
    980. 

  980. 

  981. </div>
    982. 

  982. <div id="peekInt64-procs-all">
    983. 

  983.   <div id="peekInt64,Stream">
    984. 

  984.   <dt><pre><span class="Keyword">proc</span> <a href="#peekInt64%2CStream"><span class="Identifier">peekInt64</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    985. 

  985.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    986. 

  986.   <dd>
    987. 

  987.     
    988. 

  988.     <p>Peeks an int64 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    989. 

  989. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    990. 

  990. 

  991. <p><strong class="examples_text">Example:</strong></p>
    992. 

  992. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    993. 

  993. <span class="Comment">## setup for reading data</span>
    994. 

  994. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i64</span><span class="Punctuation">)</span>
    995. 

  995. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i64</span><span class="Punctuation">)</span>
    996. 

  996. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    997. 

  997. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    998. 

  998. <span class="Comment">## get data</span>
    999. 

  999. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i64</span>
    1000. 

  1000. <span class="Comment">## not 2'i64</span>
    1001. 

  1001. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i64</span>
    1002. 

  1002. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i64</span>
    1003. 

  1003. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i64</span>
    1004. 

  1004. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1005. 

  1005.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L683" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1006. 

  1006. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L683" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1007. 

  1007. 

  1008.   </dd>
    1009. 

  1009. </div>
    1010. 

  1010. 

  1011. </div>
    1012. 

  1012. <div id="peekLine-procs-all">
    1013. 

  1013.   <div id="peekLine,Stream">
    1014. 

  1014.   <dt><pre><span class="Keyword">proc</span> <a href="#peekLine%2CStream"><span class="Identifier">peekLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1015. 

  1015.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1016. 

  1016.   <dd>
    1017. 

  1017.     
    1018. 

  1018.     <p>Peeks a line from a stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1019. 

  1019. <p><strong>Note:</strong> This is not very efficient.</p>
    1020. 

  1020. <p>See also:</p>
    1021. 

  1021. <ul class="simple"><li><a class="reference external" href="#readLine,Stream">readLine(Stream) proc</a></li>
    1022. 

  1022. <li><a class="reference external" href="#readLine,Stream,string">readLine(Stream, string) proc</a></li>
    1023. 

  1023. <li><a class="reference external" href="#peekLine,Stream,string">peekLine(Stream, string) proc</a></li>
    1024. 

  1024. </ul>
    1025. 

  1025. 

  1026. <p><strong class="examples_text">Example:</strong></p>
    1027. 

  1027. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1028. 

  1028. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1029. 

  1029. <span class="Comment">## not &quot;the second line&quot;</span>
    1030. 

  1030. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1031. 

  1031. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1032. 

  1032. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;the second line&quot;</span>
    1033. 

  1033. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1034. 

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

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

  1036. 

  1037.   </dd>
    1038. 

  1038. </div>
    1039. 

  1039. <div id="peekLine,Stream,string">
    1040. 

  1040.   <dt><pre><span class="Keyword">proc</span> <a href="#peekLine%2CStream%2Cstring"><span class="Identifier">peekLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1041. 

  1041.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1042. 

  1042.   <dd>
    1043. 

  1043.     
    1044. 

  1044.     <p>Peeks a line of text from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> must not be <tt class="docutils literal"><span class="pre">nil</span></tt>! May throw an IO exception.</p>
    1045. 

  1045. <p>A line of text may be delimited by <tt class="docutils literal"><span class="pre">CR</span></tt>, <tt class="docutils literal"><span class="pre">LF</span></tt> or <tt class="docutils literal"><span class="pre">CRLF</span></tt>. The newline character(s) are not part of the returned string. Returns <tt class="docutils literal"><span class="pre">false</span></tt> if the end of the file has been reached, <tt class="docutils literal"><span class="pre">true</span></tt> otherwise. If <tt class="docutils literal"><span class="pre">false</span></tt> is returned <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> contains no new data.</p>
    1046. 

  1046. <p>See also:</p>
    1047. 

  1047. <ul class="simple"><li><a class="reference external" href="#readLine,Stream">readLine(Stream) proc</a></li>
    1048. 

  1048. <li><a class="reference external" href="#readLine,Stream,string">readLine(Stream, string) proc</a></li>
    1049. 

  1049. <li><a class="reference external" href="#peekLine,Stream">peekLine(Stream) proc</a></li>
    1050. 

  1050. </ul>
    1051. 

  1051. 

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

  1053. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1054. 

  1054. <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    1055. 

  1055. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1056. 

  1056. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1057. 

  1057. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1058. 

  1058. <span class="Comment">## not &quot;the second line&quot;</span>
    1059. 

  1059. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1060. 

  1060. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1061. 

  1061. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1062. 

  1062. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1063. 

  1063. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;the second line&quot;</span>
    1064. 

  1064. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1065. 

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

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

  1067. 

  1068.   </dd>
    1069. 

  1069. </div>
    1070. 

  1070. 

  1071. </div>
    1072. 

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

  1073.   <div id="peekStr,Stream,int">
    1074. 

  1074.   <dt><pre><span class="Keyword">proc</span> <a href="#peekStr%2CStream%2Cint"><span class="Identifier">peekStr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1075. 

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

  1076.   <dd>
    1077. 

  1077.     
    1078. 

  1078.     Peeks a string of length <tt class="docutils literal"><span class="pre"><span class="Identifier">length</span></span></tt> from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.
    1079. 

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

  1080. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcde&quot;</span><span class="Punctuation">)</span>
    1081. 

  1081. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ab&quot;</span>
    1082. 

  1082. <span class="Comment">## not &quot;cd</span>
    1083. 

  1083. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ab&quot;</span>
    1084. 

  1084. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ab&quot;</span>
    1085. 

  1085. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;cd&quot;</span>
    1086. 

  1086. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1087. 

  1087.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L988" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1088. 

  1088. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L988" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1089. 

  1089. 

  1090.   </dd>
    1091. 

  1091. </div>
    1092. 

  1092. <div id="peekStr,Stream,int,string">
    1093. 

  1093.   <dt><pre><span class="Keyword">proc</span> <a href="#peekStr%2CStream%2Cint%2Cstring"><span class="Identifier">peekStr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">str</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> {.
    1094. 

  1094.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1095. 

  1095.   <dd>
    1096. 

  1096.     
    1097. 

  1097.     Peeks a string of length <tt class="docutils literal"><span class="pre"><span class="Identifier">length</span></span></tt> from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.
    1098. 

  1098.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L983" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1099. 

  1099. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L983" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1100. 

  1100. 

  1101.   </dd>
    1102. 

  1102. </div>
    1103. 

  1103. 

  1104. </div>
    1105. 

  1105. <div id="peekUint8-procs-all">
    1106. 

  1106.   <div id="peekUint8,Stream">
    1107. 

  1107.   <dt><pre><span class="Keyword">proc</span> <a href="#peekUint8%2CStream"><span class="Identifier">peekUint8</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1108. 

  1108.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1109. 

  1109.   <dd>
    1110. 

  1110.     
    1111. 

  1111.     <p>Peeks an uint8 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1112. 

  1112. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    1113. 

  1113. 

  1114. <p><strong class="examples_text">Example:</strong></p>
    1115. 

  1115. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1116. 

  1116. <span class="Comment">## setup for reading data</span>
    1117. 

  1117. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u8</span><span class="Punctuation">)</span>
    1118. 

  1118. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u8</span><span class="Punctuation">)</span>
    1119. 

  1119. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1120. 

  1120. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1121. 

  1121. <span class="Comment">## get data</span>
    1122. 

  1122. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u8</span>
    1123. 

  1123. <span class="Comment">## not 2'u8</span>
    1124. 

  1124. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u8</span>
    1125. 

  1125. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u8</span>
    1126. 

  1126. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u8</span>
    1127. 

  1127. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1128. 

  1128.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L723" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1129. 

  1129. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L723" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1130. 

  1130. 

  1131.   </dd>
    1132. 

  1132. </div>
    1133. 

  1133. 

  1134. </div>
    1135. 

  1135. <div id="peekUint16-procs-all">
    1136. 

  1136.   <div id="peekUint16,Stream">
    1137. 

  1137.   <dt><pre><span class="Keyword">proc</span> <a href="#peekUint16%2CStream"><span class="Identifier">peekUint16</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1138. 

  1138.                                      <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1139. 

  1139.   <dd>
    1140. 

  1140.     
    1141. 

  1141.     <p>Peeks an uint16 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1142. 

  1142. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    1143. 

  1143. 

  1144. <p><strong class="examples_text">Example:</strong></p>
    1145. 

  1145. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1146. 

  1146. <span class="Comment">## setup for reading data</span>
    1147. 

  1147. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u16</span><span class="Punctuation">)</span>
    1148. 

  1148. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u16</span><span class="Punctuation">)</span>
    1149. 

  1149. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1150. 

  1150. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1151. 

  1151. <span class="Comment">## get data</span>
    1152. 

  1152. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u16</span>
    1153. 

  1153. <span class="Comment">## not 2'u16</span>
    1154. 

  1154. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u16</span>
    1155. 

  1155. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u16</span>
    1156. 

  1156. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u16</span>
    1157. 

  1157. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1158. 

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

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

  1160. 

  1161.   </dd>
    1162. 

  1162. </div>
    1163. 

  1163. 

  1164. </div>
    1165. 

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

  1166.   <div id="peekUint32,Stream">
    1167. 

  1167.   <dt><pre><span class="Keyword">proc</span> <a href="#peekUint32%2CStream"><span class="Identifier">peekUint32</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</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="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1169. 

  1169.   <dd>
    1170. 

  1170.     
    1171. 

  1171.     <p>Peeks an uint32 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1172. 

  1172. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    1173. 

  1173. 

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

  1175. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1176. 

  1176. <span class="Comment">## setup for reading data</span>
    1177. 

  1177. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u32</span><span class="Punctuation">)</span>
    1178. 

  1178. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u32</span><span class="Punctuation">)</span>
    1179. 

  1179. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1180. 

  1180. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1181. 

  1181. <span class="Comment">## get data</span>
    1182. 

  1182. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u32</span>
    1183. 

  1183. <span class="Comment">## not 2'u32</span>
    1184. 

  1184. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u32</span>
    1185. 

  1185. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u32</span>
    1186. 

  1186. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u32</span>
    1187. 

  1187. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1188. 

  1188.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L804" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1189. 

  1189. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L804" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1190. 

  1190. 

  1191.   </dd>
    1192. 

  1192. </div>
    1193. 

  1193. 

  1194. </div>
    1195. 

  1195. <div id="peekUint64-procs-all">
    1196. 

  1196.   <div id="peekUint64,Stream">
    1197. 

  1197.   <dt><pre><span class="Keyword">proc</span> <a href="#peekUint64%2CStream"><span class="Identifier">peekUint64</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1198. 

  1198.                                      <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1199. 

  1199.   <dd>
    1200. 

  1200.     
    1201. 

  1201.     <p>Peeks an uint64 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1202. 

  1202. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#peekStr,Stream,int">peekStr</a> for now.</p>
    1203. 

  1203. 

  1204. <p><strong class="examples_text">Example:</strong></p>
    1205. 

  1205. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1206. 

  1206. <span class="Comment">## setup for reading data</span>
    1207. 

  1207. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u64</span><span class="Punctuation">)</span>
    1208. 

  1208. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u64</span><span class="Punctuation">)</span>
    1209. 

  1209. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1210. 

  1210. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1211. 

  1211. <span class="Comment">## get data</span>
    1212. 

  1212. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u64</span>
    1213. 

  1213. <span class="Comment">## not 2'u64</span>
    1214. 

  1214. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u64</span>
    1215. 

  1215. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u64</span>
    1216. 

  1216. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">peekUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u64</span>
    1217. 

  1217. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1218. 

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

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

  1220. 

  1221.   </dd>
    1222. 

  1222. </div>
    1223. 

  1223. 

  1224. </div>
    1225. 

  1225. <div id="read-procs-all">
    1226. 

  1226.   <div id="read,Stream,T">
    1227. 

  1227.   <dt><pre><span class="Keyword">proc</span> <a href="#read%2CStream%2CT"><span class="Identifier">read</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
    1228. 

  1228.   <dd>
    1229. 

  1229.     
    1230. 

  1230.     <p>Generic read procedure. Reads <tt class="docutils literal"><span class="pre"><span class="Identifier">result</span></span></tt> from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1231. 

  1231. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1232. 

  1232. 

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

  1234. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;012&quot;</span><span class="Punctuation">)</span>
    1235. 

  1235. <span class="Comment">## readInt</span>
    1236. 

  1236. <span class="Keyword">var</span> <span class="Identifier">i</span><span class="Punctuation">:</span> <span class="Identifier">int8</span>
    1237. 

  1237. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">read</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">)</span>
    1238. 

  1238. <span class="Identifier">doAssert</span> <span class="Identifier">i</span> <span class="Operator">==</span> <span class="DecNumber">48</span>
    1239. 

  1239. <span class="Comment">## readData</span>
    1240. 

  1240. <span class="Keyword">var</span> <span class="Identifier">buffer</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">]</span>
    1241. 

  1241. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">read</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">)</span>
    1242. 

  1242. <span class="Identifier">doAssert</span> <span class="Identifier">buffer</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">'</span><span class="DecNumber">1'</span><span class="Punctuation">,</span> <span class="CharLit">'2'</span><span class="Punctuation">]</span>
    1243. 

  1243. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1244. 

  1244.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L414" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1245. 

  1245. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L414" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1246. 

  1246. 

  1247.   </dd>
    1248. 

  1248. </div>
    1249. 

  1249. 

  1250. </div>
    1251. 

  1251. <div id="readAll-procs-all">
    1252. 

  1252.   <div id="readAll,Stream">
    1253. 

  1253.   <dt><pre><span class="Keyword">proc</span> <a href="#readAll%2CStream"><span class="Identifier">readAll</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1254. 

  1254.                                   <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1255. 

  1255.   <dd>
    1256. 

  1256.     
    1257. 

  1257.     Reads all available data.
    1258. 

  1258. <p><strong class="examples_text">Example:</strong></p>
    1259. 

  1259. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1260. 

  1260. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readAll</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span>
    1261. 

  1261. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">atEnd</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1262. 

  1262. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1263. 

  1263.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L280" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1264. 

  1264. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L280" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1265. 

  1265. 

  1266.   </dd>
    1267. 

  1267. </div>
    1268. 

  1268. 

  1269. </div>
    1270. 

  1270. <div id="readBool-procs-all">
    1271. 

  1271.   <div id="readBool,Stream">
    1272. 

  1272.   <dt><pre><span class="Keyword">proc</span> <a href="#readBool%2CStream"><span class="Identifier">readBool</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1273. 

  1273.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1274. 

  1274.   <dd>
    1275. 

  1275.     
    1276. 

  1276.     <p>Reads a bool from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1277. 

  1277. <p>A bool is one byte long and it is <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> for every non-zero (<tt class="docutils literal"><span class="pre"><span class="DecNumber">0000_0000</span></span></tt>) value. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1278. 

  1278. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1279. 

  1279. 

  1280. <p><strong class="examples_text">Example:</strong></p>
    1281. 

  1281. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1282. 

  1282. <span class="Comment">## setup for reading data</span>
    1283. 

  1283. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">true</span><span class="Punctuation">)</span>
    1284. 

  1284. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="Identifier">false</span><span class="Punctuation">)</span>
    1285. 

  1285. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1286. 

  1286. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1287. 

  1287. <span class="Comment">## get data</span>
    1288. 

  1288. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1289. 

  1289. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    1290. 

  1290. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readBool</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1291. 

  1291. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1292. 

  1292.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L492" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1293. 

  1293. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L492" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1294. 

  1294. 

  1295.   </dd>
    1296. 

  1296. </div>
    1297. 

  1297. 

  1298. </div>
    1299. 

  1299. <div id="readChar-procs-all">
    1300. 

  1300.   <div id="readChar,Stream">
    1301. 

  1301.   <dt><pre><span class="Keyword">proc</span> <a href="#readChar%2CStream"><span class="Identifier">readChar</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1302. 

  1302.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1303. 

  1303.   <dd>
    1304. 

  1304.     
    1305. 

  1305.     <p>Reads a char from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1306. 

  1306. <p>Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred. Returns '\0' as an EOF marker.</p>
    1307. 

  1307. 

  1308. <p><strong class="examples_text">Example:</strong></p>
    1309. 

  1309. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;12</span><span class="EscapeSequence">\n</span><span class="StringLit">3&quot;</span><span class="Punctuation">)</span>
    1310. 

  1310. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'1'</span>
    1311. 

  1311. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'2'</span>
    1312. 

  1312. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'\n'</span>
    1313. 

  1313. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'3'</span>
    1314. 

  1314. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readChar</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'\x00'</span>
    1315. 

  1315. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1316. 

  1316.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L452" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1317. 

  1317. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L452" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1318. 

  1318. 

  1319.   </dd>
    1320. 

  1320. </div>
    1321. 

  1321. 

  1322. </div>
    1323. 

  1323. <div id="readData-procs-all">
    1324. 

  1324.   <div id="readData,Stream,pointer,int">
    1325. 

  1325.   <dt><pre><span class="Keyword">proc</span> <a href="#readData%2CStream%2Cpointer%2Cint"><span class="Identifier">readData</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1326. 

  1326.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1327. 

  1327.   <dd>
    1328. 

  1328.     
    1329. 

  1329.     <p>Low level proc that reads data into an untyped <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">bufLen</span></span></tt> size.</p>
    1330. 

  1330. <p><strong>JS note:</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> is treated as a <tt class="docutils literal"><span class="pre">ptr string</span></tt> and written to between <tt class="docutils literal"><span class="pre">0..&lt;bufLen</span></tt>.</p>
    1331. 

  1331. 

  1332. <p><strong class="examples_text">Example:</strong></p>
    1333. 

  1333. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcde&quot;</span><span class="Punctuation">)</span>
    1334. 

  1334. <span class="Keyword">var</span> <span class="Identifier">buffer</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">]</span>
    1335. 

  1335. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readData</span><span class="Punctuation">(</span><span class="Keyword">addr</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="DecNumber">1024</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    1336. 

  1336. <span class="Identifier">doAssert</span> <span class="Identifier">buffer</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">b</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">', '</span><span class="Operator">\</span><span class="Identifier">x00</span><span class="CharLit">']</span>
    1337. 

  1337. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">atEnd</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1338. 

  1338. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1339. 

  1339.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L234" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1340. 

  1340. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L234" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1341. 

  1341. 

  1342.   </dd>
    1343. 

  1343. </div>
    1344. 

  1344. 

  1345. </div>
    1346. 

  1346. <div id="readDataStr-procs-all">
    1347. 

  1347.   <div id="readDataStr,Stream,string,Slice[int]">
    1348. 

  1348.   <dt><pre><span class="Keyword">proc</span> <a href="#readDataStr%2CStream%2Cstring%2CSlice%5Bint%5D"><span class="Identifier">readDataStr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</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">slice</span><span class="Other">:</span> <a href="system.html#Slice"><span class="Identifier">Slice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1349. 

  1349.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1350. 

  1350.   <dd>
    1351. 

  1351.     
    1352. 

  1352.     Low level proc that reads data into a string <tt class="docutils literal"><span class="pre">buffer</span></tt> at <tt class="docutils literal"><span class="pre">slice</span></tt>.
    1353. 

  1353. <p><strong class="examples_text">Example:</strong></p>
    1354. 

  1354. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcde&quot;</span><span class="Punctuation">)</span>
    1355. 

  1355. <span class="Keyword">var</span> <span class="Identifier">buffer</span> <span class="Operator">=</span> <span class="StringLit">&quot;12345&quot;</span>
    1356. 

  1356. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readDataStr</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">,</span> <span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
    1357. 

  1357. <span class="Identifier">doAssert</span> <span class="Identifier">buffer</span> <span class="Operator">==</span> <span class="StringLit">&quot;abcd5&quot;</span>
    1358. 

  1358. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1359. 

  1359.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L249" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1360. 

  1360. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L249" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1361. 

  1361. 

  1362.   </dd>
    1363. 

  1363. </div>
    1364. 

  1364. 

  1365. </div>
    1366. 

  1366. <div id="readFloat32-procs-all">
    1367. 

  1367.   <div id="readFloat32,Stream">
    1368. 

  1368.   <dt><pre><span class="Keyword">proc</span> <a href="#readFloat32%2CStream"><span class="Identifier">readFloat32</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1369. 

  1369.                                        <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1370. 

  1370.   <dd>
    1371. 

  1371.     
    1372. 

  1372.     <p>Reads a float32 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1373. 

  1373. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1374. 

  1374. 

  1375. <p><strong class="examples_text">Example:</strong></p>
    1376. 

  1376. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1377. 

  1377. <span class="Comment">## setup for reading data</span>
    1378. 

  1378. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">1'f32</span><span class="Punctuation">)</span>
    1379. 

  1379. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">2'f32</span><span class="Punctuation">)</span>
    1380. 

  1380. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1381. 

  1381. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1382. 

  1382. <span class="Comment">## get data</span>
    1383. 

  1383. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f32</span>
    1384. 

  1384. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">2'f32</span>
    1385. 

  1385. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat32</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1386. 

  1386. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1387. 

  1387.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L865" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1388. 

  1388. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L865" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1389. 

  1389. 

  1390.   </dd>
    1391. 

  1391. </div>
    1392. 

  1392. 

  1393. </div>
    1394. 

  1394. <div id="readFloat64-procs-all">
    1395. 

  1395.   <div id="readFloat64,Stream">
    1396. 

  1396.   <dt><pre><span class="Keyword">proc</span> <a href="#readFloat64%2CStream"><span class="Identifier">readFloat64</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1397. 

  1397.                                        <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1398. 

  1398.   <dd>
    1399. 

  1399.     
    1400. 

  1400.     <p>Reads a float64 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1401. 

  1401. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1402. 

  1402. 

  1403. <p><strong class="examples_text">Example:</strong></p>
    1404. 

  1404. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1405. 

  1405. <span class="Comment">## setup for reading data</span>
    1406. 

  1406. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">1'f64</span><span class="Punctuation">)</span>
    1407. 

  1407. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="FloatNumber">2'f64</span><span class="Punctuation">)</span>
    1408. 

  1408. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1409. 

  1409. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1410. 

  1410. <span class="Comment">## get data</span>
    1411. 

  1411. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1'f64</span>
    1412. 

  1412. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">2'f64</span>
    1413. 

  1413. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readFloat64</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1414. 

  1414. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1415. 

  1415.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L905" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1416. 

  1416. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L905" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1417. 

  1417. 

  1418.   </dd>
    1419. 

  1419. </div>
    1420. 

  1420. 

  1421. </div>
    1422. 

  1422. <div id="readInt8-procs-all">
    1423. 

  1423.   <div id="readInt8,Stream">
    1424. 

  1424.   <dt><pre><span class="Keyword">proc</span> <a href="#readInt8%2CStream"><span class="Identifier">readInt8</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1425. 

  1425.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1426. 

  1426.   <dd>
    1427. 

  1427.     
    1428. 

  1428.     <p>Reads an int8 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1429. 

  1429. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1430. 

  1430. 

  1431. <p><strong class="examples_text">Example:</strong></p>
    1432. 

  1432. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1433. 

  1433. <span class="Comment">## setup for reading data</span>
    1434. 

  1434. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i8</span><span class="Punctuation">)</span>
    1435. 

  1435. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i8</span><span class="Punctuation">)</span>
    1436. 

  1436. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1437. 

  1437. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1438. 

  1438. <span class="Comment">## get data</span>
    1439. 

  1439. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i8</span>
    1440. 

  1440. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i8</span>
    1441. 

  1441. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt8</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1442. 

  1442. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1443. 

  1443.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L544" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1444. 

  1444. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L544" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1445. 

  1445. 

  1446.   </dd>
    1447. 

  1447. </div>
    1448. 

  1448. 

  1449. </div>
    1450. 

  1450. <div id="readInt16-procs-all">
    1451. 

  1451.   <div id="readInt16,Stream">
    1452. 

  1452.   <dt><pre><span class="Keyword">proc</span> <a href="#readInt16%2CStream"><span class="Identifier">readInt16</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1453. 

  1453.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1454. 

  1454.   <dd>
    1455. 

  1455.     
    1456. 

  1456.     <p>Reads an int16 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1457. 

  1457. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1458. 

  1458. 

  1459. <p><strong class="examples_text">Example:</strong></p>
    1460. 

  1460. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1461. 

  1461. <span class="Comment">## setup for reading data</span>
    1462. 

  1462. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i16</span><span class="Punctuation">)</span>
    1463. 

  1463. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i16</span><span class="Punctuation">)</span>
    1464. 

  1464. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1465. 

  1465. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1466. 

  1466. <span class="Comment">## get data</span>
    1467. 

  1467. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i16</span>
    1468. 

  1468. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i16</span>
    1469. 

  1469. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt16</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1470. 

  1470. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1471. 

  1471.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L584" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1472. 

  1472. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L584" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1473. 

  1473. 

  1474.   </dd>
    1475. 

  1475. </div>
    1476. 

  1476. 

  1477. </div>
    1478. 

  1478. <div id="readInt32-procs-all">
    1479. 

  1479.   <div id="readInt32,Stream">
    1480. 

  1480.   <dt><pre><span class="Keyword">proc</span> <a href="#readInt32%2CStream"><span class="Identifier">readInt32</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1481. 

  1481.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1482. 

  1482.   <dd>
    1483. 

  1483.     
    1484. 

  1484.     <p>Reads an int32 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1485. 

  1485. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1486. 

  1486. 

  1487. <p><strong class="examples_text">Example:</strong></p>
    1488. 

  1488. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1489. 

  1489. <span class="Comment">## setup for reading data</span>
    1490. 

  1490. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i32</span><span class="Punctuation">)</span>
    1491. 

  1491. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i32</span><span class="Punctuation">)</span>
    1492. 

  1492. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1493. 

  1493. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1494. 

  1494. <span class="Comment">## get data</span>
    1495. 

  1495. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i32</span>
    1496. 

  1496. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i32</span>
    1497. 

  1497. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt32</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1498. 

  1498. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1499. 

  1499.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L624" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1500. 

  1500. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L624" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1501. 

  1501. 

  1502.   </dd>
    1503. 

  1503. </div>
    1504. 

  1504. 

  1505. </div>
    1506. 

  1506. <div id="readInt64-procs-all">
    1507. 

  1507.   <div id="readInt64,Stream">
    1508. 

  1508.   <dt><pre><span class="Keyword">proc</span> <a href="#readInt64%2CStream"><span class="Identifier">readInt64</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1509. 

  1509.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1510. 

  1510.   <dd>
    1511. 

  1511.     
    1512. 

  1512.     <p>Reads an int64 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1513. 

  1513. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1514. 

  1514. 

  1515. <p><strong class="examples_text">Example:</strong></p>
    1516. 

  1516. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1517. 

  1517. <span class="Comment">## setup for reading data</span>
    1518. 

  1518. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'i64</span><span class="Punctuation">)</span>
    1519. 

  1519. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'i64</span><span class="Punctuation">)</span>
    1520. 

  1520. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1521. 

  1521. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1522. 

  1522. <span class="Comment">## get data</span>
    1523. 

  1523. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'i64</span>
    1524. 

  1524. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'i64</span>
    1525. 

  1525. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readInt64</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1526. 

  1526. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1527. 

  1527.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L664" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1528. 

  1528. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L664" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1529. 

  1529. 

  1530.   </dd>
    1531. 

  1531. </div>
    1532. 

  1532. 

  1533. </div>
    1534. 

  1534. <div id="readLine-procs-all">
    1535. 

  1535.   <div id="readLine,Stream">
    1536. 

  1536.   <dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CStream"><span class="Identifier">readLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1537. 

  1537.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1538. 

  1538.   <dd>
    1539. 

  1539.     
    1540. 

  1540.     <p>Reads a line from a stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1541. 

  1541. <p><strong>Note:</strong> This is not very efficient.</p>
    1542. 

  1542. <p>See also:</p>
    1543. 

  1543. <ul class="simple"><li><a class="reference external" href="#readLine,Stream,string">readLine(Stream, string) proc</a></li>
    1544. 

  1544. <li><a class="reference external" href="#peekLine,Stream">peekLine(Stream) proc</a></li>
    1545. 

  1545. <li><a class="reference external" href="#peekLine,Stream,string">peekLine(Stream, string) proc</a></li>
    1546. 

  1546. </ul>
    1547. 

  1547. 

  1548. <p><strong class="examples_text">Example:</strong></p>
    1549. 

  1549. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1550. 

  1550. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1551. 

  1551. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;the second line&quot;</span>
    1552. 

  1552. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;the third line&quot;</span>
    1553. 

  1553. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1554. 

  1554. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1555. 

  1555.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1076" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1556. 

  1556. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1076" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1557. 

  1557. 

  1558.   </dd>
    1559. 

  1559. </div>
    1560. 

  1560. <div id="readLine,Stream,string">
    1561. 

  1561.   <dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CStream%2Cstring"><span class="Identifier">readLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1562. 

  1562.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1563. 

  1563.   <dd>
    1564. 

  1564.     
    1565. 

  1565.     <p>Reads a line of text from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> must not be <tt class="docutils literal"><span class="pre">nil</span></tt>! May throw an IO exception.</p>
    1566. 

  1566. <p>A line of text may be delimited by <tt class="docutils literal"><span class="pre">LF</span></tt> or <tt class="docutils literal"><span class="pre">CRLF</span></tt>. The newline character(s) are not part of the returned string. Returns <tt class="docutils literal"><span class="pre">false</span></tt> if the end of the file has been reached, <tt class="docutils literal"><span class="pre">true</span></tt> otherwise. If <tt class="docutils literal"><span class="pre">false</span></tt> is returned <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> contains no new data.</p>
    1567. 

  1567. <p>See also:</p>
    1568. 

  1568. <ul class="simple"><li><a class="reference external" href="#readLine,Stream">readLine(Stream) proc</a></li>
    1569. 

  1569. <li><a class="reference external" href="#peekLine,Stream">peekLine(Stream) proc</a></li>
    1570. 

  1570. <li><a class="reference external" href="#peekLine,Stream,string">peekLine(Stream, string) proc</a></li>
    1571. 

  1571. </ul>
    1572. 

  1572. 

  1573. <p><strong class="examples_text">Example:</strong></p>
    1574. 

  1574. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1575. 

  1575. <span class="Keyword">var</span> <span class="Identifier">line</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    1576. 

  1576. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1577. 

  1577. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1578. 

  1578. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1579. 

  1579. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;the second line&quot;</span>
    1580. 

  1580. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1581. 

  1581. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;the third line&quot;</span>
    1582. 

  1582. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    1583. 

  1583. <span class="Identifier">doAssert</span> <span class="Identifier">line</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
    1584. 

  1584. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1585. 

  1585.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1002" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1586. 

  1586. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1002" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1587. 

  1587. 

  1588.   </dd>
    1589. 

  1589. </div>
    1590. 

  1590. 

  1591. </div>
    1592. 

  1592. <div id="readStr-procs-all">
    1593. 

  1593.   <div id="readStr,Stream,int">
    1594. 

  1594.   <dt><pre><span class="Keyword">proc</span> <a href="#readStr%2CStream%2Cint"><span class="Identifier">readStr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1595. 

  1595.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1596. 

  1596.   <dd>
    1597. 

  1597.     
    1598. 

  1598.     Reads a string of length <tt class="docutils literal"><span class="pre"><span class="Identifier">length</span></span></tt> from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.
    1599. 

  1599. <p><strong class="examples_text">Example:</strong></p>
    1600. 

  1600. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcde&quot;</span><span class="Punctuation">)</span>
    1601. 

  1601. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;ab&quot;</span>
    1602. 

  1602. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;cd&quot;</span>
    1603. 

  1603. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;e&quot;</span>
    1604. 

  1604. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readStr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
    1605. 

  1605. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1606. 

  1606.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L962" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1607. 

  1607. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L962" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1608. 

  1608. 

  1609.   </dd>
    1610. 

  1610. </div>
    1611. 

  1611. <div id="readStr,Stream,int,string">
    1612. 

  1612.   <dt><pre><span class="Keyword">proc</span> <a href="#readStr%2CStream%2Cint%2Cstring"><span class="Identifier">readStr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">str</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> {.
    1613. 

  1613.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1614. 

  1614.   <dd>
    1615. 

  1615.     
    1616. 

  1616.     Reads a string of length <tt class="docutils literal"><span class="pre"><span class="Identifier">length</span></span></tt> from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.
    1617. 

  1617.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L957" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1618. 

  1618. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L957" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1619. 

  1619. 

  1620.   </dd>
    1621. 

  1621. </div>
    1622. 

  1622. 

  1623. </div>
    1624. 

  1624. <div id="readUint8-procs-all">
    1625. 

  1625.   <div id="readUint8,Stream">
    1626. 

  1626.   <dt><pre><span class="Keyword">proc</span> <a href="#readUint8%2CStream"><span class="Identifier">readUint8</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1627. 

  1627.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1628. 

  1628.   <dd>
    1629. 

  1629.     
    1630. 

  1630.     <p>Reads an uint8 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1631. 

  1631. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1632. 

  1632. 

  1633. <p><strong class="examples_text">Example:</strong></p>
    1634. 

  1634. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1635. 

  1635. <span class="Comment">## setup for reading data</span>
    1636. 

  1636. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u8</span><span class="Punctuation">)</span>
    1637. 

  1637. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u8</span><span class="Punctuation">)</span>
    1638. 

  1638. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1639. 

  1639. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1640. 

  1640. <span class="Comment">## get data</span>
    1641. 

  1641. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u8</span>
    1642. 

  1642. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u8</span>
    1643. 

  1643. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint8</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1644. 

  1644. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1645. 

  1645.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L704" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1646. 

  1646. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L704" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1647. 

  1647. 

  1648.   </dd>
    1649. 

  1649. </div>
    1650. 

  1650. 

  1651. </div>
    1652. 

  1652. <div id="readUint16-procs-all">
    1653. 

  1653.   <div id="readUint16,Stream">
    1654. 

  1654.   <dt><pre><span class="Keyword">proc</span> <a href="#readUint16%2CStream"><span class="Identifier">readUint16</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1655. 

  1655.                                      <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1656. 

  1656.   <dd>
    1657. 

  1657.     
    1658. 

  1658.     <p>Reads an uint16 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1659. 

  1659. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1660. 

  1660. 

  1661. <p><strong class="examples_text">Example:</strong></p>
    1662. 

  1662. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1663. 

  1663. <span class="Comment">## setup for reading data</span>
    1664. 

  1664. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u16</span><span class="Punctuation">)</span>
    1665. 

  1665. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u16</span><span class="Punctuation">)</span>
    1666. 

  1666. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1667. 

  1667. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1668. 

  1668. <span class="Comment">## get data</span>
    1669. 

  1669. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u16</span>
    1670. 

  1670. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u16</span>
    1671. 

  1671. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint16</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1672. 

  1672. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1673. 

  1673.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L744" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1674. 

  1674. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L744" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1675. 

  1675. 

  1676.   </dd>
    1677. 

  1677. </div>
    1678. 

  1678. 

  1679. </div>
    1680. 

  1680. <div id="readUint32-procs-all">
    1681. 

  1681.   <div id="readUint32,Stream">
    1682. 

  1682.   <dt><pre><span class="Keyword">proc</span> <a href="#readUint32%2CStream"><span class="Identifier">readUint32</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1683. 

  1683.                                      <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1684. 

  1684.   <dd>
    1685. 

  1685.     
    1686. 

  1686.     <p>Reads an uint32 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1687. 

  1687. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1688. 

  1688. 

  1689. <p><strong class="examples_text">Example:</strong></p>
    1690. 

  1690. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1691. 

  1691. <span class="Comment">## setup for reading data</span>
    1692. 

  1692. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u32</span><span class="Punctuation">)</span>
    1693. 

  1693. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u32</span><span class="Punctuation">)</span>
    1694. 

  1694. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1695. 

  1695. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1696. 

  1696. 

  1697. <span class="Comment">## get data</span>
    1698. 

  1698. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u32</span>
    1699. 

  1699. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u32</span>
    1700. 

  1700. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint32</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1701. 

  1701. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1702. 

  1702.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L784" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1703. 

  1703. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L784" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1704. 

  1704. 

  1705.   </dd>
    1706. 

  1706. </div>
    1707. 

  1707. 

  1708. </div>
    1709. 

  1709. <div id="readUint64-procs-all">
    1710. 

  1710.   <div id="readUint64,Stream">
    1711. 

  1711.   <dt><pre><span class="Keyword">proc</span> <a href="#readUint64%2CStream"><span class="Identifier">readUint64</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1712. 

  1712.                                      <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1713. 

  1713.   <dd>
    1714. 

  1714.     
    1715. 

  1715.     <p>Reads an uint64 from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if an error occurred.</p>
    1716. 

  1716. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#readStr,Stream,int">readStr</a> for now.</p>
    1717. 

  1717. 

  1718. <p><strong class="examples_text">Example:</strong></p>
    1719. 

  1719. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1720. 

  1720. <span class="Comment">## setup for reading data</span>
    1721. 

  1721. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1'</span><span class="Identifier">u64</span><span class="Punctuation">)</span>
    1722. 

  1722. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">2'</span><span class="Identifier">u64</span><span class="Punctuation">)</span>
    1723. 

  1723. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">flush</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1724. 

  1724. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1725. 

  1725. <span class="Comment">## get data</span>
    1726. 

  1726. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1'</span><span class="Identifier">u64</span>
    1727. 

  1727. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2'</span><span class="Identifier">u64</span>
    1728. 

  1728. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">IOError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readUint64</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1729. 

  1729. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1730. 

  1730.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L825" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1731. 

  1731. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L825" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1732. 

  1732. 

  1733.   </dd>
    1734. 

  1734. </div>
    1735. 

  1735. 

  1736. </div>
    1737. 

  1737. <div id="setPosition-procs-all">
    1738. 

  1738.   <div id="setPosition,Stream,int">
    1739. 

  1739.   <dt><pre><span class="Keyword">proc</span> <a href="#setPosition%2CStream%2Cint"><span class="Identifier">setPosition</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</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>
    1740. 

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

  1741.   <dd>
    1742. 

  1742.     
    1743. 

  1743.     Sets the position <tt class="docutils literal"><span class="pre"><span class="Identifier">pos</span></span></tt> of the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
    1744. 

  1744. <p><strong class="examples_text">Example:</strong></p>
    1745. 

  1745. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1746. 

  1746. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span>
    1747. 

  1747. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;first line&quot;</span>
    1748. 

  1748. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1749. 

  1749. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;The first line&quot;</span>
    1750. 

  1750. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1751. 

  1751.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L211" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1752. 

  1752. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L211" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1753. 

  1753. 

  1754.   </dd>
    1755. 

  1755. </div>
    1756. 

  1756. 

  1757. </div>
    1758. 

  1758. <div id="write-procs-all">
    1759. 

  1759.   <div id="write,Stream,varargs[string,]">
    1760. 

  1760.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CStream%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1761. 

  1761.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1762. 

  1762.   <dd>
    1763. 

  1763.     
    1764. 

  1764.     Writes one or more strings to the the stream. No length fields or terminating zeros are written.
    1765. 

  1765. <p><strong class="examples_text">Example:</strong></p>
    1766. 

  1766. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    1767. 

  1767. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span>
    1768. 

  1768. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1769. 

  1769. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1234&quot;</span>
    1770. 

  1770. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1771. 

  1771.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L388" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1772. 

  1772. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L388" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1773. 

  1773. 

  1774.   </dd>
    1775. 

  1775. </div>
    1776. 

  1776. <div id="write,Stream,string">
    1777. 

  1777.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CStream%2Cstring"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1778. 

  1778.                                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1779. 

  1779.   <dd>
    1780. 

  1780.     
    1781. 

  1781.     Writes the string <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. No length field or terminating zero is written.
    1782. 

  1782. <p><strong class="examples_text">Example:</strong></p>
    1783. 

  1783. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    1784. 

  1784. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="StringLit">&quot;THE FIRST LINE&quot;</span><span class="Punctuation">)</span>
    1785. 

  1785. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1786. 

  1786. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readLine</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;THE FIRST LINE&quot;</span>
    1787. 

  1787. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1788. 

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

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

  1790. 

  1791.   </dd>
    1792. 

  1792. </div>
    1793. 

  1793. <div id="write,Stream,T">
    1794. 

  1794.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CStream%2CT"><span class="Identifier">write</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
    1795. 

  1795.   <dd>
    1796. 

  1796.     
    1797. 

  1797.     <p>Generic write procedure. Writes <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Implementation:</p>
    1798. 

  1798. <p><strong>Note:</strong> Not available for JS backend. Use <a class="reference external" href="#write,Stream,string">write(Stream, string)</a> for now.</p>
    1799. 

  1799. <p><pre class="listing"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">writeData</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Identifier">unsafeAddr</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p>
    1800. 

  1800. 

  1801. <p><strong class="examples_text">Example:</strong></p>
    1802. 

  1802. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    1803. 

  1803. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">write</span><span class="Punctuation">(</span><span class="StringLit">&quot;abcde&quot;</span><span class="Punctuation">)</span>
    1804. 

  1804. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1805. 

  1805. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readAll</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;abcde&quot;</span>
    1806. 

  1806. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1807. 

  1807.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L350" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1808. 

  1808. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L350" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1809. 

  1809. 

  1810.   </dd>
    1811. 

  1811. </div>
    1812. 

  1812. 

  1813. </div>
    1814. 

  1814. <div id="writeData-procs-all">
    1815. 

  1815.   <div id="writeData,Stream,pointer,int">
    1816. 

  1816.   <dt><pre><span class="Keyword">proc</span> <a href="#writeData%2CStream%2Cpointer%2Cint"><span class="Identifier">writeData</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.
    1817. 

  1817.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1818. 

  1818.   <dd>
    1819. 

  1819.     
    1820. 

  1820.     <p>Low level proc that writes an untyped <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> of <tt class="docutils literal"><span class="pre"><span class="Identifier">bufLen</span></span></tt> size to the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1821. 

  1821. <p><strong>JS note:</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> is treated as a <tt class="docutils literal"><span class="pre">ptr string</span></tt> and read between <tt class="docutils literal"><span class="pre">0..&lt;bufLen</span></tt>.</p>
    1822. 

  1822. 

  1823. <p><strong class="examples_text">Example:</strong></p>
    1824. 

  1824. <pre class="listing"><span class="Comment">## writeData</span>
    1825. 

  1825. <span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    1826. 

  1826. <span class="Keyword">var</span> <span class="Identifier">buffer</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">b</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">']</span>
    1827. 

  1827. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeData</span><span class="Punctuation">(</span><span class="Keyword">addr</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">buffer</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    1828. 

  1828. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">atEnd</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1829. 

  1829. <span class="Comment">## readData</span>
    1830. 

  1830. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1831. 

  1831. <span class="Keyword">var</span> <span class="Identifier">buffer2</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">]</span>
    1832. 

  1832. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readData</span><span class="Punctuation">(</span><span class="Keyword">addr</span><span class="Punctuation">(</span><span class="Identifier">buffer2</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">buffer2</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    1833. 

  1833. <span class="Identifier">doAssert</span> <span class="Identifier">buffer2</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">', '</span><span class="Identifier">b</span><span class="CharLit">', '</span><span class="Identifier">c</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">', '</span><span class="Operator">\</span><span class="Identifier">x00</span><span class="CharLit">']</span>
    1834. 

  1834. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1835. 

  1835.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L329" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1836. 

  1836. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L329" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1837. 

  1837. 

  1838.   </dd>
    1839. 

  1839. </div>
    1840. 

  1840. 

  1841. </div>
    1842. 

  1842. <div id="writeLine-procs-all">
    1843. 

  1843.   <div id="writeLine,Stream,varargs[string,]">
    1844. 

  1844.   <dt><pre><span class="Keyword">proc</span> <a href="#writeLine%2CStream%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">writeLine</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.
    1845. 

  1845.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1846. 

  1846.   <dd>
    1847. 

  1847.     
    1848. 

  1848.     Writes one or more strings to the the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> followed by a new line. No length field or terminating zero is written.
    1849. 

  1849. <p><strong class="examples_text">Example:</strong></p>
    1850. 

  1850. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    1851. 

  1851. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span>
    1852. 

  1852. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span>
    1853. 

  1853. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">setPosition</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
    1854. 

  1854. <span class="Identifier">doAssert</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">readAll</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;12</span><span class="EscapeSequence">\n</span><span class="StringLit">34</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span>
    1855. 

  1855. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1856. 

  1856.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L400" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1857. 

  1857. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L400" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1858. 

  1858. 

  1859.   </dd>
    1860. 

  1860. </div>
    1861. 

  1861. 

  1862. </div>
    1863. 

  1863. 

  1864.   </dl>
    1865. 

  1865. </div>
    1866. 

  1866. <div class="section" id="15">
    1867. 

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

  1868.   <dl class="item">
    1869. 

  1869.     <div id="lines-iterators-all">
    1870. 

  1870.   <div id="lines.i,Stream">
    1871. 

  1871.   <dt><pre><span class="Keyword">iterator</span> <a href="#lines.i%2CStream"><span class="Identifier">lines</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    1872. 

  1872.                                     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1873. 

  1873.   <dd>
    1874. 

  1874.     
    1875. 

  1875.     <p>Iterates over every line in the stream. The iteration is based on <tt class="docutils literal"><span class="pre">readLine</span></tt>.</p>
    1876. 

  1876. <p>See also:</p>
    1877. 

  1877. <ul class="simple"><li><a class="reference external" href="#readLine,Stream">readLine(Stream) proc</a></li>
    1878. 

  1878. <li><a class="reference external" href="#readLine,Stream,string">readLine(Stream, string) proc</a></li>
    1879. 

  1879. </ul>
    1880. 

  1880. 

  1881. <p><strong class="examples_text">Example:</strong></p>
    1882. 

  1882. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;The first line</span><span class="EscapeSequence">\n</span><span class="StringLit">the second line</span><span class="EscapeSequence">\n</span><span class="StringLit">the third line&quot;</span><span class="Punctuation">)</span>
    1883. 

  1883. <span class="Keyword">var</span> <span class="Identifier">lines</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
    1884. 

  1884. <span class="Keyword">for</span> <span class="Identifier">line</span> <span class="Keyword">in</span> <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">lines</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    1885. 

  1885.   <span class="Identifier">lines</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Identifier">line</span>
    1886. 

  1886. <span class="Identifier">doAssert</span> <span class="Identifier">lines</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;The first line&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;the second line&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;the third line&quot;</span><span class="Punctuation">]</span>
    1887. 

  1887. <span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
    1888. 

  1888.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/streams.nim#L1128" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1889. 

  1889. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/streams.nim#L1128" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1890. 

  1890. 

  1891.   </dd>
    1892. 

  1892. </div>
    1893. 

  1893. 

  1894. </div>
    1895. 

  1895. 

  1896.   </dl>
    1897. 

  1897. </div>
    1898. 

  1898. 

  1899.   </div>
    1900. 

  1900. </div>
    1901. 

  1901. 

  1902.       <div class="twelve-columns footer">
    1903. 

  1903.         <span class="nim-sprite"></span>
    1904. 

  1904.         <br>
    1905. 

  1905.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:03 UTC</small>
    1906. 

  1906.       </div>
    1907. 

  1907.     </div>
    1908. 

  1908.   </div>
    1909. 

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

  1910.     
    1911. 

  1911. </body>
    1912. 

  1912. </html>
    1913. 

  1913.