首頁 探索 說明
登入
levovix
/
Nim
镜像来自 https://github.com/nim-lang/Nim
關註 1
讚好 0
複刻 1
檔案 問題管理 0 Wiki
分支: gh-pages
分支列表 標籤列表
Nim
/
syncio.html

syncio.html 110 KB
永久連結 文件歷史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014 
  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/syncio</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/syncio</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li>
    55. 

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

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

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

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

  61.       <li><a class="reference" href="#File" title="File = ptr CFile">File</a></li>
    62. 

  62. <li><a class="reference" href="#FileHandle" title="FileHandle = cint">FileHandle</a></li>
    63. 

  63. <li><a class="reference" href="#FileMode" title="FileMode = enum
    64. 

  64.   fmRead,                   ## Open the file for read access only.
    65. 

  65.                              ## If the file does not exist, it will not
    66. 

  66.                              ## be created.
    67. 

  67.   fmWrite,                  ## Open the file for write access only.
    68. 

  68.                              ## If the file does not exist, it will be
    69. 

  69.                              ## created. Existing files will be cleared!
    70. 

  70.   fmReadWrite,              ## Open the file for read and write access.
    71. 

  71.                              ## If the file does not exist, it will be
    72. 

  72.                              ## created. Existing files will be cleared!
    73. 

  73.   fmReadWriteExisting,      ## Open the file for read and write access.
    74. 

  74.                              ## If the file does not exist, it will not be
    75. 

  75.                              ## created. The existing file will not be cleared.
    76. 

  76.   fmAppend                   ## Open the file for writing only; append data
    77. 

  77.                              ## at the end. If the file does not exist, it
    78. 

  78.                              ## will be created.">FileMode</a></li>
    79. 

  79. <li><a class="reference" href="#FileSeekPos" title="FileSeekPos = enum
    80. 

  80.   fspSet,                   ## Seek to absolute value
    81. 

  81.   fspCur,                   ## Seek relative to current position
    82. 

  82.   fspEnd                     ## Seek relative to end">FileSeekPos</a></li>
    83. 

  83. 

  84.     </ul>
    85. 

  85.   </details>
    86. 

  86. </li>
    87. 

  87. <li>
    88. 

  88.   <details open>
    89. 

  89.     <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
    90. 

  90.     <ul class="simple simple-toc-section">
    91. 

  91.       <li><a class="reference" href="#stderr" title="stderr {.importc: &quot;stderr&quot;, header: &quot;&lt;stdio.h&gt;&quot;.}: File">stderr</a></li>
    92. 

  92. <li><a class="reference" href="#stdin" title="stdin {.importc: &quot;stdin&quot;, header: &quot;&lt;stdio.h&gt;&quot;.}: File">stdin</a></li>
    93. 

  93. <li><a class="reference" href="#stdout" title="stdout {.importc: &quot;stdout&quot;, header: &quot;&lt;stdio.h&gt;&quot;.}: File">stdout</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">close
    103. 

  103.   <li><a class="reference" href="#close%2CFile" title="close(f: File)">close(f: File)</a></li>
    104. 

  104. 

  105. </ul>
    106. 

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

  107.   <li><a class="reference" href="#endOfFile%2CFile" title="endOfFile(f: File): bool">endOfFile(f: File): bool</a></li>
    108. 

  108. 

  109. </ul>
    110. 

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

  111.   <li><a class="reference" href="#flushFile%2CFile" title="flushFile(f: File)">flushFile(f: File)</a></li>
    112. 

  112. 

  113. </ul>
    114. 

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

  115.   <li><a class="reference" href="#getFileHandle%2CFile" title="getFileHandle(f: File): FileHandle">getFileHandle(f: File): FileHandle</a></li>
    116. 

  116. 

  117. </ul>
    118. 

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

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

  120. 

  121. </ul>
    122. 

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

  123.   <li><a class="reference" href="#getFileSize%2CFile" title="getFileSize(f: File): int64">getFileSize(f: File): int64</a></li>
    124. 

  124. 

  125. </ul>
    126. 

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

  127.   <li><a class="reference" href="#getOsFileHandle%2CFile" title="getOsFileHandle(f: File): FileHandle">getOsFileHandle(f: File): FileHandle</a></li>
    128. 

  128. 

  129. </ul>
    130. 

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

  131.   <li><a class="reference" href="#open%2CFile%2CFileHandle%2CFileMode" title="open(f: var File; filehandle: FileHandle; mode: FileMode = fmRead): bool">open(f: var File; filehandle: FileHandle; mode: FileMode = fmRead): bool</a></li>
    132. 

  132. <li><a class="reference" href="#open%2CFile%2Cstring%2CFileMode%2Cint" title="open(f: var File; filename: string; mode: FileMode = fmRead; bufSize: int = -1): bool">open(f: var File; filename: string; mode: FileMode = fmRead; bufSize: int = -1): bool</a></li>
    133. 

  133. <li><a class="reference" href="#open%2Cstring%2CFileMode%2Cint" title="open(filename: string; mode: FileMode = fmRead; bufSize: int = -1): File">open(filename: string; mode: FileMode = fmRead; bufSize: int = -1): File</a></li>
    134. 

  134. 

  135. </ul>
    136. 

  136. <ul class="simple nested-toc-section">readAll
    137. 

  137.   <li><a class="reference" href="#readAll%2CFile" title="readAll(file: File): string">readAll(file: File): string</a></li>
    138. 

  138. 

  139. </ul>
    140. 

  140. <ul class="simple nested-toc-section">readBuffer
    141. 

  141.   <li><a class="reference" href="#readBuffer%2CFile%2Cpointer%2CNatural" title="readBuffer(f: File; buffer: pointer; len: Natural): int">readBuffer(f: File; buffer: pointer; len: Natural): int</a></li>
    142. 

  142. 

  143. </ul>
    144. 

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

  145.   <li><a class="reference" href="#readBytes%2CFile%2CopenArray%5B%5D%2CNatural%2CNatural" title="readBytes(f: File; a: var openArray[int8 | uint8]; start, len: Natural): int">readBytes(f: File; a: var openArray[int8 | uint8]; start, len: Natural): int</a></li>
    146. 

  146. 

  147. </ul>
    148. 

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

  149.   <li><a class="reference" href="#readChar%2CFile" title="readChar(f: File): char">readChar(f: File): char</a></li>
    150. 

  150. 

  151. </ul>
    152. 

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

  153.   <li><a class="reference" href="#readChars%2CFile%2CopenArray%5Bchar%5D" title="readChars(f: File; a: var openArray[char]): int">readChars(f: File; a: var openArray[char]): int</a></li>
    154. 

  154. <li><a class="reference" href="#readChars%2CFile%2CopenArray%5Bchar%5D%2CNatural%2CNatural" title="readChars(f: File; a: var openArray[char]; start, len: Natural): int">readChars(f: File; a: var openArray[char]; start, len: Natural): int</a></li>
    155. 

  155. 

  156. </ul>
    157. 

  157. <ul class="simple nested-toc-section">readFile
    158. 

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

  159. 

  160. </ul>
    161. 

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

  162.   <li><a class="reference" href="#readLine%2CFile" title="readLine(f: File): string">readLine(f: File): string</a></li>
    163. 

  163. <li><a class="reference" href="#readLine%2CFile%2Cstring" title="readLine(f: File; line: var string): bool">readLine(f: File; line: var string): bool</a></li>
    164. 

  164. 

  165. </ul>
    166. 

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

  167.   <li><a class="reference" href="#readLines%2Cstring%2CNatural" title="readLines(filename: string; n: Natural): seq[string]">readLines(filename: string; n: Natural): seq[string]</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">reopen
    171. 

  171.   <li><a class="reference" href="#reopen%2CFile%2Cstring%2CFileMode" title="reopen(f: File; filename: string; mode: FileMode = fmRead): bool">reopen(f: File; filename: string; mode: FileMode = fmRead): bool</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">setFilePos
    175. 

  175.   <li><a class="reference" href="#setFilePos%2CFile%2Cint64%2CFileSeekPos" title="setFilePos(f: File; pos: int64; relativeTo: FileSeekPos = fspSet)">setFilePos(f: File; pos: int64; relativeTo: FileSeekPos = fspSet)</a></li>
    176. 

  176. 

  177. </ul>
    178. 

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

  179.   <li><a class="reference" href="#setInheritable%2CFileHandle%2Cbool" title="setInheritable(f: FileHandle; inheritable: bool): bool">setInheritable(f: FileHandle; inheritable: bool): bool</a></li>
    180. 

  180. 

  181. </ul>
    182. 

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

  183.   <li><a class="reference" href="#setStdIoUnbuffered" title="setStdIoUnbuffered()">setStdIoUnbuffered()</a></li>
    184. 

  184. 

  185. </ul>
    186. 

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

  187.   <li><a class="reference" href="#write%2CFile%2Cvarargs%5Bstring%2C%5D" title="write(f: File; a: varargs[string, `$`])">write(f: File; a: varargs[string, `$`])</a></li>
    188. 

  188. <li><a class="reference" href="#write%2CFile%2Cbool" title="write(f: File; b: bool)">write(f: File; b: bool)</a></li>
    189. 

  189. <li><a class="reference" href="#write%2CFile%2Cchar" title="write(f: File; c: char)">write(f: File; c: char)</a></li>
    190. 

  190. <li><a class="reference" href="#write%2CFile%2Ccstring" title="write(f: File; c: cstring)">write(f: File; c: cstring)</a></li>
    191. 

  191. <li><a class="reference" href="#write%2CFile%2CBiggestInt" title="write(f: File; i: BiggestInt)">write(f: File; i: BiggestInt)</a></li>
    192. 

  192. <li><a class="reference" href="#write%2CFile%2Cint" title="write(f: File; i: int)">write(f: File; i: int)</a></li>
    193. 

  193. <li><a class="reference" href="#write%2CFile%2CBiggestFloat" title="write(f: File; r: BiggestFloat)">write(f: File; r: BiggestFloat)</a></li>
    194. 

  194. <li><a class="reference" href="#write%2CFile%2Cfloat32" title="write(f: File; r: float32)">write(f: File; r: float32)</a></li>
    195. 

  195. <li><a class="reference" href="#write%2CFile%2Cstring" title="write(f: File; s: string)">write(f: File; s: string)</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. <ul class="simple nested-toc-section">writeBuffer
    199. 

  199.   <li><a class="reference" href="#writeBuffer%2CFile%2Cpointer%2CNatural" title="writeBuffer(f: File; buffer: pointer; len: Natural): int">writeBuffer(f: File; buffer: pointer; len: Natural): int</a></li>
    200. 

  200. 

  201. </ul>
    202. 

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

  203.   <li><a class="reference" href="#writeBytes%2CFile%2CopenArray%5B%5D%2CNatural%2CNatural" title="writeBytes(f: File; a: openArray[int8 | uint8]; start, len: Natural): int">writeBytes(f: File; a: openArray[int8 | uint8]; start, len: Natural): int</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. <ul class="simple nested-toc-section">writeChars
    207. 

  207.   <li><a class="reference" href="#writeChars%2CFile%2CopenArray%5Bchar%5D%2CNatural%2CNatural" title="writeChars(f: File; a: openArray[char]; start, len: Natural): int">writeChars(f: File; a: openArray[char]; start, len: Natural): int</a></li>
    208. 

  208. 

  209. </ul>
    210. 

  210. <ul class="simple nested-toc-section">writeFile
    211. 

  211.   <li><a class="reference" href="#writeFile%2Cstring%2Cstring" title="writeFile(filename, content: string)">writeFile(filename, content: string)</a></li>
    212. 

  212. <li><a class="reference" href="#writeFile%2Cstring%2CopenArray%5Bbyte%5D" title="writeFile(filename: string; content: openArray[byte])">writeFile(filename: string; content: openArray[byte])</a></li>
    213. 

  213. 

  214. </ul>
    215. 

  215. <ul class="simple nested-toc-section">writeLine
    216. 

  216.   <li><a class="reference" href="#writeLine%2CFile%2Cvarargs%5BTy%2C%5D" title="writeLine[Ty](f: File; x: varargs[Ty, `$`])">writeLine[Ty](f: File; x: varargs[Ty, `$`])</a></li>
    217. 

  217. 

  218. </ul>
    219. 

  219. 

  220.     </ul>
    221. 

  221.   </details>
    222. 

  222. </li>
    223. 

  223. <li>
    224. 

  224.   <details open>
    225. 

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

  226.     <ul class="simple simple-toc-section">
    227. 

  227.       <ul class="simple nested-toc-section">lines
    228. 

  228.   <li><a class="reference" href="#lines.i%2CFile" title="lines(f: File): string">lines(f: File): string</a></li>
    229. 

  229. <li><a class="reference" href="#lines.i%2Cstring" title="lines(filename: string): string">lines(filename: string): string</a></li>
    230. 

  230. 

  231. </ul>
    232. 

  232. 

  233.     </ul>
    234. 

  234.   </details>
    235. 

  235. </li>
    236. 

  236. <li>
    237. 

  237.   <details open>
    238. 

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

  239.     <ul class="simple simple-toc-section">
    240. 

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

  241.   <li><a class="reference" href="#%26%3D.t%2CFile%2Ctyped" title="`&amp;=`(f: File; x: typed)">`&amp;=`(f: File; x: typed)</a></li>
    242. 

  242. 

  243. </ul>
    244. 

  244. <ul class="simple nested-toc-section">readLines
    245. 

  245.   <li><a class="reference" href="#readLines.t%2Cstring" title="readLines(filename: string): seq[string]">readLines(filename: string): seq[string]</a></li>
    246. 

  246. 

  247. </ul>
    248. 

  248. <ul class="simple nested-toc-section">stdmsg
    249. 

  249.   <li><a class="reference" href="#stdmsg.t" title="stdmsg(): File">stdmsg(): File</a></li>
    250. 

  250. 

  251. </ul>
    252. 

  252. 

  253.     </ul>
    254. 

  254.   </details>
    255. 

  255. </li>
    256. 

  256. 

  257. </ul>
    258. 

  258. 

  259.   </div>
    260. 

  260.   <div class="nine columns" id="content">
    261. 

  261.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    262. 

  262. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    263. 

  263. 

  264.     <div id="tocRoot"></div>
    265. 

  265.     
    266. 

  266.     <p class="module-desc">This module implements various synchronized I/O operations.</p>
    267. 

  267.     <div class="section" id="6">
    268. 

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

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

  270.     <a class="reference external" href="since.html">since</a>, <a class="reference external" href="formatfloat.html">formatfloat</a>, <a class="reference external" href="ansi_c.html">ansi_c</a>
    271. 

  271.   </dl>
    272. 

  272. </div>
    273. 

  273. <div class="section" id="7">
    274. 

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

  275.   <dl class="item">
    276. 

  276.     <div id="File">
    277. 

  277.   <dt><pre><a href="syncio.html#File"><span class="Identifier">File</span></a> <span class="Other">=</span> <span class="Keyword">ptr</span> <span class="Identifier">CFile</span></pre></dt>
    278. 

  278.   <dd>
    279. 

  279.     
    280. 

  280.     The type representing a file handle.
    281. 

  281.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L24" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    282. 

  282. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L24" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    283. 

  283. 

  284.   </dd>
    285. 

  285. </div>
    286. 

  286. <div id="FileHandle">
    287. 

  287.   <dt><pre><a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</span></a> <span class="Other">=</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
    288. 

  288.   <dd>
    289. 

  289.     
    290. 

  290.     The type that represents an OS file handle; this is useful for low-level file access.
    291. 

  291.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L43" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    292. 

  292. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L43" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    293. 

  293. 

  294.   </dd>
    295. 

  295. </div>
    296. 

  296. <div id="FileMode">
    297. 

  297.   <dt><pre><a href="syncio.html#FileMode"><span class="Identifier">FileMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    298. 

  298.   <span class="Identifier">fmRead</span><span class="Other">,</span>                   <span class="Comment">## Open the file for read access only.</span>
    299. 

  299.                              <span class="Comment">## If the file does not exist, it will not</span>
    300. 

  300.                              <span class="Comment">## be created.</span>
    301. 

  301.   <span class="Identifier">fmWrite</span><span class="Other">,</span>                  <span class="Comment">## Open the file for write access only.</span>
    302. 

  302.                              <span class="Comment">## If the file does not exist, it will be</span>
    303. 

  303.                              <span class="Comment">## created. Existing files will be cleared!</span>
    304. 

  304.   <span class="Identifier">fmReadWrite</span><span class="Other">,</span>              <span class="Comment">## Open the file for read and write access.</span>
    305. 

  305.                              <span class="Comment">## If the file does not exist, it will be</span>
    306. 

  306.                              <span class="Comment">## created. Existing files will be cleared!</span>
    307. 

  307.   <span class="Identifier">fmReadWriteExisting</span><span class="Other">,</span>      <span class="Comment">## Open the file for read and write access.</span>
    308. 

  308.                              <span class="Comment">## If the file does not exist, it will not be</span>
    309. 

  309.                              <span class="Comment">## created. The existing file will not be cleared.</span>
    310. 

  310.   <span class="Identifier">fmAppend</span>                   <span class="Comment">## Open the file for writing only; append data</span>
    311. 

  311.                              <span class="Comment">## at the end. If the file does not exist, it</span>
    312. 

  312.                              <span class="Comment">## will be created.</span></pre></dt>
    313. 

  313.   <dd>
    314. 

  314.     
    315. 

  315.     The file mode when opening a file.
    316. 

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

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

  318. 

  319.   </dd>
    320. 

  320. </div>
    321. 

  321. <div id="FileSeekPos">
    322. 

  322.   <dt><pre><a href="syncio.html#FileSeekPos"><span class="Identifier">FileSeekPos</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    323. 

  323.   <span class="Identifier">fspSet</span><span class="Other">,</span>                   <span class="Comment">## Seek to absolute value</span>
    324. 

  324.   <span class="Identifier">fspCur</span><span class="Other">,</span>                   <span class="Comment">## Seek relative to current position</span>
    325. 

  325.   <span class="Identifier">fspEnd</span>                     <span class="Comment">## Seek relative to end</span></pre></dt>
    326. 

  326.   <dd>
    327. 

  327.     
    328. 

  328.     Position relative to which seek should happen.
    329. 

  329.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L46" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    330. 

  330. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L46" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    331. 

  331. 

  332.   </dd>
    333. 

  333. </div>
    334. 

  334. 

  335.   </dl>
    336. 

  336. </div>
    337. 

  337. <div class="section" id="8">
    338. 

  338.   <h1><a class="toc-backref" href="#8">Vars</a></h1>
    339. 

  339.   <dl class="item">
    340. 

  340.     <div id="stderr">
    341. 

  341.   <dt><pre><a href="syncio.html#stderr"><span class="Identifier">stderr</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;stderr&quot;</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdio.h&gt;&quot;</span>.}<span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a></pre></dt>
    342. 

  342.   <dd>
    343. 

  343.     
    344. 

  344.     The standard error stream.
    345. 

  345.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L67" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    346. 

  346. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L67" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    347. 

  347. 

  348.   </dd>
    349. 

  349. </div>
    350. 

  350. <div id="stdin">
    351. 

  351.   <dt><pre><a href="syncio.html#stdin"><span class="Identifier">stdin</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;stdin&quot;</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdio.h&gt;&quot;</span>.}<span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a></pre></dt>
    352. 

  352.   <dd>
    353. 

  353.     
    354. 

  354.     The standard input stream.
    355. 

  355.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L63" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    356. 

  356. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L63" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    357. 

  357. 

  358.   </dd>
    359. 

  359. </div>
    360. 

  360. <div id="stdout">
    361. 

  361.   <dt><pre><a href="syncio.html#stdout"><span class="Identifier">stdout</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;stdout&quot;</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdio.h&gt;&quot;</span>.}<span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a></pre></dt>
    362. 

  362.   <dd>
    363. 

  363.     
    364. 

  364.     The standard output stream.
    365. 

  365.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L65" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    366. 

  366. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L65" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    367. 

  367. 

  368.   </dd>
    369. 

  369. </div>
    370. 

  370. 

  371.   </dl>
    372. 

  372. </div>
    373. 

  373. <div class="section" id="12">
    374. 

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

  375.   <dl class="item">
    376. 

  376.     <div id="close-procs-all">
    377. 

  377.   <div id="close,File">
    378. 

  378.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CFile"><span class="Identifier">close</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> </span><span class="Identifier">sideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    379. 

  379.   <dd>
    380. 

  380.     
    381. 

  381.     Closes the file.
    382. 

  382.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    383. 

  383. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    384. 

  384. 

  385.   </dd>
    386. 

  386. </div>
    387. 

  387. 

  388. </div>
    389. 

  389. <div id="endOfFile-procs-all">
    390. 

  390.   <div id="endOfFile,File">
    391. 

  391.   <dt><pre><span class="Keyword">proc</span> <a href="#endOfFile%2CFile"><span class="Identifier">endOfFile</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> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    392. 

  392.   <dd>
    393. 

  393.     
    394. 

  394.     Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> is at the end.
    395. 

  395.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L577" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    396. 

  396. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L577" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    397. 

  397. 

  398.   </dd>
    399. 

  399. </div>
    400. 

  400. 

  401. </div>
    402. 

  402. <div id="flushFile-procs-all">
    403. 

  403.   <div id="flushFile,File">
    404. 

  404.   <dt><pre><span class="Keyword">proc</span> <a href="#flushFile%2CFile"><span class="Identifier">flushFile</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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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">raises</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>
    405. 

  405.   <dd>
    406. 

  406.     
    407. 

  407.     Flushes <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>'s buffer.
    408. 

  408.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L354" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    409. 

  409. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L354" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    410. 

  410. 

  411.   </dd>
    412. 

  412. </div>
    413. 

  413. 

  414. </div>
    415. 

  415. <div id="getFileHandle-procs-all">
    416. 

  416.   <div id="getFileHandle,File">
    417. 

  417.   <dt><pre><span class="Keyword">proc</span> <a href="#getFileHandle%2CFile"><span class="Identifier">getFileHandle</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> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    418. 

  418.   <dd>
    419. 

  419.     
    420. 

  420.     Returns the file handle of the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. This is only useful for platform specific programming. Note that on Windows this doesn't return the Windows-specific handle, but the C library's notion of a handle, whatever that means. Use <tt class="docutils literal"><span class="pre"><span class="Identifier">getOsFileHandle</span></span></tt> instead.
    421. 

  421.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    422. 

  422. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    423. 

  423. 

  424.   </dd>
    425. 

  425. </div>
    426. 

  426. 

  427. </div>
    428. 

  428. <div id="getFilePos-procs-all">
    429. 

  429.   <div id="getFilePos,File">
    430. 

  430.   <dt><pre><span class="Keyword">proc</span> <a href="#getFilePos%2CFile"><span class="Identifier">getFilePos</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> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="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>
    431. 

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

  432.   <dd>
    433. 

  433.     
    434. 

  434.     Retrieves the current position of the file pointer that is used to read from the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. The file's first byte has the index zero.
    435. 

  435.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L796" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    436. 

  436. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L796" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    437. 

  437. 

  438.   </dd>
    439. 

  439. </div>
    440. 

  440. 

  441. </div>
    442. 

  442. <div id="getFileSize-procs-all">
    443. 

  443.   <div id="getFileSize,File">
    444. 

  444.   <dt><pre><span class="Keyword">proc</span> <a href="#getFileSize%2CFile"><span class="Identifier">getFileSize</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> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    445. 

  445.                                    <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    446. 

  446.   <dd>
    447. 

  447.     
    448. 

  448.     Retrieves the file size (in bytes) of <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>.
    449. 

  449.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L802" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    450. 

  450. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L802" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    451. 

  451. 

  452.   </dd>
    453. 

  453. </div>
    454. 

  454. 

  455. </div>
    456. 

  456. <div id="getOsFileHandle-procs-all">
    457. 

  457.   <div id="getOsFileHandle,File">
    458. 

  458.   <dt><pre><span class="Keyword">proc</span> <a href="#getOsFileHandle%2CFile"><span class="Identifier">getOsFileHandle</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> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    459. 

  459.   <dd>
    460. 

  460.     
    461. 

  461.     Returns the OS file handle of the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. This is only useful for platform specific programming.
    462. 

  462.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L366" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    463. 

  463. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L366" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    464. 

  464. 

  465.   </dd>
    466. 

  466. </div>
    467. 

  467. 

  468. </div>
    469. 

  469. <div id="open-procs-all">
    470. 

  470.   <div id="open,File,FileHandle,FileMode">
    471. 

  471.   <dt><pre><span class="Keyword">proc</span> <a href="#open%2CFile%2CFileHandle%2CFileMode"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="syncio.html#File"><span class="Identifier">File</span></a><span class="Other">;</span> <span class="Identifier">filehandle</span><span class="Other">:</span> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</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="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    472. 

  472.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</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>
    473. 

  473.   <dd>
    474. 

  474.     
    475. 

  475.     <p>Creates a <tt class="docutils literal"><span class="pre"><span class="Identifier">File</span></span></tt> from a <tt class="docutils literal"><span class="pre"><span class="Identifier">filehandle</span></span></tt> with given <tt class="docutils literal"><span class="pre"><span class="Identifier">mode</span></span></tt>.</p>
    476. 

  476. <p>Default mode is readonly. Returns true if the file could be opened.</p>
    477. 

  477. <p>The passed file handle will no longer be inheritable.</p>
    478. 

  478. 

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

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

  481. 

  482.   </dd>
    483. 

  483. </div>
    484. 

  484. <div id="open,File,string,FileMode,int">
    485. 

  485.   <dt><pre><span class="Keyword">proc</span> <a href="#open%2CFile%2Cstring%2CFileMode%2Cint"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="syncio.html#File"><span class="Identifier">File</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>
    486. 

  486.           <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> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</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>
    487. 

  487.   <dd>
    488. 

  488.     
    489. 

  489.     <p>Opens a file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> with given <tt class="docutils literal"><span class="pre"><span class="Identifier">mode</span></span></tt>.</p>
    490. 

  490. <p>Default mode is readonly. Returns true if the file could be opened. This throws no exception if the file could not be opened.</p>
    491. 

  491. <p>The file handle associated with the resulting <tt class="docutils literal"><span class="pre"><span class="Identifier">File</span></span></tt> is not inheritable.</p>
    492. 

  492. 

  493.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L709" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    494. 

  494. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L709" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    495. 

  495. 

  496.   </dd>
    497. 

  497. </div>
    498. 

  498. <div id="open,string,FileMode,int">
    499. 

  499.   <dt><pre><span class="Keyword">proc</span> <a href="#open%2Cstring%2CFileMode%2Cint"><span class="Identifier">open</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> <a href="syncio.html#File"><span class="Identifier">File</span></a> {.
    500. 

  500.     <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>
    501. 

  501.   <dd>
    502. 

  502.     
    503. 

  503.     <p>Opens a file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> with given <tt class="docutils literal"><span class="pre"><span class="Identifier">mode</span></span></tt>.</p>
    504. 

  504. <p>Default mode is readonly. Raises an <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> if the file could not be opened.</p>
    505. 

  505. <p>The file handle associated with the resulting <tt class="docutils literal"><span class="pre"><span class="Identifier">File</span></span></tt> is not inheritable.</p>
    506. 

  506. 

  507.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L778" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    508. 

  508. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L778" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    509. 

  509. 

  510.   </dd>
    511. 

  511. </div>
    512. 

  512. 

  513. </div>
    514. 

  514. <div id="readAll-procs-all">
    515. 

  515.   <div id="readAll,File">
    516. 

  516.   <dt><pre><span class="Keyword">proc</span> <a href="#readAll%2CFile"><span class="Identifier">readAll</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</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">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 class="Other">,</span>
    517. 

  517.                                    <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    518. 

  518.   <dd>
    519. 

  519.     
    520. 

  520.     <p>Reads all data from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt>.</p>
    521. 

  521. <p>Raises an IO exception in case of an error. It is an error if the current file position is not at the beginning of the file.</p>
    522. 

  522. 

  523.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L601" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    524. 

  524. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L601" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    525. 

  525. 

  526.   </dd>
    527. 

  527. </div>
    528. 

  528. 

  529. </div>
    530. 

  530. <div id="readBuffer-procs-all">
    531. 

  531.   <div id="readBuffer,File,pointer,Natural">
    532. 

  532.   <dt><pre><span class="Keyword">proc</span> <a href="#readBuffer%2CFile%2Cpointer%2CNatural"><span class="Identifier">readBuffer</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="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">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    533. 

  533.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    534. 

  534.   <dd>
    535. 

  535.     
    536. 

  536.     Reads <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> bytes into the buffer pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt>. Returns the actual number of bytes that have been read which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> (if not as many bytes are remaining), but not greater.
    537. 

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

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

  539. 

  540.   </dd>
    541. 

  541. </div>
    542. 

  542. 

  543. </div>
    544. 

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

  545.   <div id="readBytes,File,openArray[],Natural,Natural">
    546. 

  546.   <dt><pre><span class="Keyword">proc</span> <a href="#readBytes%2CFile%2CopenArray%5B%5D%2CNatural%2CNatural"><span class="Identifier">readBytes</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="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#int8"><span class="Identifier">int8</span></a> <span class="Operator">|</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">,</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    547. 

  547.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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>.}</pre></dt>
    548. 

  548.   <dd>
    549. 

  549.     
    550. 

  550.     Reads <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> bytes into the buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Punctuation">]</span></span></tt>. Returns the actual number of bytes that have been read which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> (if not as many bytes are remaining), but not greater.
    551. 

  551.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L188" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    552. 

  552. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L188" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    553. 

  553. 

  554.   </dd>
    555. 

  555. </div>
    556. 

  556. 

  557. </div>
    558. 

  558. <div id="readChar-procs-all">
    559. 

  559.   <div id="readChar,File">
    560. 

  560.   <dt><pre><span class="Keyword">proc</span> <a href="#readChar%2CFile"><span class="Identifier">readChar</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> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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>
    561. 

  561.                                <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">EOFError</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>
    562. 

  562.   <dd>
    563. 

  563.     
    564. 

  564.     Reads a single character from the stream <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. Should not be used in performance sensitive code.
    565. 

  565.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L345" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    566. 

  566. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L345" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    567. 

  567. 

  568.   </dd>
    569. 

  569. </div>
    570. 

  570. 

  571. </div>
    572. 

  572. <div id="readChars-procs-all">
    573. 

  573.   <div id="readChars,File,openArray[char]">
    574. 

  574.   <dt><pre><span class="Keyword">proc</span> <a href="#readChars%2CFile%2CopenArray%5Bchar%5D"><span class="Identifier">readChars</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="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">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>
    575. 

  575.     <span class="Identifier">gcsafe</span><span class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    576. 

  576.   <dd>
    577. 

  577.     
    578. 

  578.     Reads up to <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> bytes into the buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. Returns the actual number of bytes that have been read which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> (if not as many bytes are remaining), but not greater.
    579. 

  579.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L196" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    580. 

  580. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L196" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    581. 

  581. 

  582.   </dd>
    583. 

  583. </div>
    584. 

  584. <div id="readChars,File,openArray[char],Natural,Natural">
    585. 

  585.   <dt><pre><span class="Keyword">proc</span> <a href="#readChars%2CFile%2CopenArray%5Bchar%5D%2CNatural%2CNatural"><span class="Identifier">readChars</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="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">,</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    586. 

  586.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;use other `readChars` overload, possibly via: readChars(toOpenArray(buf, start, len-1))&quot;</span><span class="Other">,</span>
    587. 

  587.     <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    588. 

  588.   <dd>
    589. 

  589.     <div class="deprecation-message">
    590. 

  590.   <b>Deprecated:</b> use other `readChars` overload, possibly via: readChars(toOpenArray(buf, start, len-1))
    591. 

  591. </div>
    592. 

  592. 

  593.     Reads <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> bytes into the buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> starting at <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Punctuation">]</span></span></tt>. Returns the actual number of bytes that have been read which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> (if not as many bytes are remaining), but not greater.
    594. 

  594.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L202" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    595. 

  595. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L202" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    596. 

  596. 

  597.   </dd>
    598. 

  598. </div>
    599. 

  599. 

  600. </div>
    601. 

  601. <div id="readFile-procs-all">
    602. 

  602.   <div id="readFile,string">
    603. 

  603.   <dt><pre><span class="Keyword">proc</span> <a href="#readFile%2Cstring"><span class="Identifier">readFile</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="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">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 class="Other">,</span>
    604. 

  604.     <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    605. 

  605.   <dd>
    606. 

  606.     
    607. 

  607.     Opens a file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> for reading, calls <a class="reference external" href="#readAll,File">readAll</a> and closes the file afterwards. Returns the string. Raises an IO exception in case of an error. If you need to call this inside a compile time macro you can use <a class="reference external" href="system.html#staticRead,string">staticRead</a>.
    608. 

  608.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L863" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    609. 

  609. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L863" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    610. 

  610. 

  611.   </dd>
    612. 

  612. </div>
    613. 

  613. 

  614. </div>
    615. 

  615. <div id="readLine-procs-all">
    616. 

  616.   <div id="readLine,File">
    617. 

  617.   <dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CFile"><span class="Identifier">readLine</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> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    618. 

  618.                                  <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">EOFError</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>
    619. 

  619.   <dd>
    620. 

  620.     
    621. 

  621.     Reads a line of text from the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. May throw an IO exception. A line of text may be delimited by <tt class="docutils literal"><span class="pre"><span class="Identifier">LF</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">CRLF</span></span></tt>. The newline character(s) are not part of the returned string.
    622. 

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

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

  624. 

  625.   </dd>
    626. 

  626. </div>
    627. 

  627. <div id="readLine,File,string">
    628. 

  628.   <dt><pre><span class="Keyword">proc</span> <a href="#readLine%2CFile%2Cstring"><span class="Identifier">readLine</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="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">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 class="Other">,</span>
    629. 

  629.     <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    630. 

  630.   <dd>
    631. 

  631.     
    632. 

  632.     Reads a line of text from the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt>. May throw an IO exception. A line of text may be delimited by <tt class="docutils literal"><span class="pre"><span class="Identifier">LF</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">CRLF</span></span></tt>. The newline character(s) are not part of the returned string. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> if the end of the file has been reached, <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> otherwise. If <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> is returned <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt> contains no new data.
    633. 

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

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

  635. 

  636.   </dd>
    637. 

  637. </div>
    638. 

  638. 

  639. </div>
    640. 

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

  641.   <div id="readLines,string,Natural">
    642. 

  642.   <dt><pre><span class="Keyword">proc</span> <a href="#readLines%2Cstring%2CNatural"><span class="Identifier">readLines</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">n</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    643. 

  643.     <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">EOFError</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>
    644. 

  644.   <dd>
    645. 

  645.     
    646. 

  646.     Reads <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> lines from the file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>. Raises an IO exception in case of an error. Raises EOF if file does not contain at least <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> lines. Available at compile time. A line of text may be delimited by <tt class="docutils literal"><span class="pre"><span class="Identifier">LF</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">CRLF</span></span></tt>. The newline character(s) are not part of the returned strings.
    647. 

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

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

  649. 

  650.   </dd>
    651. 

  651. </div>
    652. 

  652. 

  653. </div>
    654. 

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

  655.   <div id="reopen,File,string,FileMode">
    656. 

  656.   <dt><pre><span class="Keyword">proc</span> <a href="#reopen%2CFile%2Cstring%2CFileMode"><span class="Identifier">reopen</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="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="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    657. 

  657.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    658. 

  658.   <dd>
    659. 

  659.     
    660. 

  660.     <p>Reopens the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> with given <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">mode</span></span></tt>. This is often used to redirect the <tt class="docutils literal"><span class="pre"><span class="Identifier">stdin</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">stdout</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">stderr</span></span></tt> file variables.</p>
    661. 

  661. <p>Default mode is readonly. Returns true if the file could be reopened.</p>
    662. 

  662. <p>The file handle associated with <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> won't be inheritable.</p>
    663. 

  663. 

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

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

  666. 

  667.   </dd>
    668. 

  668. </div>
    669. 

  669. 

  670. </div>
    671. 

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

  672.   <div id="setFilePos,File,int64,FileSeekPos">
    673. 

  673.   <dt><pre><span class="Keyword">proc</span> <a href="#setFilePos%2CFile%2Cint64%2CFileSeekPos"><span class="Identifier">setFilePos</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="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">;</span> <span class="Identifier">relativeTo</span><span class="Other">:</span> <a href="syncio.html#FileSeekPos"><span class="Identifier">FileSeekPos</span></a> <span class="Other">=</span> <span class="Identifier">fspSet</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    674. 

  674.     </span><span class="Identifier">sideEffect</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="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>
    675. 

  675.   <dd>
    676. 

  676.     
    677. 

  677.     Sets the position of the file pointer that is used for read/write operations. The file's first byte has the index zero.
    678. 

  678.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L790" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    679. 

  679. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L790" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    680. 

  680. 

  681.   </dd>
    682. 

  682. </div>
    683. 

  683. 

  684. </div>
    685. 

  685. <div id="setInheritable-procs-all">
    686. 

  686.   <div id="setInheritable,FileHandle,bool">
    687. 

  687.   <dt><pre><span class="Keyword">proc</span> <a href="#setInheritable%2CFileHandle%2Cbool"><span class="Identifier">setInheritable</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="syncio.html#FileHandle"><span class="Identifier">FileHandle</span></a><span class="Other">;</span> <span class="Identifier">inheritable</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    688. 

  688.     <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>
    689. 

  689.   <dd>
    690. 

  690.     
    691. 

  691.     <p>Controls whether a file handle can be inherited by child processes. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> on success. This requires the OS file handle, which can be retrieved via <a class="reference external" href="#getOsFileHandle,File">getOsFileHandle</a>.</p>
    692. 

  692. <p>This procedure is not guaranteed to be available for all platforms. Test for availability with <a class="reference external" href="system.html#declared,untyped">declared()</a>.</p>
    693. 

  693. 

  694.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L375" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    695. 

  695. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L375" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    696. 

  696. 

  697.   </dd>
    698. 

  698. </div>
    699. 

  699. 

  700. </div>
    701. 

  701. <div id="setStdIoUnbuffered-procs-all">
    702. 

  702.   <div id="setStdIoUnbuffered">
    703. 

  703.   <dt><pre><span class="Keyword">proc</span> <a href="#setStdIoUnbuffered"><span class="Identifier">setStdIoUnbuffered</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    704. 

  704.   <dd>
    705. 

  705.     
    706. 

  706.     Configures <tt class="docutils literal"><span class="pre"><span class="Identifier">stdin</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">stdout</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">stderr</span></span></tt> to be unbuffered.
    707. 

  707.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L809" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    708. 

  708. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L809" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    709. 

  709. 

  710.   </dd>
    711. 

  711. </div>
    712. 

  712. 

  713. </div>
    714. 

  714. <div id="write-procs-all">
    715. 

  715.   <div id="write,File,varargs[string,]">
    716. 

  716.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">write</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="Identifier">a</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">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 class="Other">,</span>
    717. 

  717.     <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    718. 

  718.   <dd>
    719. 

  719.     
    720. 

  720.     
    721. 

  721.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L553" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    722. 

  722. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L553" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    723. 

  723. 

  724.   </dd>
    725. 

  725. </div>
    726. 

  726. <div id="write,File,bool">
    727. 

  727.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Cbool"><span class="Identifier">write</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="Identifier">b</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <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>
    728. 

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

  729.   <dd>
    730. 

  730.     
    731. 

  731.     
    732. 

  732.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L536" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    733. 

  733. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L536" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    734. 

  734. 

  735.   </dd>
    736. 

  736. </div>
    737. 

  737. <div id="write,File,char">
    738. 

  738.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Cchar"><span class="Identifier">write</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="Identifier">c</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    739. 

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

  740.   <dd>
    741. 

  741.     
    742. 

  742.     
    743. 

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

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

  745. 

  746.   </dd>
    747. 

  747. </div>
    748. 

  748. <div id="write,File,cstring">
    749. 

  749.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Ccstring"><span class="Identifier">write</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="Identifier">c</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    750. 

  750.                                   <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    751. 

  751.   <dd>
    752. 

  752.     
    753. 

  753.     Writes a value to the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. May throw an IO exception.
    754. 

  754.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L212" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    755. 

  755. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L212" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    756. 

  756. 

  757.   </dd>
    758. 

  758. </div>
    759. 

  759. <div id="write,File,BiggestInt">
    760. 

  760.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2CBiggestInt"><span class="Identifier">write</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="Identifier">i</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    761. 

  761.                                      <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    762. 

  762.   <dd>
    763. 

  763.     
    764. 

  764.     
    765. 

  765.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L530" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    766. 

  766. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L530" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    767. 

  767. 

  768.   </dd>
    769. 

  769. </div>
    770. 

  770. <div id="write,File,int">
    771. 

  771.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Cint"><span class="Identifier">write</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="Identifier">i</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">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 class="Other">,</span> <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>
    772. 

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

  773.   <dd>
    774. 

  774.     
    775. 

  775.     
    776. 

  776.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L524" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    777. 

  777. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L524" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    778. 

  778. 

  779.   </dd>
    780. 

  780. </div>
    781. 

  781. <div id="write,File,BiggestFloat">
    782. 

  782.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2CBiggestFloat"><span class="Identifier">write</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="Identifier">r</span><span class="Other">:</span> <a href="ctypes.html#BiggestFloat"><span class="Identifier">BiggestFloat</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    783. 

  783.                                        <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    784. 

  784.   <dd>
    785. 

  785.     
    786. 

  786.     
    787. 

  787.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L545" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    788. 

  788. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L545" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    789. 

  789. 

  790.   </dd>
    791. 

  791. </div>
    792. 

  792. <div id="write,File,float32">
    793. 

  793.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Cfloat32"><span class="Identifier">write</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="Identifier">r</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span>
    794. 

  794.                                   <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    795. 

  795.   <dd>
    796. 

  796.     
    797. 

  797.     
    798. 

  798.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L540" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    799. 

  799. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L540" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    800. 

  800. 

  801.   </dd>
    802. 

  802. </div>
    803. 

  803. <div id="write,File,string">
    804. 

  804.   <dt><pre><span class="Keyword">proc</span> <a href="#write%2CFile%2Cstring"><span class="Identifier">write</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="Identifier">s</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">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 class="Other">,</span>
    805. 

  805.                                  <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    806. 

  806.   <dd>
    807. 

  807.     
    808. 

  808.     
    809. 

  809.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L263" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    810. 

  810. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L263" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    811. 

  811. 

  812.   </dd>
    813. 

  813. </div>
    814. 

  814. 

  815. </div>
    816. 

  816. <div id="writeBuffer-procs-all">
    817. 

  817.   <div id="writeBuffer,File,pointer,Natural">
    818. 

  818.   <dt><pre><span class="Keyword">proc</span> <a href="#writeBuffer%2CFile%2Cpointer%2CNatural"><span class="Identifier">writeBuffer</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="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">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    819. 

  819.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    820. 

  820.   <dd>
    821. 

  821.     
    822. 

  822.     Writes the bytes of buffer pointed to by the parameter <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt> to the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. Returns the number of actual written bytes, which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> in case of an error.
    823. 

  823.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L217" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    824. 

  824. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L217" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    825. 

  825. 

  826.   </dd>
    827. 

  827. </div>
    828. 

  828. 

  829. </div>
    830. 

  830. <div id="writeBytes-procs-all">
    831. 

  831.   <div id="writeBytes,File,openArray[],Natural,Natural">
    832. 

  832.   <dt><pre><span class="Keyword">proc</span> <a href="#writeBytes%2CFile%2CopenArray%5B%5D%2CNatural%2CNatural"><span class="Identifier">writeBytes</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="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#int8"><span class="Identifier">int8</span></a> <span class="Operator">|</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">,</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    833. 

  833.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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>
    834. 

  834.   <dd>
    835. 

  835.     
    836. 

  836.     Writes the bytes of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Operator">..</span><span class="Identifier">start</span><span class="Operator">+</span><span class="Identifier">len</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span></span></tt> to the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. Returns the number of actual written bytes, which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> in case of an error.
    837. 

  837.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L225" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    838. 

  838. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L225" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    839. 

  839. 

  840.   </dd>
    841. 

  841. </div>
    842. 

  842. 

  843. </div>
    844. 

  844. <div id="writeChars-procs-all">
    845. 

  845.   <div id="writeChars,File,openArray[char],Natural,Natural">
    846. 

  846.   <dt><pre><span class="Keyword">proc</span> <a href="#writeChars%2CFile%2CopenArray%5Bchar%5D%2CNatural%2CNatural"><span class="Identifier">writeChars</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="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">,</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    847. 

  847.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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 class="Other">,</span> <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    848. 

  848.   <dd>
    849. 

  849.     
    850. 

  850.     Writes the bytes of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Operator">..</span><span class="Identifier">start</span><span class="Operator">+</span><span class="Identifier">len</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">]</span></span></tt> to the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>. Returns the number of actual written bytes, which may be less than <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> in case of an error.
    851. 

  851.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L233" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    852. 

  852. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L233" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    853. 

  853. 

  854.   </dd>
    855. 

  855. </div>
    856. 

  856. 

  857. </div>
    858. 

  858. <div id="writeFile-procs-all">
    859. 

  859.   <div id="writeFile,string,string">
    860. 

  860.   <dt><pre><span class="Keyword">proc</span> <a href="#writeFile%2Cstring%2Cstring"><span class="Identifier">writeFile</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">,</span> <span class="Identifier">content</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">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 class="Other">,</span>
    861. 

  861.     <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">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    862. 

  862.   <dd>
    863. 

  863.     
    864. 

  864.     Opens a file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> for writing. Then writes the <tt class="docutils literal"><span class="pre"><span class="Identifier">content</span></span></tt> completely to the file and closes the file afterwards. Raises an IO exception in case of an error.
    865. 

  865.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L878" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    866. 

  866. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L878" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    867. 

  867. 

  868.   </dd>
    869. 

  869. </div>
    870. 

  870. <div id="writeFile,string,openArray[byte]">
    871. 

  871.   <dt><pre><span class="Keyword">proc</span> <a href="#writeFile%2Cstring%2CopenArray%5Bbyte%5D"><span class="Identifier">writeFile</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">content</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#byte"><span class="Identifier">byte</span></a><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    872. 

  872.     <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>
    873. 

  873.   <dd>
    874. 

  874.     
    875. 

  875.     Opens a file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> for writing. Then writes the <tt class="docutils literal"><span class="pre"><span class="Identifier">content</span></span></tt> completely to the file and closes the file afterwards. Raises an IO exception in case of an error.
    876. 

  876.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L891" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    877. 

  877. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L891" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    878. 

  878. 

  879.   </dd>
    880. 

  880. </div>
    881. 

  881. 

  882. </div>
    883. 

  883. <div id="writeLine-procs-all">
    884. 

  884.   <div id="writeLine,File,varargs[Ty,]">
    885. 

  885.   <dt><pre><span class="Keyword">proc</span> <a href="#writeLine%2CFile%2Cvarargs%5BTy%2C%5D"><span class="Identifier">writeLine</span></a><span class="Other">[</span><span class="Identifier">Ty</span><span class="Other">]</span><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="Identifier">x</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><span class="Identifier">Ty</span><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 class="Identifier">inline</span><span class="Other">,</span>
    886. 

  886.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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>
    887. 

  887.   <dd>
    888. 

  888.     
    889. 

  889.     Writes the values <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> and then writes &quot;\n&quot;. May throw an IO exception.
    890. 

  890.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L618" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    891. 

  891. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L618" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    892. 

  892. 

  893.   </dd>
    894. 

  894. </div>
    895. 

  895. 

  896. </div>
    897. 

  897. 

  898.   </dl>
    899. 

  899. </div>
    900. 

  900. <div class="section" id="15">
    901. 

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

  902.   <dl class="item">
    903. 

  903.     <div id="lines-iterators-all">
    904. 

  904.   <div id="lines.i,File">
    905. 

  905.   <dt><pre><span class="Keyword">iterator</span> <a href="#lines.i%2CFile"><span class="Identifier">lines</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> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    906. 

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

  907.   <dd>
    908. 

  908.     
    909. 

  909.     <p>Iterates over any line in the file <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt>.</p>
    910. 

  910. <p>The trailing newline character(s) are removed from the iterated lines. </p>
    911. 

  911. 

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

  913. <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">countZeros</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">:</span> <span class="Identifier">File</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">lines</span><span class="Punctuation">,</span> <span class="Identifier">zeros</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">]</span> <span class="Operator">=</span>
    914. 

  914.   <span class="Keyword">for</span> <span class="Identifier">line</span> <span class="Keyword">in</span> <span class="Identifier">filename</span><span class="Operator">.</span><span class="Identifier">lines</span><span class="Punctuation">:</span>
    915. 

  915.     <span class="Keyword">for</span> <span class="Identifier">letter</span> <span class="Keyword">in</span> <span class="Identifier">line</span><span class="Punctuation">:</span>
    916. 

  916.       <span class="Keyword">if</span> <span class="Identifier">letter</span> <span class="Operator">==</span> <span class="CharLit">'0'</span><span class="Punctuation">:</span>
    917. 

  917.         <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">zeros</span> <span class="Operator">+=</span> <span class="DecNumber">1</span>
    918. 

  918.     <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">lines</span> <span class="Operator">+=</span> <span class="DecNumber">1</span></pre>
    919. 

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

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

  921. 

  922.   </dd>
    923. 

  923. </div>
    924. 

  924. <div id="lines.i,string">
    925. 

  925.   <dt><pre><span class="Keyword">iterator</span> <a href="#lines.i%2Cstring"><span class="Identifier">lines</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="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">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>
    926. 

  926.     <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">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    927. 

  927.   <dd>
    928. 

  928.     
    929. 

  929.     <p>Iterates over any line in the file named <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>.</p>
    930. 

  930. <p>If the file does not exist <tt class="docutils literal"><span class="pre"><span class="Identifier">IOError</span></span></tt> is raised. The trailing newline character(s) are removed from the iterated lines. Example: </p>
    931. 

  931. 

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

  933. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">strutils</span>
    934. 

  934. 

  935. <span class="Keyword">proc</span> <span class="Identifier">transformLetters</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span> <span class="Operator">=</span>
    936. 

  936.   <span class="Keyword">var</span> <span class="Identifier">buffer</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    937. 

  937.   <span class="Keyword">for</span> <span class="Identifier">line</span> <span class="Keyword">in</span> <span class="Identifier">filename</span><span class="Operator">.</span><span class="Identifier">lines</span><span class="Punctuation">:</span>
    938. 

  938.     <span class="Identifier">buffer</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">line</span><span class="Operator">.</span><span class="Identifier">replace</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;0&quot;</span><span class="Punctuation">)</span> <span class="Operator">&amp;</span> <span class="CharLit">'\n'</span><span class="Punctuation">)</span>
    939. 

  939.   <span class="Identifier">writeFile</span><span class="Punctuation">(</span><span class="Identifier">filename</span><span class="Punctuation">,</span> <span class="Identifier">buffer</span><span class="Punctuation">)</span></pre>
    940. 

  940.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L925" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    941. 

  941. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L925" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    942. 

  942. 

  943.   </dd>
    944. 

  944. </div>
    945. 

  945. 

  946. </div>
    947. 

  947. 

  948.   </dl>
    949. 

  949. </div>
    950. 

  950. <div class="section" id="18">
    951. 

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

  952.   <dl class="item">
    953. 

  953.     <div id="&amp;=-templates-all">
    954. 

  954.   <div id="&=.t,File,typed">
    955. 

  955.   <dt><pre><span class="Keyword">template</span> <a href="#%26%3D.t%2CFile%2Ctyped"><span class="Identifier">`&amp;=`</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="Identifier">x</span><span class="Other">:</span> <a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">)</span></pre></dt>
    956. 

  956.   <dd>
    957. 

  957.     
    958. 

  958.     An alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">write</span></span></tt>.
    959. 

  959.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L961" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    960. 

  960. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L961" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    961. 

  961. 

  962.   </dd>
    963. 

  963. </div>
    964. 

  964. 

  965. </div>
    966. 

  966. <div id="readLines-templates-all">
    967. 

  967.   <div id="readLines.t,string">
    968. 

  968.   <dt><pre><span class="Keyword">template</span> <a href="#readLines.t%2Cstring"><span class="Identifier">readLines</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="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    969. 

  969.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;use readLines with two arguments&quot;</span></span>.}</pre></dt>
    970. 

  970.   <dd>
    971. 

  971.     <div class="deprecation-message">
    972. 

  972.   <b>Deprecated:</b> use readLines with two arguments
    973. 

  973. </div>
    974. 

  974. 

  975.     
    976. 

  976.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L921" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    977. 

  977. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L921" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    978. 

  978. 

  979.   </dd>
    980. 

  980. </div>
    981. 

  981. 

  982. </div>
    983. 

  983. <div id="stdmsg-templates-all">
    984. 

  984.   <div id="stdmsg.t">
    985. 

  985.   <dt><pre><span class="Keyword">template</span> <a href="#stdmsg.t"><span class="Identifier">stdmsg</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</span></a></pre></dt>
    986. 

  986.   <dd>
    987. 

  987.     
    988. 

  988.     Template which expands to either stdout or stderr depending on <tt class="docutils literal"><span class="pre"><span class="Identifier">useStdoutAsStdmsg</span></span></tt> compile-time switch.
    989. 

  989.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/syncio.nim#L73" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    990. 

  990. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/syncio.nim#L73" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    991. 

  991. 

  992.   </dd>
    993. 

  993. </div>
    994. 

  994. 

  995. </div>
    996. 

  996. 

  997.   </dl>
    998. 

  998. </div>
    999. 

  999. 

  1000.   </div>
    1001. 

  1001. </div>
    1002. 

  1002. 

  1003.       <div class="twelve-columns footer">
    1004. 

  1004.         <span class="nim-sprite"></span>
    1005. 

  1005.         <br>
    1006. 

  1006.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:23 UTC</small>
    1007. 

  1007.       </div>
    1008. 

  1008.     </div>
    1009. 

  1009.   </div>
    1010. 

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

  1011.     
    1012. 

  1012. </body>
    1013. 

  1013. </html>
    1014. 

  1014.