mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Nim/tempfiles.html
github-actions[bot] ef3d9e7b38 Deploy to GitHub pages
2025-12-28 15:55:52 +00:00

200 lines
20 KiB
HTML
Raw Permalink Blame History

<?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/tempfiles</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/tempfiles</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">createTempDir
<li><a class="reference" href="#createTempDir%2Cstring%2Cstring%2Cstring" title="createTempDir(prefix, suffix: string; dir = &quot;&quot;): string">createTempDir(prefix, suffix: string; dir = &quot;&quot;): string</a></li>
</ul>
<ul class="simple nested-toc-section">createTempFile
<li><a class="reference" href="#createTempFile%2Cstring%2Cstring%2Cstring" title="createTempFile(prefix, suffix: string; dir = &quot;&quot;): tuple[cfile: File,
path: string]">createTempFile(prefix, suffix: string; dir = &quot;&quot;): tuple[cfile: File,
path: string]</a></li>
</ul>
<ul class="simple nested-toc-section">genTempPath
<li><a class="reference" href="#genTempPath%2Cstring%2Cstring%2Cstring" title="genTempPath(prefix, suffix: string; dir = &quot;&quot;): string">genTempPath(prefix, suffix: string; dir = &quot;&quot;): string</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/tempfiles.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/tempfiles.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc"><p>This module creates temporary files and directories.</p>
<p>Experimental API, subject to change.</p>
</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="os.html">os</a>, <a class="reference external" href="random.html">random</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="posix.html">posix</a>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="createTempDir-procs-all">
<div id="createTempDir,string,string,string">
<dt><pre><span class="Keyword">proc</span> <a href="#createTempDir%2Cstring%2Cstring%2Cstring"><span class="Identifier">createTempDir</span></a><span class="Other">(</span><span class="Identifier">prefix</span><span class="Other">,</span> <span class="Identifier">suffix</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</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="Identifier">ReadEnvEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</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 a new temporary directory in the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.</p>
<p>This generates a dir name using <tt class="docutils literal"><span class="pre"><span class="Identifier">genTempPath</span><span class="Punctuation">(</span><span class="Identifier">prefix</span><span class="Punctuation">,</span> <span class="Identifier">suffix</span><span class="Punctuation">,</span> <span class="Identifier">dir</span><span class="Punctuation">)</span></span></tt>, creates the directory and returns it, possibly after retrying to ensure it doesn't already exist.</p>
<p>If failing to create a temporary directory, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> will be raised.</p>
<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
It is the caller's responsibility to remove the directory when no longer needed.</div>
<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
<tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> must exist (empty <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> will resolve to <a class="reference external" href="appdirs.html#getTempDir">getTempDir</a>).</div>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span>
<span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">OSError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">createTempDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nonexistent&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">let</span> <span class="Identifier">dir</span> <span class="Operator">=</span> <span class="Identifier">createTempDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;tmpprefix_&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;_end&quot;</span><span class="Punctuation">)</span>
<span class="Comment"># dir looks like: getTempDir() / &quot;tmpprefix_YEl9VuVj_end&quot;</span>
<span class="Identifier">assert</span> <span class="Identifier">dirExists</span><span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">)</span>
<span class="Identifier">removeDir</span><span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/tempfiles.nim#L169" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/tempfiles.nim#L169" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="createTempFile-procs-all">
<div id="createTempFile,string,string,string">
<dt><pre><span class="Keyword">proc</span> <a href="#createTempFile%2Cstring%2Cstring%2Cstring"><span class="Identifier">createTempFile</span></a><span class="Other">(</span><span class="Identifier">prefix</span><span class="Other">,</span> <span class="Identifier">suffix</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">cfile</span><span class="Other">:</span> <a href="syncio.html#File"><span class="Identifier">File</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><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="Identifier">ReadEnvEffect</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>
<dd>
<p>Creates a new temporary file in the directory <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.</p>
<p>This generates a path name using <tt class="docutils literal"><span class="pre"><span class="Identifier">genTempPath</span><span class="Punctuation">(</span><span class="Identifier">prefix</span><span class="Punctuation">,</span> <span class="Identifier">suffix</span><span class="Punctuation">,</span> <span class="Identifier">dir</span><span class="Punctuation">)</span></span></tt> and returns a file handle to an open file and the path of that file, possibly after retrying to ensure it doesn't already exist.</p>
<p>If failing to create a temporary file, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> will be raised.</p>
<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
It is the caller's responsibility to close <tt class="docutils literal"><span class="pre"><span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">cfile</span></span></tt> and remove <tt class="docutils literal"><span class="pre"><span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">file</span></span></tt> when no longer needed.</div>
<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
<tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> must exist (empty <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> will resolve to <a class="reference external" href="appdirs.html#getTempDir">getTempDir</a>).</div>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span>
<span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">OSError</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">createTempFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nonexistent&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">let</span> <span class="Punctuation">(</span><span class="Identifier">cfile</span><span class="Punctuation">,</span> <span class="Identifier">path</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">createTempFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;tmpprefix_&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;_end.tmp&quot;</span><span class="Punctuation">)</span>
<span class="Comment"># path looks like: getTempDir() / &quot;tmpprefix_FDCIRZA0_end.tmp&quot;</span>
<span class="Identifier">cfile</span><span class="Operator">.</span><span class="Identifier">write</span> <span class="StringLit">&quot;foo&quot;</span>
<span class="Identifier">cfile</span><span class="Operator">.</span><span class="Identifier">setFilePos</span> <span class="DecNumber">0</span>
<span class="Identifier">assert</span> <span class="Identifier">readAll</span><span class="Punctuation">(</span><span class="Identifier">cfile</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo&quot;</span>
<span class="Identifier">close</span> <span class="Identifier">cfile</span>
<span class="Identifier">assert</span> <span class="Identifier">readFile</span><span class="Punctuation">(</span><span class="Identifier">path</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo&quot;</span>
<span class="Identifier">removeFile</span><span class="Punctuation">(</span><span class="Identifier">path</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/tempfiles.nim#L135" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/tempfiles.nim#L135" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="genTempPath-procs-all">
<div id="genTempPath,string,string,string">
<dt><pre><span class="Keyword">proc</span> <a href="#genTempPath%2Cstring%2Cstring%2Cstring"><span class="Identifier">genTempPath</span></a><span class="Other">(</span><span class="Identifier">prefix</span><span class="Other">,</span> <span class="Identifier">suffix</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</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>
<dd>
<p>Generates a path name in <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt>.</p>
<p>The path begins with <tt class="docutils literal"><span class="pre"><span class="Identifier">prefix</span></span></tt> and ends with <tt class="docutils literal"><span class="pre"><span class="Identifier">suffix</span></span></tt>.</p>
<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
<tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> must exist (empty <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> will resolve to <a class="reference external" href="appdirs.html#getTempDir">getTempDir</a>).</div>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/tempfiles.nim#L126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/tempfiles.nim#L126" 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-12-28 15:55:15 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink