levovix
/
Nim
spogulis no https://github.com/nim-lang/Nim


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
							<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--  This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>std/dirs</title>

<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>

<!-- Favicon -->
<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=="/>
<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=">

<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">

<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
  <div class="document" id="documentId">
    <div class="container">
      <h1 class="title">std/dirs</h1>
      <div class="row">
  <div class="three columns">
    <div class="theme-select-wrapper">
      <label for="theme-select">Theme:&nbsp;</label>
      <select id="theme-select" onchange="setTheme(this.value)">
        <option value="auto">🌗 Match OS</option>
        <option value="dark">🌑 Dark</option>
        <option value="light">🌕 Light</option>
      </select>
    </div>
    <div id="global-links">
      <ul class="simple-boot">
        <li><a href="manual.html">Manual</a></li>
        <li><a href="lib.html">Standard library</a></li>
        <li> <a id="indexLink" href="theindex.html">Index</a></li>
        <li><a href="compiler/theindex.html">Compiler docs</a></li>
        <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
        <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
      </ul>
    </div>
    <div id="searchInputDiv">
      Search: <input type="search" id="searchInput"
        oninput="search()" />
    </div>
    
    <ul class="simple simple-toc" id="toc-list">
  <li>
  <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">createDir
  <li><a class="reference" href="#createDir%2CPath" title="createDir(dir: Path)">createDir(dir: Path)</a></li>

</ul>
<ul class="simple nested-toc-section">dirExists
  <li><a class="reference" href="#dirExists%2CPath" title="dirExists(dir: Path): bool">dirExists(dir: Path): bool</a></li>

</ul>
<ul class="simple nested-toc-section">existsOrCreateDir
  <li><a class="reference" href="#existsOrCreateDir%2CPath" title="existsOrCreateDir(dir: Path): bool">existsOrCreateDir(dir: Path): bool</a></li>

</ul>
<ul class="simple nested-toc-section">moveDir
  <li><a class="reference" href="#moveDir%2CPath%2CPath" title="moveDir(source, dest: Path)">moveDir(source, dest: Path)</a></li>

</ul>
<ul class="simple nested-toc-section">removeDir
  <li><a class="reference" href="#removeDir%2CPath" title="removeDir(dir: Path; checkDir = false)">removeDir(dir: Path; checkDir = false)</a></li>

</ul>
<ul class="simple nested-toc-section">setCurrentDir
  <li><a class="reference" href="#setCurrentDir%2CPath" title="setCurrentDir(newDir: Path)">setCurrentDir(newDir: Path)</a></li>

</ul>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">walkDir
  <li><a class="reference" href="#walkDir.i%2CPath" title="walkDir(dir: Path; relative = false; checkDir = false; skipSpecial = false): tuple[
    kind: PathComponent, path: Path]">walkDir(dir: Path; relative = false; checkDir = false; skipSpecial = false): tuple[
    kind: PathComponent, path: Path]</a></li>

</ul>
<ul class="simple nested-toc-section">walkDirRec
  <li><a class="reference" href="#walkDirRec.i%2CPath" title="walkDirRec(dir: Path; yieldFilter = {pcFile}; followFilter = {pcDir};
           relative = false; checkDir = false; skipSpecial = false): Path">walkDirRec(dir: Path; yieldFilter = {pcFile}; followFilter = {pcDir};
           relative = false; checkDir = false; skipSpecial = false): Path</a></li>

</ul>

    </ul>
  </details>
</li>

</ul>

  </div>
  <div class="nine columns" id="content">
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

    <div id="tocRoot"></div>
    
    <p class="module-desc">This module implements directory handling.</p>
    <div class="section" id="6">
  <h1><a class="toc-backref" href="#6">Imports</a></h1>
  <dl class="item">
    <a class="reference external" href="paths.html">paths</a>, <a class="reference external" href="osdirs.html">osdirs</a>
  </dl>
</div>
<div class="section" id="12">
  <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <dl class="item">
    <div id="createDir-procs-all">
  <div id="createDir,Path">
  <dt><pre><span class="Keyword">proc</span> <a href="#createDir%2CPath"><span class="Identifier">createDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a><span class="Other">,</span> <a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</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">OSError</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>
  <dd>
    
    <p>Creates the <span id="directory_1">directory</span> <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.</p>
