oscommon.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/private/oscommon</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/private/oscommon</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <li><a class="reference" href="#ReadDirEffect" title="ReadDirEffect = object of ReadIOEffect">ReadDirEffect</a></li>
  57. <li><a class="reference" href="#WriteDirEffect" title="WriteDirEffect = object of WriteIOEffect">WriteDirEffect</a></li>
  58. </ul>
  59. </details>
  60. </li>
  61. <li>
  62. <details open>
  63. <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
  64. <ul class="simple simple-toc-section">
  65. <li><a class="reference" href="#maxSymlinkLen" title="maxSymlinkLen = 1024">maxSymlinkLen</a></li>
  66. <li><a class="reference" href="#supportedSystem" title="supportedSystem = true">supportedSystem</a></li>
  67. <li><a class="reference" href="#weirdTarget" title="weirdTarget = false">weirdTarget</a></li>
  68. </ul>
  69. </details>
  70. </li>
  71. <li>
  72. <details open>
  73. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  74. <ul class="simple simple-toc-section">
  75. <ul class="simple nested-toc-section">dirExists
  76. <li><a class="reference" href="#dirExists%2Cstring" title="dirExists(dir: string): bool">dirExists(dir: string): bool</a></li>
  77. </ul>
  78. <ul class="simple nested-toc-section">fileExists
  79. <li><a class="reference" href="#fileExists%2Cstring" title="fileExists(filename: string): bool">fileExists(filename: string): bool</a></li>
  80. </ul>
  81. <ul class="simple nested-toc-section">getSymlinkFileKind
  82. <li><a class="reference" href="#getSymlinkFileKind%2Cstring" title="getSymlinkFileKind(path: string): tuple[pc: PathComponent, isSpecial: bool]">getSymlinkFileKind(path: string): tuple[pc: PathComponent, isSpecial: bool]</a></li>
  83. </ul>
  84. <ul class="simple nested-toc-section">symlinkExists
  85. <li><a class="reference" href="#symlinkExists%2Cstring" title="symlinkExists(link: string): bool">symlinkExists(link: string): bool</a></li>
  86. </ul>
  87. <ul class="simple nested-toc-section">tryMoveFSObject
  88. <li><a class="reference" href="#tryMoveFSObject%2Cstring%2Cstring%2Cbool" title="tryMoveFSObject(source, dest: string; isDir: bool): bool">tryMoveFSObject(source, dest: string; isDir: bool): bool</a></li>
  89. </ul>
  90. </ul>
  91. </details>
  92. </li>
  93. </ul>
  94. </div>
  95. <div class="nine columns" id="content">
  96. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  97. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  98. <div id="tocRoot"></div>
  99. <p class="module-desc"></p>
  100. <div class="section" id="6">
  101. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  102. <dl class="item">
  103. <a class="reference external" href="oserrors.html">oserrors</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="widestrs.html">widestrs</a>, <a class="reference external" href="staticos.html">staticos</a>, <a class="reference external" href="posix.html">posix</a>
  104. </dl>
  105. </div>
  106. <div class="section" id="7">
  107. <h1><a class="toc-backref" href="#7">Types</a></h1>
  108. <dl class="item">
  109. <div id="ReadDirEffect">
  110. <dt><pre><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a></pre></dt>
  111. <dd>
  112. Effect that denotes a read operation from the directory structure.
  113. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L18" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  114. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L18" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  115. </dd>
  116. </div>
  117. <div id="WriteDirEffect">
  118. <dt><pre><a href="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a></pre></dt>
  119. <dd>
  120. Effect that denotes a write operation to the directory structure.
  121. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L21" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  122. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L21" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  123. </dd>
  124. </div>
  125. </dl>
  126. </div>
  127. <div class="section" id="10">
  128. <h1><a class="toc-backref" href="#10">Consts</a></h1>
  129. <dl class="item">
  130. <div id="maxSymlinkLen">
  131. <dt><pre><a href="oscommon.html#maxSymlinkLen"><span class="Identifier">maxSymlinkLen</span></a> <span class="Other">=</span> <span class="DecNumber">1024</span></pre></dt>
  132. <dd>
  133. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L109" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  134. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L109" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  135. </dd>
  136. </div>
  137. <div id="supportedSystem">
  138. <dt><pre><a href="oscommon.html#supportedSystem"><span class="Identifier">supportedSystem</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
  139. <dd>
  140. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L14" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  141. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L14" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  142. </dd>
  143. </div>
  144. <div id="weirdTarget">
  145. <dt><pre><a href="oscommon.html#weirdTarget"><span class="Identifier">weirdTarget</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
  146. <dd>
  147. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L13" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  148. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L13" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  149. </dd>
  150. </div>
  151. </dl>
  152. </div>
  153. <div class="section" id="12">
  154. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  155. <dl class="item">
  156. <div id="dirExists-procs-all">
  157. <div id="dirExists,string">
  158. <dt><pre><span class="Keyword">proc</span> <a href="#dirExists%2Cstring"><span class="Identifier">dirExists</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
  159. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">]</span><span class="Other">,</span> </span><span class="Identifier">sideEffect</span><span class="Other">,</span>
  160. <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>
  161. <dd>
  162. <p>Returns true if the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> exists. If <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> is a file, false is returned. Follows symlinks.</p>
  163. <p>See also:</p>
  164. <ul class="simple"><li><a class="reference internal nimdoc" title="proc fileExists(filename: string): bool" href="#fileExists,string">fileExists proc</a></li>
  165. <li><a class="reference internal nimdoc" title="proc symlinkExists(link: string): bool" href="#symlinkExists,string">symlinkExists proc</a></li>
  166. </ul>
  167. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L129" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  168. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L129" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  169. </dd>
  170. </div>
  171. </div>
  172. <div id="fileExists-procs-all">
  173. <div id="fileExists,string">
  174. <dt><pre><span class="Keyword">proc</span> <a href="#fileExists%2Cstring"><span class="Identifier">fileExists</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#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
  175. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">]</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>
  176. <dd>
  177. <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> exists and is a regular file or symlink.</p>
  178. <p>Directories, device files, named pipes and sockets return false.</p>
  179. <p>See also:</p>
  180. <ul class="simple"><li><a class="reference internal nimdoc" title="proc dirExists(dir: string): bool" href="#dirExists,string">dirExists proc</a></li>
  181. <li><a class="reference internal nimdoc" title="proc symlinkExists(link: string): bool" href="#symlinkExists,string">symlinkExists proc</a></li>
  182. </ul>
  183. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L111" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  184. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L111" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  185. </dd>
  186. </div>
  187. </div>
  188. <div id="getSymlinkFileKind-procs-all">
  189. <div id="getSymlinkFileKind,string">
  190. <dt><pre><span class="Keyword">proc</span> <a href="#getSymlinkFileKind%2Cstring"><span class="Identifier">getSymlinkFileKind</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">pc</span><span class="Other">:</span> <a href="staticos.html#PathComponent"><span class="Identifier">PathComponent</span></a><span class="Other">,</span> <span class="Identifier">isSpecial</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">]</span> {.
  191. <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>
  192. <dd>
  193. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L72" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  194. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L72" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  195. </dd>
  196. </div>
  197. </div>
  198. <div id="symlinkExists-procs-all">
  199. <div id="symlinkExists,string">
  200. <dt><pre><span class="Keyword">proc</span> <a href="#symlinkExists%2Cstring"><span class="Identifier">symlinkExists</span></a><span class="Other">(</span><span class="Identifier">link</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
  201. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">]</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>
  202. <dd>
  203. <p>Returns true if the symlink <tt class="docutils literal"><span class="pre"><span class="Identifier">link</span></span></tt> exists. Will return true regardless of whether the link points to a directory or file.</p>
  204. <p>See also:</p>
  205. <ul class="simple"><li><a class="reference internal nimdoc" title="proc fileExists(filename: string): bool" href="#fileExists,string">fileExists proc</a></li>
  206. <li><a class="reference internal nimdoc" title="proc dirExists(dir: string): bool" href="#dirExists,string">dirExists proc</a></li>
  207. </ul>
  208. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L146" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  209. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L146" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  210. </dd>
  211. </div>
  212. </div>
  213. <div id="tryMoveFSObject-procs-all">
  214. <div id="tryMoveFSObject,string,string,bool">
  215. <dt><pre><span class="Keyword">proc</span> <a href="#tryMoveFSObject%2Cstring%2Cstring%2Cbool"><span class="Identifier">tryMoveFSObject</span></a><span class="Other">(</span><span class="Identifier">source</span><span class="Other">,</span> <span class="Identifier">dest</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">isDir</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> {.
  216. <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">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  217. <dd>
  218. <p>Moves a file (or directory if <tt class="docutils literal"><span class="pre"><span class="Identifier">isDir</span></span></tt> is true) from <tt class="docutils literal"><span class="pre"><span class="Identifier">source</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt>.</p>
  219. <p>Returns false in case of <tt class="docutils literal"><span class="pre"><span class="Identifier">EXDEV</span></span></tt> error or <tt class="docutils literal"><span class="pre"><span class="Identifier">AccessDeniedError</span></span></tt> on Windows (if <tt class="docutils literal"><span class="pre"><span class="Identifier">isDir</span></span></tt> is true). In case of other errors <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised. Returns true in case of success.</p>
  220. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/oscommon.nim#L84" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  221. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/oscommon.nim#L84" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  222. </dd>
  223. </div>
  224. </div>
  225. </dl>
  226. </div>
  227. </div>
  228. </div>
  229. <div class="twelve-columns footer">
  230. <span class="nim-sprite"></span>
  231. <br>
  232. <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:30 UTC</small>
  233. </div>
  234. </div>
  235. </div>
  236. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  237. </body>
  238. </html>