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/parsecsv.html
github-actions[bot] ef3d9e7b38 Deploy to GitHub pages
2025-12-28 15:55:52 +00:00

431 lines
52 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/parsecsv</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/parsecsv</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" id="basic-usage_toc" href="#basic-usage">Basic usage</a></li>
<li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#CsvError" title="CsvError = object of IOError">CsvError</a></li>
<li><a class="reference" href="#CsvParser" title="CsvParser = object of BaseLexer
row*: CsvRow
headers*: seq[string]">CsvParser</a></li>
<li><a class="reference" href="#CsvRow" title="CsvRow = seq[string]">CsvRow</a></li>
</ul>
</details>
</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">close
<li><a class="reference" href="#close%2CCsvParser" title="close(self: var CsvParser)">close(self: var CsvParser)</a></li>
</ul>
<ul class="simple nested-toc-section">open
<li><a class="reference" href="#open%2CCsvParser%2Cstring%2Cchar%2Cchar%2Cchar" title="open(self: var CsvParser; filename: string; separator = ','; quote = '\&quot;';
escape = '\x00'; skipInitialSpace = false)">open(self: var CsvParser; filename: string; separator = ','; quote = '\&quot;';
escape = '\x00'; skipInitialSpace = false)</a></li>
<li><a class="reference" href="#open%2CCsvParser%2CStream%2Cstring%2Cchar%2Cchar%2Cchar" title="open(self: var CsvParser; input: Stream; filename: string; separator = ',';
quote = '\&quot;'; escape = '\x00'; skipInitialSpace = false)">open(self: var CsvParser; input: Stream; filename: string; separator = ',';
quote = '\&quot;'; escape = '\x00'; skipInitialSpace = false)</a></li>
</ul>
<ul class="simple nested-toc-section">processedRows
<li><a class="reference" href="#processedRows%2CCsvParser" title="processedRows(self: var CsvParser): int">processedRows(self: var CsvParser): int</a></li>
</ul>
<ul class="simple nested-toc-section">readHeaderRow
<li><a class="reference" href="#readHeaderRow%2CCsvParser" title="readHeaderRow(self: var CsvParser)">readHeaderRow(self: var CsvParser)</a></li>
</ul>
<ul class="simple nested-toc-section">readRow
<li><a class="reference" href="#readRow%2CCsvParser%2Cint" title="readRow(self: var CsvParser; columns = 0): bool">readRow(self: var CsvParser; columns = 0): bool</a></li>
</ul>
<ul class="simple nested-toc-section">rowEntry
<li><a class="reference" href="#rowEntry%2CCsvParser%2Cstring" title="rowEntry(self: var CsvParser; entry: string): var string">rowEntry(self: var CsvParser; entry: string): var 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/pure/parsecsv.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<div id="tocRoot"></div>
<p class="module-desc">This module implements a simple high performance <span id="csv_1">CSV</span> (<span id="comma-separated-value_1">comma separated value</span>) parser.
<h1><a class="toc-backref" id="basic-usage" href="#basic-usage">Basic usage</a></h1><p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecsv</span>
<span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span> <span class="Keyword">import</span> <span class="Identifier">paramStr</span>
<span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">streams</span> <span class="Keyword">import</span> <span class="Identifier">newFileStream</span>
<span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="Identifier">paramStr</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">fmRead</span><span class="Punctuation">)</span>
<span class="Keyword">if</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="Keyword">nil</span><span class="Punctuation">:</span>
<span class="Identifier">quit</span><span class="Punctuation">(</span><span class="StringLit">&quot;cannot open the file&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">paramStr</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Identifier">paramStr</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
<span class="Keyword">while</span> <span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
<span class="Identifier">echo</span> <span class="StringLit">&quot;new row: &quot;</span>
<span class="Keyword">for</span> <span class="Identifier">val</span> <span class="Keyword">in</span> <span class="Identifier">items</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">row</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
<span class="Identifier">echo</span> <span class="StringLit">&quot;##&quot;</span><span class="Punctuation">,</span> <span class="Identifier">val</span><span class="Punctuation">,</span> <span class="StringLit">&quot;##&quot;</span>
<span class="Identifier">close</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></pre></p>
<p>For CSV files with a header row, the header can be read and then used as a reference for item access with <a class="reference external" href="#rowEntry,CsvParser,string">rowEntry</a>:</p>
<p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecsv</span>
<span class="Comment"># Prepare a file</span>
<span class="Keyword">let</span> <span class="Identifier">content</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;One,Two,Three,Four
1,2,3,4
10,20,30,40
100,200,300,400
&quot;&quot;&quot;</span>
<span class="Identifier">writeFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;temp.csv&quot;</span><span class="Punctuation">,</span> <span class="Identifier">content</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">p</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;temp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">readHeaderRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Keyword">while</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
<span class="Identifier">echo</span> <span class="StringLit">&quot;new row: &quot;</span>
<span class="Keyword">for</span> <span class="Identifier">col</span> <span class="Keyword">in</span> <span class="Identifier">items</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">headers</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
<span class="Identifier">echo</span> <span class="StringLit">&quot;##&quot;</span><span class="Punctuation">,</span> <span class="Identifier">col</span><span class="Punctuation">,</span> <span class="StringLit">&quot;:&quot;</span><span class="Punctuation">,</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">rowEntry</span><span class="Punctuation">(</span><span class="Identifier">col</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;##&quot;</span>
<span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
<h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="streams.html">streams module</a> for using <a class="reference external" href="#open,CsvParser,Stream,string,char,char,char">open proc</a> and other stream processing (like <a class="reference external" href="streams.html#close,Stream">close proc</a>)</li>
<li><a class="reference external" href="parseopt.html">parseopt module</a> for a command line parser</li>
<li><a class="reference external" href="parsecfg.html">parsecfg module</a> for a configuration file parser</li>
<li><a class="reference external" href="parsexml.html">parsexml module</a> for a XML / HTML parser</li>
<li><a class="reference external" href="parsesql.html">parsesql module</a> for a SQL parser</li>
<li><a class="reference external" href="lib.html#pure-libraries-parsers">other parsers</a> for other parsers</li>
</ul>
</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="lexbase.html">lexbase</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="os.html">os</a>
</dl>
</div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="CsvError">
<dt><pre><a href="parsecsv.html#CsvError"><span class="Identifier">CsvError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#IOError"><span class="Identifier">IOError</span></a></pre></dt>
<dd>
An exception that is raised if a parsing error occurs.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L91" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L91" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="CsvParser">
<dt><pre><a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a>
<span class="Identifier">row</span><span class="Operator">*</span><span class="Other">:</span> <a href="parsecsv.html#CsvRow"><span class="Identifier">CsvRow</span></a>
<span class="Identifier">headers</span><span class="Operator">*</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></pre></dt>
<dd>
<p>The parser object.</p>
<p>It consists of two public fields:</p>
<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">row</span></span></tt> is the current row</li>
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">headers</span></span></tt> are the columns that are defined in the csv file (read using <a class="reference external" href="#readHeaderRow,CsvParser">readHeaderRow</a>). Used with <a class="reference external" href="#rowEntry,CsvParser,string">rowEntry</a>).</li>
</ul>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L77" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L77" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="CsvRow">
<dt><pre><a href="parsecsv.html#CsvRow"><span class="Identifier">CsvRow</span></a> <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></pre></dt>
<dd>
A row in a CSV file.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L76" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L76" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="close-procs-all">
<div id="close,CsvParser">
<dt><pre><span class="Keyword">proc</span> <a href="#close%2CCsvParser"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Closes the parser <tt class="docutils literal"><span class="pre"><span class="Identifier">self</span></span></tt> and its associated input stream.
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L292" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L292" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="open-procs-all">
<div id="open,CsvParser,string,char,char,char">
<dt><pre><span class="Keyword">proc</span> <a href="#open%2CCsvParser%2Cstring%2Cchar%2Cchar%2Cchar"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</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">separator</span> <span class="Other">=</span> <span class="CharLit">','</span><span class="Other">;</span> <span class="Identifier">quote</span> <span class="Other">=</span> <span class="CharLit">'\&quot;'</span><span class="Other">;</span>
<span class="Identifier">escape</span> <span class="Other">=</span> <span class="CharLit">'\x00'</span><span class="Other">;</span> <span class="Identifier">skipInitialSpace</span> <span class="Other">=</span> <span class="Identifier">false</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">CsvError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Similar to the <a class="reference external" href="#open,CsvParser,Stream,string,char,char,char">other open proc</a>, but creates the file stream for you.
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">os</span> <span class="Keyword">import</span> <span class="Identifier">removeFile</span>
<span class="Identifier">writeFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;One,Two,Three</span><span class="EscapeSequence">\n</span><span class="StringLit">1,2,3</span><span class="EscapeSequence">\n</span><span class="StringLit">10,20,300&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">parser</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">removeFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L141" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L141" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
<div id="open,CsvParser,Stream,string,char,char,char">
<dt><pre><span class="Keyword">proc</span> <a href="#open%2CCsvParser%2CStream%2Cstring%2Cchar%2Cchar%2Cchar"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</span></a><span class="Other">;</span> <span class="Identifier">input</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</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">separator</span> <span class="Other">=</span> <span class="CharLit">','</span><span class="Other">;</span>
<span class="Identifier">quote</span> <span class="Other">=</span> <span class="CharLit">'\&quot;'</span><span class="Other">;</span> <span class="Identifier">escape</span> <span class="Other">=</span> <span class="CharLit">'\x00'</span><span class="Other">;</span> <span class="Identifier">skipInitialSpace</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <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>
<dd>
Initializes the parser with an input stream. <tt class="docutils literal"><span class="pre"><span class="Identifier">Filename</span></span></tt> is only used for nice error messages. The parser's behaviour can be controlled by the diverse optional parameters:<ul class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">separator</span></span></tt>: character used to separate fields</li>
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">quote</span></span></tt>: Used to quote fields containing special characters like <tt class="docutils literal"><span class="pre"><span class="Identifier">separator</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">quote</span></span></tt> or new-line characters. '\0' disables the parsing of quotes.</li>
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">escape</span></span></tt>: removes any special meaning from the following character; '\0' disables escaping; if escaping is disabled and <tt class="docutils literal"><span class="pre"><span class="Identifier">quote</span></span></tt> is not '\0', two <tt class="docutils literal"><span class="pre"><span class="Identifier">quote</span></span></tt> characters are parsed one literal <tt class="docutils literal"><span class="pre"><span class="Identifier">quote</span></span></tt> character.</li>
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">skipInitialSpace</span></span></tt>: If true, whitespace immediately following the <tt class="docutils literal"><span class="pre"><span class="Identifier">separator</span></span></tt> is ignored.</li>
</ul>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#open,CsvParser,string,char,char,char">open proc</a> which creates the file stream for you</li>
</ul>
<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">streams</span>
<span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;One,Two,Three</span><span class="EscapeSequence">\n</span><span class="StringLit">1,2,3</span><span class="EscapeSequence">\n</span><span class="StringLit">10,20,30&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">parser</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">,</span> <span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="processedRows-procs-all">
<div id="processedRows,CsvParser">
<dt><pre><span class="Keyword">proc</span> <a href="#processedRows%2CCsvParser"><span class="Identifier">processedRows</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</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">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>
<dd>
<p>Returns number of the processed rows.</p>
<p>But even if <a class="reference external" href="#readRow,CsvParser,int">readRow</a> arrived at EOF then processed rows counter is incremented.</p>
<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">streams</span>
<span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;One,Two,Three</span><span class="EscapeSequence">\n</span><span class="StringLit">1,2,3&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">parser</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">,</span> <span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">processedRows</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">processedRows</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
<span class="Comment">## Even if `readRow` arrived at EOF then `processedRows` is incremented.</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">processedRows</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">processedRows</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L202" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L202" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="readHeaderRow-procs-all">
<div id="readHeaderRow,CsvParser">
<dt><pre><span class="Keyword">proc</span> <a href="#readHeaderRow%2CCsvParser"><span class="Identifier">readHeaderRow</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">CsvError</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>
<dd>
Reads the first row and creates a look-up table for column numbers See also:<ul class="simple"><li><a class="reference external" href="#rowEntry,CsvParser,string">rowEntry proc</a></li>
</ul>
<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">streams</span>
<span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;One,Two,Three</span><span class="EscapeSequence">\n</span><span class="StringLit">1,2,3&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">parser</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">,</span> <span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readHeaderRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">headers</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;One&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Two&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Three&quot;</span><span class="Punctuation">]</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;One&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Two&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Three&quot;</span><span class="Punctuation">]</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">headers</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;One&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Two&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Three&quot;</span><span class="Punctuation">]</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;3&quot;</span><span class="Punctuation">]</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="readRow-procs-all">
<div id="readRow,CsvParser,int">
<dt><pre><span class="Keyword">proc</span> <a href="#readRow%2CCsvParser%2Cint"><span class="Identifier">readRow</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</span></a><span class="Other">;</span> <span class="Identifier">columns</span> <span class="Other">=</span> <span class="DecNumber">0</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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">CsvError</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>
<dd>
<p>Reads the next row; if <tt class="docutils literal"><span class="pre"><span class="Identifier">columns</span></span></tt> &gt; 0, it expects the row to have exactly this many columns. Returns false if the end of the file has been encountered else true.</p>
<p>Blank lines are skipped.</p>
<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">streams</span>
<span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;One,Two,Three</span><span class="EscapeSequence">\n</span><span class="StringLit">1,2,3</span><span class="EscapeSequence">\n</span><span class="EscapeSequence">\n</span><span class="StringLit">10,20,30&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">parser</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">,</span> <span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;One&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Two&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Three&quot;</span><span class="Punctuation">]</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;3&quot;</span><span class="Punctuation">]</span>
<span class="Comment">## Blank lines are skipped.</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;10&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;20&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;30&quot;</span><span class="Punctuation">]</span>
<span class="Keyword">var</span> <span class="Identifier">emptySeq</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Identifier">emptySeq</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">row</span> <span class="Operator">==</span> <span class="Identifier">emptySeq</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L227" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L227" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
</dd>
</div>
</div>
<div id="rowEntry-procs-all">
<div id="rowEntry,CsvParser,string">
<dt><pre><span class="Keyword">proc</span> <a href="#rowEntry%2CCsvParser%2Cstring"><span class="Identifier">rowEntry</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecsv.html#CsvParser"><span class="Identifier">CsvParser</span></a><span class="Other">;</span> <span class="Identifier">entry</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">var</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">KeyError</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>
<dd>
<p>Accesses a specified <tt class="docutils literal"><span class="pre"><span class="Identifier">entry</span></span></tt> from the current row.</p>
<p>Assumes that <a class="reference external" href="#readHeaderRow,CsvParser">readHeaderRow</a> has already been called.</p>
<p>If specified <tt class="docutils literal"><span class="pre"><span class="Identifier">entry</span></span></tt> does not exist, raises KeyError.</p>
<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">streams</span>
<span class="Keyword">var</span> <span class="Identifier">strm</span> <span class="Operator">=</span> <span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="StringLit">&quot;One,Two,Three</span><span class="EscapeSequence">\n</span><span class="StringLit">1,2,3</span><span class="EscapeSequence">\n</span><span class="EscapeSequence">\n</span><span class="StringLit">10,20,30&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">parser</span><span class="Punctuation">:</span> <span class="Identifier">CsvParser</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">strm</span><span class="Punctuation">,</span> <span class="StringLit">&quot;tmp.csv&quot;</span><span class="Punctuation">)</span>
<span class="Comment">## Requires calling `readHeaderRow`.</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readHeaderRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">readRow</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">rowEntry</span><span class="Punctuation">(</span><span class="StringLit">&quot;One&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1&quot;</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">rowEntry</span><span class="Punctuation">(</span><span class="StringLit">&quot;Two&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;2&quot;</span>
<span class="Identifier">doAssert</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">rowEntry</span><span class="Punctuation">(</span><span class="StringLit">&quot;Three&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;3&quot;</span>
<span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">KeyError</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
<span class="Keyword">discard</span> <span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">rowEntry</span><span class="Punctuation">(</span><span class="StringLit">&quot;NonexistentEntry&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">parser</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">strm</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecsv.nim#L322" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecsv.nim#L322" 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:03 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