<p>The directory may contain several subdirectories that do not exist yet. The full path is created. If this fails, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised.</p>
<p>It does <strong>not</strong> fail if the directory already exists because for most usages this does not indicate an error.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc removeDir(dir: Path; checkDir = false)" href="#removeDir,Path">removeDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc existsOrCreateDir(dir: Path): bool" href="#existsOrCreateDir,Path">existsOrCreateDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc moveDir(source, dest: Path)" href="#moveDir,Path,Path">moveDir proc</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L16" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L16" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="dirExists-procs-all">
  <div id="dirExists,Path">
  <dt><pre><span class="Keyword">proc</span> <a href="#dirExists%2CPath"><span class="Identifier">dirExists</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</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="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>
  <dd>
    
    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.
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L11" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L11" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="existsOrCreateDir-procs-all">
  <div id="existsOrCreateDir,Path">
  <dt><pre><span class="Keyword">proc</span> <a href="#existsOrCreateDir%2CPath"><span class="Identifier">existsOrCreateDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</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="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a><span class="Other">,</span> <a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</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">OSError</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>
  <dd>
    
    <p>Checks if a <span id="directory_2">directory</span> <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> exists, and creates it otherwise.</p>
<p>Does not create parent directories (raises <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> if parent directories do not exist). Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if the directory already exists, and <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> otherwise.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc removeDir(dir: Path; checkDir = false)" href="#removeDir,Path">removeDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc createDir(dir: Path)" href="#createDir,Path">createDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc moveDir(source, dest: Path)" href="#moveDir,Path,Path">moveDir proc</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L31" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L31" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="moveDir-procs-all">
  <div id="moveDir,Path,Path">
  <dt><pre><span class="Keyword">proc</span> <a href="#moveDir%2CPath%2CPath"><span class="Identifier">moveDir</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="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">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> <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="Identifier">OSError</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>
  <dd>
    
    <p>Moves a directory 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>
<p>Symlinks are not followed: if <tt class="docutils literal"><span class="pre"><span class="Identifier">source</span></span></tt> contains symlinks, they themself are moved, not their target.</p>
<p>If this fails, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="files.html#moveFile">moveFile proc</a></li>
<li><a class="reference internal nimdoc" title="proc removeDir(dir: Path; checkDir = false)" href="#removeDir,Path">removeDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc existsOrCreateDir(dir: Path): bool" href="#existsOrCreateDir,Path">existsOrCreateDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc createDir(dir: Path)" href="#createDir,Path">createDir proc</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L58" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L58" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="removeDir-procs-all">
  <div id="removeDir,Path">
  <dt><pre><span class="Keyword">proc</span> <a href="#removeDir%2CPath"><span class="Identifier">removeDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">checkDir</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a><span class="Other">,</span> <a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</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">OSError</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>
  <dd>
    
    <p>Removes the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> including all subdirectories and files in <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> (recursively).</p>
<p>If this fails, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised. This does not fail if the directory never existed in the first place, unless <tt class="docutils literal"><span class="pre"><span class="Identifier">checkDir</span></span></tt> = true.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="files.html#removeFile">removeFile proc</a></li>
<li><a class="reference internal nimdoc" title="proc existsOrCreateDir(dir: Path): bool" href="#existsOrCreateDir,Path">existsOrCreateDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc createDir(dir: Path)" href="#createDir,Path">createDir proc</a></li>
<li><a class="reference internal nimdoc" title="proc moveDir(source, dest: Path)" href="#moveDir,Path,Path">moveDir proc</a></li>
</ul>

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

  </dd>
</div>

