You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2018/08/07 01:02:29 UTC
[14/51] [partial] arrow-site git commit: Update documentation for
0.10.0
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7f9d5fdc/docs/cpp/feather_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/feather_8h_source.html b/docs/cpp/feather_8h_source.html
index a351581..6dd7102 100644
--- a/docs/cpp/feather_8h_source.html
+++ b/docs/cpp/feather_8h_source.html
@@ -72,7 +72,7 @@ $(function() {
<div class="contents">
<a href="feather_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class
="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed u
nder the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Public API for the "Feather" file format, originally created at</span></div><div class="line
"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// http://github.com/wesm/feather</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef ARROW_IPC_FEATHER_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define ARROW_IPC_FEATHER_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <string&g
t;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Column;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="key
word">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>OutputStream;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>RandomAccessFile;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">nam
espace </span>ipc {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">namespace </span>feather {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> constexpr <span class="keyword">const</span> <span class="keywordtype">int</span> kFeatherVersion = 2;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// ----------------------------------------------------------------------</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// Metadata accessor classes</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00053"></a>
<span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html"> 53</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html">TableReader</a> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html">TableReader</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  ~<a class="code" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html">TableReader</a>();</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status<
/a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& source,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::unique_ptr<TableReader>* out);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::string GetDescription() <span class="keyword">const</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> HasDescription() <span class="keyword">const</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> version() <span class="keyword">const</span>;</div
><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  int64_t num_rows() <span class="keyword">const</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  int64_t num_columns() <span class="keyword">const</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::string GetColumnName(<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetColumn(<span class="keywordtype">int</span> i,
std::shared_ptr<Column>* out);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> TableReaderImpl;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::unique_ptr<TableReaderImpl> impl_;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1feather_1_1_table_writer.html"> 101</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="
code" href="classarrow_1_1ipc_1_1feather_1_1_table_writer.html">TableWriter</a> {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  ~<a class="code" href="classarrow_1_1ipc_1_1feather_1_1_table_writer.html">TableWriter</a>();</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::OutputStream>& stream,</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  std::unique_ptr<TableWriter>* out);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a
name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> SetDescription(<span class="keyword">const</span> std::string& desc);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> SetNumRows(int64_t num_rows);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Append(<span class="keyword">const</span> std::string& name, <span class="keyword">const</span> <a class="code" href="classarrow_1_1_array.html">Array</a>& values);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" h
ref="classarrow_1_1_status.html">Status</a> Finalize();</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="classarrow_1_1ipc_1_1feather_1_1_table_writer.html">TableWriter</a>();</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> TableWriterImpl;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  std::unique_ptr<TableWriterImpl> impl_;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> };</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line">
<a name="l00135"></a><span class="lineno"> 135</span> } <span class="comment">// namespace feather</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif // ARROW_IPC_FEATHER_H</span></div><div class="ttc" id="classarrow_1_1ipc_1_1feather_1_1_table_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1feather_1_1_table_writer.html">arrow::ipc::feather::TableWriter</a></div><div class="ttdoc">Interface for writing Feather files. </div><div class="ttdef"><b>Definition:</b> feather.h:101</div></div>
<div class="ttc" id="visibility_8h_html_a843cb8dccea68a22a2b9995605cb5a74"><div class="ttname"><a href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a></div><div class="ttdeci">#define ARROW_NO_EXPORT</div><div class="ttdef"><b>Definition:</b> visibility.h:42</div></div>
-<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:93</div></div>
+<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:94</div></div>
<div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div>
<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div>
<div class="ttc" id="classarrow_1_1_array_html"><div class="ttname"><a href="classarrow_1_1_array.html">arrow::Array</a></div><div class="ttdoc">Array base type Immutable data array with some logical type and some length. </div><div class="ttdef"><b>Definition:</b> array.h:200</div></div>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7f9d5fdc/docs/cpp/file_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/file_8h_source.html b/docs/cpp/file_8h_source.html
index 381c462..ded059b 100644
--- a/docs/cpp/file_8h_source.html
+++ b/docs/cpp/file_8h_source.html
@@ -70,12 +70,12 @@ $(function() {
<div class="title">file.h</div> </div>
</div><!--header-->
<div class="contents">
-<a href="file_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class="l
ineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed unde
r the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// IO interface implementations for OS files</span></div><div class="line"><a name="l00019"></a><span class=
"lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IO_FILE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IO_FILE_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class=
"preprocessor">#include "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>
 <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_file_output_stream.html"> 38</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_file_output_stream.html">FileOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ~<a class="code" href="classarrow_1
_1io_1_1_file_output_stream.html">FileOutputStream</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, std::shared_ptr<OutputStream>* out);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, <span class="keywordtype">bool</span> append,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::shared_ptr<OutputStream>* out);</div><d
iv class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, std::shared_ptr<OutputStream>* out);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, std::shared_ptr<FileOutputStream>* file);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<
span class="keyword">const</span> std::string& path, <span class="keywordtype">bool</span> append,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::shared_ptr<FileOutputStream>* file);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, std::shared_ptr<FileOutputStream>* out);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// OutputStream interface</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span
class="keyword">override</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// Write bytes to the stream. Thread-safe</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">int</span> file_descriptor
() <span class="keyword">const</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classarrow_1_1io_1_1_file_output_stream.html">FileOutputStream</a>();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> FileOutputStreamImpl;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  std::unique_ptr<FileOutputStreamImpl> impl_;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> };</div><div class="line"><a name=
"l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// Operating system file</span></div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_readable_file.html"> 107</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_readable_file.html">ReadableFile</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">RandomAccessFile</a> {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  ~<a class="code" href="classarrow_1_1io_1_1_readable_file.html">ReadableFile</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</
span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00132"></a><span class="l
ineno"> 132</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool, std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</s
pan>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// Read bytes from the file. Thread-safe</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, <span class="keywordtype">void</span>* buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class=
"line"><a name="l00152"></a><span class="lineno"> 152</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size) <span class="keyword">ov
erride</span>;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">int</span> file_descriptor() <span class="keyword">const</span>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00
166"></a><span class="lineno"> 166</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_readable_file.html">ReadableFile</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> ReadableFileImpl;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  std::unique_ptr<ReadableFileImpl> impl_;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> };</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// A file interface that u
ses memory-mapped files for memory interactions,</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// supporting zero copy reads. The same class is used for both reading and</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">// writing.</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">//</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">// If opening a file in a writeable mode, it is not truncated first as with</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">// FileOutputStream</span></div><div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_memory_mapped_file.html"> 178</a></span> <span class="keyword">class </span>ARROW
_EXPORT <a class="code" href="classarrow_1_1io_1_1_memory_mapped_file.html">MemoryMappedFile</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_read_write_file_interface.html">ReadWriteFileInterface</a> {</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  ~<a class="code" href="classarrow_1_1io_1_1_memory_mapped_file.html">MemoryMappedFile</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Create(<span class="keyword">const</span> std::string& path, int64_t size,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span
>  std::shared_ptr<MemoryMappedFile>* out);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, <a class="code" href="structarrow_1_1io_1_1_file_mode.html#a41b6fb9caec96f1e634fb8052c9a9310">FileMode::type</a> mode,</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  std::shared_ptr<MemoryMappedFile>* out);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00190"></a>
<span class="lineno"> 190</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="comment">// Required by RandomAccessFile, copies memory into out. Not thread-safe</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* byt
es_read, <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="comment">// Zero copy read. Not thread-safe</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordtype">void</span>*
out) <span class="keyword">override</span>;</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <s
pan class="keyword">override</span>;</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> WriteAt(int64_t position, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="comment">// @return: the size in bytes of the memory source</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size) <span class="keyword">override</span>;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a na
me="l00218"></a><span class="lineno"> 218</span>  <span class="keywordtype">int</span> file_descriptor() <span class="keyword">const</span>;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <a class="code" href="classarrow_1_1io_1_1_memory_mapped_file.html">MemoryMappedFile</a>();</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> WriteInternal(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes);</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00225"><
/a><span class="lineno"> 225</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> MemoryMap;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  std::shared_ptr<MemoryMap> memory_map_;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> };</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="preprocessor">#endif // ARROW_IO_FILE_H</span></div><div class="
ttc" id="classarrow_1_1io_1_1_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:111</div></div>
+<a href="file_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class="l
ineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed unde
r the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// IO interface implementations for OS files</span></div><div class="line"><a name="l00019"></a><span class=
"lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IO_FILE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IO_FILE_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class=
"preprocessor">#include "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>
 <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_file_output_stream.html"> 38</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_file_output_stream.html">FileOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ~<a class="code" href="classarrow_1
