Deploying to gh-pages from @ 6cc6095 🚀

Author: LTLA

docs/doxygen-awesome.css

@@ -106,6 +106,7 @@
 <a href="functions.html"/>
 <a href="functions.html"/>
 <a href="functions.html"/>
+<a href="functions.html"/>
 <a href="functions_func.html"/>
 <a href="functions_func.html"/>
 <a href="functions_func.html"/>
@@ -127,6 +128,7 @@
 <a href="functions_vars.html"/>
 <a href="functions_vars.html"/>
 <a href="functions_vars.html"/>
+<a href="functions_vars.html"/>
 <a href="files.html"/>
 <a href="Environment_8hpp.html"/>
 <a href="RObject_8hpp.html"/>
@@ -336,7 +338,7 @@
 <a href="structrds2cpp_1_1PairList.html#ab5db0bbafb2affaa0f64532cb4c65388"/>
 <a href="structrds2cpp_1_1ParseRdsOptions.html"/>
 <a href="structrds2cpp_1_1ParseRdsOptions.html#a1dd6bd4c10e4685d02cc45f6c60fc6f2"/>
-<a href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce"/>
+<a href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b"/>
 <a href="structrds2cpp_1_1RObject.html"/>
 <a href="structrds2cpp_1_1RObject.html#a650039d33738c4d5b91d0df0977f6d9b"/>
 <a href="structrds2cpp_1_1RdsFile.html"/>

docs/doxygen_crawl.html

@@ -99,6 +99,11 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
 </ul>
 
 
+<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
+<li>buffer_size&#160;:&#160;<a class="el" href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">rds2cpp::ParseRdsOptions</a></li>
+</ul>
+
+
 <h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
 <li>class_encoding&#160;:&#160;<a class="el" href="structrds2cpp_1_1S4Object.html#a9aaea2ba7196414bc1f2118303de6887">rds2cpp::S4Object</a></li>
 <li>class_name&#160;:&#160;<a class="el" href="structrds2cpp_1_1S4Object.html#a7cb839f83694dc70d66c529848fd1e5f">rds2cpp::S4Object</a></li>
@@ -122,7 +127,6 @@ <h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
 
 
 <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
-<li>file_options&#160;:&#160;<a class="el" href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce">rds2cpp::ParseRdsOptions</a></li>
 <li>format_version&#160;:&#160;<a class="el" href="structrds2cpp_1_1RdsFile.html#ab6c650f54af12a20cf39bb2f677411db">rds2cpp::RdsFile</a></li>
 <li>function_encoding&#160;:&#160;<a class="el" href="structrds2cpp_1_1LanguageObject.html#a88a7d031093931584fa21490500edc47">rds2cpp::LanguageObject</a></li>
 <li>function_name&#160;:&#160;<a class="el" href="structrds2cpp_1_1LanguageObject.html#ab70121438413651f1e6e6fc95a0bb7c0">rds2cpp::LanguageObject</a></li>

docs/functions.html

@@ -97,6 +97,11 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
 </ul>
 
 
+<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
+<li>buffer_size&#160;:&#160;<a class="el" href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">rds2cpp::ParseRdsOptions</a></li>
+</ul>
+
+
 <h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
 <li>class_encoding&#160;:&#160;<a class="el" href="structrds2cpp_1_1S4Object.html#a9aaea2ba7196414bc1f2118303de6887">rds2cpp::S4Object</a></li>
 <li>class_name&#160;:&#160;<a class="el" href="structrds2cpp_1_1S4Object.html#a7cb839f83694dc70d66c529848fd1e5f">rds2cpp::S4Object</a></li>
@@ -118,7 +123,6 @@ <h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
 
 
 <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
-<li>file_options&#160;:&#160;<a class="el" href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce">rds2cpp::ParseRdsOptions</a></li>
 <li>format_version&#160;:&#160;<a class="el" href="structrds2cpp_1_1RdsFile.html#ab6c650f54af12a20cf39bb2f677411db">rds2cpp::RdsFile</a></li>
 <li>function_encoding&#160;:&#160;<a class="el" href="structrds2cpp_1_1LanguageObject.html#a88a7d031093931584fa21490500edc47">rds2cpp::LanguageObject</a></li>
 <li>function_name&#160;:&#160;<a class="el" href="structrds2cpp_1_1LanguageObject.html#ab70121438413651f1e6e6fc95a0bb7c0">rds2cpp::LanguageObject</a></li>

docs/functions_vars.html