</div>
<div id="setCurrentDir-procs-all">
  <div id="setCurrentDir,Path">
  <dt><pre><span class="Keyword">proc</span> <a href="#setCurrentDir%2CPath"><span class="Identifier">setCurrentDir</span></a><span class="Other">(</span><span class="Identifier">newDir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">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="Identifier">OSError</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>
  <dd>
    
    <p>Sets the <span id="current-working-directory_1">current working directory</span>; <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised if <tt class="docutils literal"><span class="pre"><span class="Identifier">newDir</span></span></tt> cannot been set.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="paths.html#getCurrentDir">getCurrentDir proc</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L129" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L129" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>

  </dl>
</div>
<div class="section" id="15">
  <h1><a class="toc-backref" href="#15">Iterators</a></h1>
  <dl class="item">
    <div id="walkDir-iterators-all">
  <div id="walkDir.i,Path">
  <dt><pre><span class="Keyword">iterator</span> <a href="#walkDir.i%2CPath"><span class="Identifier">walkDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">relative</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">checkDir</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span>
                 <span class="Identifier">skipSpecial</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">kind</span><span class="Other">:</span> <a href="staticos.html#PathComponent"><span class="Identifier">PathComponent</span></a><span class="Other">,</span> <span class="Identifier">path</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</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="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</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">OSError</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>
  <dd>
    
    <p>Walks over the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> and yields for each directory or file in <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>. The component type and full path for each item are returned.</p>
<p>Walking is not recursive.</p>
<ul class="simple"><li>If <tt class="docutils literal"><span class="pre"><span class="Identifier">relative</span></span></tt> is true (default: false) the resulting path is shortened to be relative to <tt class="docutils literal"><span class="pre">dir</span></tt>, otherwise the full path is returned.</li>
<li>If <tt class="docutils literal"><span class="pre"><span class="Identifier">checkDir</span></span></tt> is true, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised when <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> doesn't exist.</li>
<li>If <tt class="docutils literal"><span class="pre"><span class="Identifier">skipSpecial</span></span></tt> is true, then (besides all directories) only <em>regular</em> files (<strong>without</strong> special &quot;file&quot; objects like FIFOs, device files, etc) will be yielded on Unix.</li>
</ul>

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

  </dd>
</div>

</div>
<div id="walkDirRec-iterators-all">
  <div id="walkDirRec.i,Path">
  <dt><pre><span class="Keyword">iterator</span> <a href="#walkDirRec.i%2CPath"><span class="Identifier">walkDirRec</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">yieldFilter</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">pcFile</span><span class="Other">}</span><span class="Other">;</span> <span class="Identifier">followFilter</span> <span class="Other">=</span> <span class="Other">{</span><span class="Identifier">pcDir</span><span class="Other">}</span><span class="Other">;</span>
                    <span class="Identifier">relative</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">checkDir</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">skipSpecial</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</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="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</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">OSError</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>
  <dd>
    
    <p>Recursively walks over the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> and yields for each file or directory in <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.</p>
<p>Options <tt class="docutils literal"><span class="pre"><span class="Identifier">relative</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">checkdir</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">skipSpecial</span></span></tt> are explained in <a class="reference internal nimdoc" title="iterator walkDir(dir: Path; relative = false; checkDir = false; skipSpecial = false): tuple[
    kind: PathComponent, path: Path]" href="#walkDir.i,Path">walkDir iterator</a> description.</p>
<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
Modifying the directory structure while the iterator is traversing may result in undefined behavior!</div>
<p>Walking is recursive. <tt class="docutils literal"><span class="pre"><span class="Identifier">followFilter</span></span></tt> controls the behaviour of the iterator:</p>
<table border="1" class="docutils"><tr><th>yieldFilter</th><th>meaning</th></tr>
<tr><td><tt class="docutils literal"><span class="pre">pcFile</span></tt></td><td>yield real files (default)</td></tr>
<tr><td><tt class="docutils literal"><span class="pre">pcLinkToFile</span></tt></td><td>yield symbolic links to files</td></tr>
<tr><td><tt class="docutils literal"><span class="pre">pcDir</span></tt></td><td>yield real directories</td></tr>
<tr><td><tt class="docutils literal"><span class="pre">pcLinkToDir</span></tt></td><td>yield symbolic links to directories</td></tr>
</table><table border="1" class="docutils"><tr><th>followFilter</th><th>meaning</th></tr>
<tr><td><tt class="docutils literal"><span class="pre">pcDir</span></tt></td><td>follow real directories (default)</td></tr>
<tr><td><tt class="docutils literal"><span class="pre">pcLinkToDir</span></tt></td><td>follow symbolic links to directories</td></tr>
</table><p>See also:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="iterator walkDir(dir: Path; relative = false; checkDir = false; skipSpecial = false): tuple[
    kind: PathComponent, path: Path]" href="#walkDir.i,Path">walkDir iterator</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/dirs.nim#L91" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/dirs.nim#L91" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>

  </dl>
</div>

  </div>
</div>

      <div class="twelve-columns footer">
        <span class="nim-sprite"></span>
        <br>
        <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:25 UTC</small>
      </div>
    </div>
  </div>
      <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    
</body>
</html>