_1io_1_1_file_output_stream.html">FileOutputStream</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, std::shared_ptr<OutputStream>* out);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, <span class="keywordtype">bool</span> append,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::shared_ptr<OutputStream>* out);</div><d
iv class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, std::shared_ptr<OutputStream>* out);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, std::shared_ptr<FileOutputStream>* file);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<
span class="keyword">const</span> std::string& path, <span class="keywordtype">bool</span> append,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::shared_ptr<FileOutputStream>* file);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, std::shared_ptr<FileOutputStream>* out);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// OutputStream interface</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span
class="keyword">override</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// Write bytes to the stream. Thread-safe</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">int</span> file_descriptor
() <span class="keyword">const</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classarrow_1_1io_1_1_file_output_stream.html">FileOutputStream</a>();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> FileOutputStreamImpl;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  std::unique_ptr<FileOutputStreamImpl> impl_;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> };</div><div class="line"><a name=
"l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// Operating system file</span></div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_readable_file.html"> 107</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_readable_file.html">ReadableFile</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">RandomAccessFile</a> {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  ~<a class="code" href="classarrow_1_1io_1_1_readable_file.html">ReadableFile</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</
span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00132"></a><span class="l
ineno"> 132</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keywordtype">int</span> fd, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool, std::shared_ptr<ReadableFile>* file);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</s
pan>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// Read bytes from the file. Thread-safe</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, <span class="keywordtype">void</span>* buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class=
"line"><a name="l00152"></a><span class="lineno"> 152</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size) <span class="keyword">ov
erride</span>;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">int</span> file_descriptor() <span class="keyword">const</span>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00
166"></a><span class="lineno"> 166</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_readable_file.html">ReadableFile</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> ReadableFileImpl;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  std::unique_ptr<ReadableFileImpl> impl_;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> };</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// A file interface that u
ses memory-mapped files for memory interactions,</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// supporting zero copy reads. The same class is used for both reading and</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">// writing.</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">//</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">// If opening a file in a writeable mode, it is not truncated first as with</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">// FileOutputStream</span></div><div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_memory_mapped_file.html"> 178</a></span> <span class="keyword">class </span>ARROW
_EXPORT <a class="code" href="classarrow_1_1io_1_1_memory_mapped_file.html">MemoryMappedFile</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_read_write_file_interface.html">ReadWriteFileInterface</a> {</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  ~<a class="code" href="classarrow_1_1io_1_1_memory_mapped_file.html">MemoryMappedFile</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Create(<span class="keyword">const</span> std::string& path, int64_t size,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span
>  std::shared_ptr<MemoryMappedFile>* out);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::string& path, <a class="code" href="structarrow_1_1io_1_1_file_mode.html#a41b6fb9caec96f1e634fb8052c9a9310">FileMode::type</a> mode,</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  std::shared_ptr<MemoryMappedFile>* out);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00190"></a>
<span class="lineno"> 190</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="comment">// Required by RandomAccessFile, copies memory into out. Not thread-safe</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* byt
es_read, <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="comment">// Zero copy read, moves position pointer. Not thread-safe</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="comment">// Zero-copy read, leaves position unchanged. Acquires a reader lock</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="comment">// for the duration of slice cre
ation (typically very short). Is thread-safe.</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="comment">// Raw copy of the memory at specified position. Thread-safe, but</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="comment">// locks out other readers for the duration of memcpy. Prefer the</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="comment">// zero copy method</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <a class="code" hre
f="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00215"></a><span class="lineno">
215</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Resize(int64_t new_size);</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> WriteAt(int64_t position, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="comment">// @return: the size in bytes of the memory source</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size)
<span class="keyword">override</span>;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keywordtype">int</span> file_descriptor() <span class="keyword">const</span>;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <a class="code" href="classarrow_1_1io_1_1_memory_mapped_file.html">MemoryMappedFile</a>();</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> WriteInternal(<span class="keyword">const</span> <span class="keywordtype">void</spa
n>* data, int64_t nbytes);</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> MemoryMap;</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  std::shared_ptr<MemoryMap> memory_map_;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> };</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div
class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#endif // ARROW_IO_FILE_H</span></div><div class="ttc" id="classarrow_1_1io_1_1_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:111</div></div>
<div class="ttc" id="visibility_8h_html_a843cb8dccea68a22a2b9995605cb5a74"><div class="ttname"><a href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a></div><div class="ttdeci">#define ARROW_NO_EXPORT</div><div class="ttdef"><b>Definition:</b> visibility.h:42</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_file_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_file_output_stream.html">arrow::io::FileOutputStream</a></div><div class="ttdef"><b>Definition:</b> file.h:38</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_random_access_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:121</div></div>
<div class="ttc" id="classarrow_1_1io_1_1_memory_mapped_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_memory_mapped_file.html">arrow::io::MemoryMappedFile</a></div><div class="ttdef"><b>Definition:</b> file.h:178</div></div>
-<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:93</div></div>
+<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:94</div></div>
<div class="ttc" id="interfaces_8h_html"><div class="ttname"><a href="interfaces_8h.html">interfaces.h</a></div></div>
<div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div>
<div class="ttc" id="classarrow_1_1io_1_1_read_write_file_interface_html"><div class="ttname"><a href="classarrow_1_1io_1_1_read_write_file_interface.html">arrow::io::ReadWriteFileInterface</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:173</div></div>