@@ -38,6 +38,7 @@ var menudata={children:[
 {text:"Class Members",url:"functions.html",children:[
 {text:"All",url:"functions.html",children:[
 {text:"a",url:"functions.html#index_a"},
+{text:"b",url:"functions.html#index_b"},
 {text:"c",url:"functions.html#index_c"},
 {text:"d",url:"functions.html#index_d"},
 {text:"e",url:"functions.html#index_e"},
@@ -61,6 +62,7 @@ var menudata={children:[
 {text:"t",url:"functions_func.html#index_t"}]},
 {text:"Variables",url:"functions_vars.html",children:[
 {text:"a",url:"functions_vars.html#index_a"},
+{text:"b",url:"functions_vars.html#index_b"},
 {text:"c",url:"functions_vars.html#index_c"},
 {text:"d",url:"functions_vars.html#index_d"},
 {text:"e",url:"functions_vars.html#index_e"},

docs/menudata.js

@@ -402,10 +402,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#a241c3b1eaf4075a72418c894
   </tr>
 </table>
 </div><div class="memdoc">
-<p>Parse the contents of an RDS file.</p>
+<p>Parse the contents of a Gzip-compressed RDS file.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">file</td><td>Path to an RDS file. </td></tr>
+    <tr><td class="paramname">file</td><td>Path to a Gzip-compressed RDS file. </td></tr>
     <tr><td class="paramname">options</td><td>Further options for parsing.</td></tr>
   </table>
   </dd>

docs/namespacerds2cpp.html

@@ -113,18 +113,18 @@
 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structrds2cpp_1_1ParseRdsOptions.html">   26</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structrds2cpp_1_1ParseRdsOptions.html">ParseRdsOptions</a> {</div>
 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structrds2cpp_1_1ParseRdsOptions.html#a1dd6bd4c10e4685d02cc45f6c60fc6f2">   30</a></span>    <span class="keywordtype">bool</span> <a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#a1dd6bd4c10e4685d02cc45f6c60fc6f2">parallel</a> = <span class="keyword">false</span>;</div>
 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
-<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce">   36</a></span>    <a class="code hl_structRef" href="https://ltla.github.io/byteme/structbyteme_1_1SomeFileReaderOptions.html">byteme::SomeFileReaderOptions</a> <a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce">file_options</a>;</div>
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">   36</a></span>    std::size_t <a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">buffer_size</a> = 65536;</div>
 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>};</div>
 </div>
 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> Reader_&gt;</div>
 <div class="foldopen" id="foldopen00050" data-start="{" data-end="}">
 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="namespacerds2cpp.html#a6e8135078d12460c602af9c3933eb435">   50</a></span><a class="code hl_struct" href="structrds2cpp_1_1RdsFile.html">RdsFile</a> <a class="code hl_function" href="namespacerds2cpp.html#a6e8135078d12460c602af9c3933eb435">parse_rds</a>(Reader_&amp; reader, <span class="keyword">const</span> <a class="code hl_struct" href="structrds2cpp_1_1ParseRdsOptions.html">ParseRdsOptions</a>&amp; options) {</div>
-<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    std::unique_ptr&lt;byteme::PerByteInterface&lt;unsigned char&gt; &gt; srcptr;</div>
+<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    std::unique_ptr&lt;byteme::BufferedReader&lt;unsigned char&gt; &gt; srcptr;</div>
 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keywordflow">if</span> (options.<a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#a1dd6bd4c10e4685d02cc45f6c60fc6f2">parallel</a>) {</div>
-<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>        srcptr.reset(<span class="keyword">new</span> <a class="code hl_classRef" href="https://ltla.github.io/byteme/classbyteme_1_1PerByteParallel.html">byteme::PerByteParallel&lt;unsigned char, Reader_*&gt;</a>(&amp;reader));</div>
+<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>        srcptr.reset(<span class="keyword">new</span> <a class="code hl_classRef" href="https://ltla.github.io/byteme/classbyteme_1_1SerialBufferedReader.html">byteme::SerialBufferedReader&lt;unsigned char, Reader_*&gt;</a>(&amp;reader, options.<a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">buffer_size</a>));</div>
 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>    } <span class="keywordflow">else</span> {</div>
-<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>        srcptr.reset(<span class="keyword">new</span> <a class="code hl_classRef" href="https://ltla.github.io/byteme/classbyteme_1_1PerByteSerial.html">byteme::PerByteSerial&lt;unsigned char, Reader_*&gt;</a>(&amp;reader));</div>
+<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>        srcptr.reset(<span class="keyword">new</span> <a class="code hl_classRef" href="https://ltla.github.io/byteme/classbyteme_1_1ParallelBufferedReader.html">byteme::ParallelBufferedReader&lt;unsigned char, Reader_*&gt;</a>(&amp;reader, options.<a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">buffer_size</a>));</div>
 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>    }</div>
 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    <span class="keyword">auto</span>&amp; src = *srcptr; </div>
 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    <a class="code hl_struct" href="structrds2cpp_1_1RdsFile.html">RdsFile</a> output(<span class="keyword">false</span>);</div>
@@ -227,7 +227,7 @@
 <div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span> </div>
 <div class="foldopen" id="foldopen00163" data-start="{" data-end="}">
 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="namespacerds2cpp.html#a241c3b1eaf4075a72418c89407e76a20">  163</a></span><span class="keyword">inline</span> <a class="code hl_struct" href="structrds2cpp_1_1RdsFile.html">RdsFile</a> <a class="code hl_function" href="namespacerds2cpp.html#a6e8135078d12460c602af9c3933eb435">parse_rds</a>(std::string file, <span class="keyword">const</span> <a class="code hl_struct" href="structrds2cpp_1_1ParseRdsOptions.html">ParseRdsOptions</a>&amp; options) {</div>
-<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    <a class="code hl_classRef" href="https://ltla.github.io/byteme/classbyteme_1_1SomeFileReader.html">byteme::SomeFileReader</a> reader(file.c_str(), options.<a class="code hl_variable" href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce">file_options</a>);</div>
+<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    <a class="code hl_classRef" href="https://ltla.github.io/byteme/classbyteme_1_1GzipFileReader.html">byteme::GzipFileReader</a> reader(file.c_str(), {});</div>
 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="namespacerds2cpp.html#a6e8135078d12460c602af9c3933eb435">parse_rds</a>(reader, options);</div>
 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>}</div>
 </div>
@@ -239,16 +239,15 @@
 <div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="aRdsFile_8hpp_html"><div class="ttname"><a href="RdsFile_8hpp.html">RdsFile.hpp</a></div><div class="ttdoc">Information about an RDS file.</div></div>
 <div class="ttc" id="abyteme_8hpp_html"><div class="ttname"><a href="https://ltla.github.io/byteme/byteme_8hpp.html">byteme.hpp</a></div></div>
-<div class="ttc" id="aclassbyteme_1_1PerByteParallel_html"><div class="ttname"><a href="https://ltla.github.io/byteme/classbyteme_1_1PerByteParallel.html">byteme::PerByteParallel</a></div></div>
-<div class="ttc" id="aclassbyteme_1_1PerByteSerial_html"><div class="ttname"><a href="https://ltla.github.io/byteme/classbyteme_1_1PerByteSerial.html">byteme::PerByteSerial</a></div></div>
-<div class="ttc" id="aclassbyteme_1_1SomeFileReader_html"><div class="ttname"><a href="https://ltla.github.io/byteme/classbyteme_1_1SomeFileReader.html">byteme::SomeFileReader</a></div></div>
+<div class="ttc" id="aclassbyteme_1_1GzipFileReader_html"><div class="ttname"><a href="https://ltla.github.io/byteme/classbyteme_1_1GzipFileReader.html">byteme::GzipFileReader</a></div></div>
+<div class="ttc" id="aclassbyteme_1_1ParallelBufferedReader_html"><div class="ttname"><a href="https://ltla.github.io/byteme/classbyteme_1_1ParallelBufferedReader.html">byteme::ParallelBufferedReader</a></div></div>
+<div class="ttc" id="aclassbyteme_1_1SerialBufferedReader_html"><div class="ttname"><a href="https://ltla.github.io/byteme/classbyteme_1_1SerialBufferedReader.html">byteme::SerialBufferedReader</a></div></div>
 <div class="ttc" id="anamespacerds2cpp_html"><div class="ttname"><a href="namespacerds2cpp.html">rds2cpp</a></div><div class="ttdoc">Parse an RDS file in C++.</div><div class="ttdef"><b>Definition</b> StringEncoding.hpp:10</div></div>
 <div class="ttc" id="anamespacerds2cpp_html_a6e8135078d12460c602af9c3933eb435"><div class="ttname"><a href="namespacerds2cpp.html#a6e8135078d12460c602af9c3933eb435">rds2cpp::parse_rds</a></div><div class="ttdeci">RdsFile parse_rds(Reader_ &amp;reader, const ParseRdsOptions &amp;options)</div><div class="ttdef"><b>Definition</b> parse_rds.hpp:50</div></div>
 <div class="ttc" id="anamespacerds2cpp_html_a9a4371900eec82463a3aa0a2a9d5cce1"><div class="ttname"><a href="namespacerds2cpp.html#a9a4371900eec82463a3aa0a2a9d5cce1">rds2cpp::Parsed</a></div><div class="ttdeci">RdsFile Parsed</div><div class="ttdef"><b>Definition</b> parse_rds.hpp:171</div></div>
-<div class="ttc" id="astructbyteme_1_1SomeFileReaderOptions_html"><div class="ttname"><a href="https://ltla.github.io/byteme/structbyteme_1_1SomeFileReaderOptions.html">byteme::SomeFileReaderOptions</a></div></div>
 <div class="ttc" id="astructrds2cpp_1_1ParseRdsOptions_html"><div class="ttname"><a href="structrds2cpp_1_1ParseRdsOptions.html">rds2cpp::ParseRdsOptions</a></div><div class="ttdoc">Options for parse_rds().</div><div class="ttdef"><b>Definition</b> parse_rds.hpp:26</div></div>
 <div class="ttc" id="astructrds2cpp_1_1ParseRdsOptions_html_a1dd6bd4c10e4685d02cc45f6c60fc6f2"><div class="ttname"><a href="structrds2cpp_1_1ParseRdsOptions.html#a1dd6bd4c10e4685d02cc45f6c60fc6f2">rds2cpp::ParseRdsOptions::parallel</a></div><div class="ttdeci">bool parallel</div><div class="ttdef"><b>Definition</b> parse_rds.hpp:30</div></div>
-<div class="ttc" id="astructrds2cpp_1_1ParseRdsOptions_html_ace40bcfb11a4966058d06c5a988202ce"><div class="ttname"><a href="structrds2cpp_1_1ParseRdsOptions.html#ace40bcfb11a4966058d06c5a988202ce">rds2cpp::ParseRdsOptions::file_options</a></div><div class="ttdeci">byteme::SomeFileReaderOptions file_options</div><div class="ttdef"><b>Definition</b> parse_rds.hpp:36</div></div>
+<div class="ttc" id="astructrds2cpp_1_1ParseRdsOptions_html_ad4ba63c29226fef224ffa0c44a20bb0b"><div class="ttname"><a href="structrds2cpp_1_1ParseRdsOptions.html#ad4ba63c29226fef224ffa0c44a20bb0b">rds2cpp::ParseRdsOptions::buffer_size</a></div><div class="ttdeci">std::size_t buffer_size</div><div class="ttdef"><b>Definition</b> parse_rds.hpp:36</div></div>
 <div class="ttc" id="astructrds2cpp_1_1RdsFile_html"><div class="ttname"><a href="structrds2cpp_1_1RdsFile.html">rds2cpp::RdsFile</a></div><div class="ttdoc">Contents of the parsed RDS file.</div><div class="ttdef"><b>Definition</b> RdsFile.hpp:21</div></div>
 <div class="ttc" id="astructrds2cpp_1_1RdsFile_html_a24c37c4e7b3356ed5a1301dec32d4b78"><div class="ttname"><a href="structrds2cpp_1_1RdsFile.html#a24c37c4e7b3356ed5a1301dec32d4b78">rds2cpp::RdsFile::writer_version</a></div><div class="ttdeci">std::array&lt; unsigned char, 3 &gt; writer_version</div><div class="ttdef"><b>Definition</b> RdsFile.hpp:53</div></div>
 <div class="ttc" id="astructrds2cpp_1_1RdsFile_html_a4d451375c25d57d203169dce2bed1507"><div class="ttname"><a href="structrds2cpp_1_1RdsFile.html#a4d451375c25d57d203169dce2bed1507">rds2cpp::RdsFile::object</a></div><div class="ttdeci">std::unique_ptr&lt; RObject &gt; object</div><div class="ttdef"><b>Definition</b> RdsFile.hpp:68</div></div>

docs/parse__rds_8hpp_source.html

@@ -550,10 +550,10 @@
       <arglist></arglist>
     </member>
     <member kind="variable">
-      <type>byteme::SomeFileReaderOptions</type>
-      <name>file_options</name>
+      <type>std::size_t</type>
+      <name>buffer_size</name>
       <anchorfile>structrds2cpp_1_1ParseRdsOptions.html</anchorfile>
-      <anchor>ace40bcfb11a4966058d06c5a988202ce</anchor>
+      <anchor>ad4ba63c29226fef224ffa0c44a20bb0b</anchor>
       <arglist></arglist>
     </member>
   </compound>