http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/writer_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/writer_8h_source.html b/docs/cpp/writer_8h_source.html index 222abc4..eabd385 100644 --- a/docs/cpp/writer_8h_source.html +++ b/docs/cpp/writer_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/ipc/writer.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/ipc/writer.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -67,7 +67,7 @@ $(function() { <div class="title">writer.h</div> </div> </div><!--header--> <div class="contents"> -<a href="writer_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 un der 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">// Implement Arrow streaming binary format</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_IPC_WRITER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_WRITER_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 <functional></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 <vector></span></div><div class="line"><a na me="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="message_8h.html">arrow/ipc/message.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00034"></a><span class="linen o"> 34</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Field;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>Table;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>Tensor;</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">namespace </span>io {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span>OutputStream;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">namespace </span>ipc {</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_1ip c_1_1_record_batch_writer.html"> 53</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</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>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html" >RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit >= <span class="keyword">false</span>) = 0;</div><div class="line"><a >name="l00062"></a><span class="lineno"> 62</span> </div><div >class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a >class="code" href="classarrow_1_1_status.html">Status</a> WriteTable(<span >class="keyword">const</span> <a class="code" >href="classarrow_1_1_table.html">Table</a>& table);</div><div >class="line"><a name="l00067"></a><span class="lineno"> >67</span> </div><div class="line"><a name="l00071"></a><span >class="lineno"> 71</span>  <span class="keyword">virtual</span> <a >class="code" href="classarrow_1_1_status.html">Status</a> Close() = >0;</div><div class="line"><a name="l00072"></a><span class="lineno"> >72</span> </div><div class="line"><a name="l00077"></a><span >class="lineno"> 77</span>  <span class="keyword">virtual</span> <span >class="keywordtype">void</span> set _memory_pool(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool) = 0;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html"> 83</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc _1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a>();</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::shared_ptr<RecordBatchWriter>* out);</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="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line" ><a name="l00098"></a><span class="lineno"> 98</span>  <span >class="keyword">static</span> <a class="code" >href="classarrow_1_1_status.html">Status</a> Open(<a class="code" >href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, ><span class="keyword">const</span> std::shared_ptr<Schema>& >schema,</div><div class="line"><a name="l00100"></a><span class="lineno"> >100</span>  >std::shared_ptr<RecordBatchStreamWriter>* out);</div><div >class="line"><a name="l00101"></a><span class="lineno"> >101</span> <span class="preprocessor">#endif</span></div><div >class="line"><a name="l00102"></a><span class="lineno"> >102</span> </div><div class="line"><a name="l00103"></a><span >class="lineno"> 103</span>  <a class="code" >href="classarrow_1_1_status.html">Status</a> <a class="code" >href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span > class="keyword">const</span> <a class="c ode" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> set_memory_pool(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool) <span class="keyword">override</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch _stream_writer.html">RecordBatchStreamWriter</a>();</div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a38780b171958b6ac66d851990c37eed2"> 109</a></span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchStreamWriterImpl;</div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c"> 110</a></span>  std::unique_ptr<RecordBatchStreamWriterImpl> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c">impl_</a>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00118"></ a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html"> 118</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> {</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a>();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">static</span> <a class="code" href="classarr ow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>,</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  std::shared_ptr<RecordBatchWriter>* out);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_p tr<Schema>& schema,</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  std::shared_ptr<RecordBatchFileWriter>* out);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href= "classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a>();</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchFileWriterImpl;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  std::unique_ptr<RecordBatchFileWriterImpl> impl_;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> };</div><div class="line"><a name="l00145"></a>< span class="lineno"> 145</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> ARROW_EXPORT</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t buffer_start_offset,</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  int64_t* body_length, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l001 73"></a><span class="lineno"> 173</span>  <span class="keywordtype">int</span> max_recursion_depth = <a class="code" href="namespacearrow_1_1ipc.html#a2dfe6a86ac11df4637223d48d29111a9">kMaxNestingDepth</a>,</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> ARROW_EXPORT</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ab0fe4d9b40565425a1efb0a12c140ee6">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="cod e" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> ARROW_EXPORT</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ab0fe4d9b40565425a1efb0a12c140ee6">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="classarrow_1_1io_1_1_ou tput_stream.html">io::OutputStream</a>* out);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ARROW_EXPORT</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#aca60da7b1ad5d741c9180f5271a36b50">SerializeSchema</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a nam e="l00213"></a><span class="lineno"> 213</span> ARROW_EXPORT</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ace91da34babf6685e5a71dcb0bb70eb5">WriteRecordBatchStream</a>(<span class="keyword">const</span> std::vector<std::shared_ptr<RecordBatch>>& batches,</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst);</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">// Compute the precise number of bytes needed in a contiguous memory segment to</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span cla ss="comment">// write the record batch. This involves generating the complete serialized</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">// Flatbuffers metadata.</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> ARROW_EXPORT</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">GetRecordBatchSize</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t* size);</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> <span class="comment">// Compute the precise number of bytes needed in a contiguous memory segment to</span></div>< div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">// write the tensor including metadata, padding, and data</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> ARROW_EXPORT</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">GetTensorSize</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, int64_t* size);</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> ARROW_EXPORT</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ip c.html#aab7e08532aec7267dac70e923df75e52">WriteTensor</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  int64_t* body_length);</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> ARROW_EXPORT</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a4102cf3f45bce789692636051ec6128e">WriteLargeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t buffer_start_offset,</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  int64_t* body_length, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</spa n> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor">#endif // ARROW_IPC_WRITER_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:110</div></div> +<a href="writer_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 un der 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">// Implement Arrow streaming binary format</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_IPC_WRITER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_WRITER_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 <functional></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 <vector></span></div><div class="line"><a na me="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="message_8h.html">arrow/ipc/message.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Array;</div><div class="line"><a name="l00034"></a><span class="linen o"> 34</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Field;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>Table;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>Tensor;</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">namespace </span>io {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span>OutputStream;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">namespace </span>ipc {</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_1ip c_1_1_record_batch_writer.html"> 53</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</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>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html" >RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit >= <span class="keyword">false</span>) = 0;</div><div class="line"><a >name="l00062"></a><span class="lineno"> 62</span> </div><div >class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a >class="code" href="classarrow_1_1_status.html">Status</a> WriteTable(<span >class="keyword">const</span> <a class="code" >href="classarrow_1_1_table.html">Table</a>& table);</div><div >class="line"><a name="l00067"></a><span class="lineno"> >67</span> </div><div class="line"><a name="l00071"></a><span >class="lineno"> 71</span>  <span class="keyword">virtual</span> <a >class="code" href="classarrow_1_1_status.html">Status</a> Close() = >0;</div><div class="line"><a name="l00072"></a><span class="lineno"> >72</span> </div><div class="line"><a name="l00077"></a><span >class="lineno"> 77</span>  <span class="keyword">virtual</span> <span >class="keywordtype">void</span> set _memory_pool(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool) = 0;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html"> 83</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc _1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a>();</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::shared_ptr<RecordBatchWriter>* out);</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="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line" ><a name="l00098"></a><span class="lineno"> 98</span>  <span >class="keyword">static</span> <a class="code" >href="classarrow_1_1_status.html">Status</a> Open(<a class="code" >href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, ><span class="keyword">const</span> std::shared_ptr<Schema>& >schema,</div><div class="line"><a name="l00100"></a><span class="lineno"> >100</span>  >std::shared_ptr<RecordBatchStreamWriter>* out);</div><div >class="line"><a name="l00101"></a><span class="lineno"> >101</span> <span class="preprocessor">#endif</span></div><div >class="line"><a name="l00102"></a><span class="lineno"> >102</span> </div><div class="line"><a name="l00103"></a><span >class="lineno"> 103</span>  <a class="code" >href="classarrow_1_1_status.html">Status</a> <a class="code" >href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span > class="keyword">const</span> <a class="c ode" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> set_memory_pool(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool) <span class="keyword">override</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch _stream_writer.html">RecordBatchStreamWriter</a>();</div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a38780b171958b6ac66d851990c37eed2"> 109</a></span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchStreamWriterImpl;</div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c"> 110</a></span>  std::unique_ptr<RecordBatchStreamWriterImpl> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c">impl_</a>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00118"></ a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html"> 118</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> {</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a>();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">static</span> <a class="code" href="classarr ow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>,</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  std::shared_ptr<RecordBatchWriter>* out);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_p tr<Schema>& schema,</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  std::shared_ptr<RecordBatchFileWriter>* out);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href= "classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a>();</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchFileWriterImpl;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  std::unique_ptr<RecordBatchFileWriterImpl> impl_;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> };</div><div class="line"><a name="l00145"></a>< span class="lineno"> 145</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> ARROW_EXPORT</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t buffer_start_offset,</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  int64_t* body_length, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l001 73"></a><span class="lineno"> 173</span>  <span class="keywordtype">int</span> max_recursion_depth = <a class="code" href="namespacearrow_1_1ipc.html#a2dfe6a86ac11df4637223d48d29111a9">kMaxNestingDepth</a>,</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> ARROW_EXPORT</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ab0fe4d9b40565425a1efb0a12c140ee6">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="cod e" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> ARROW_EXPORT</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ab0fe4d9b40565425a1efb0a12c140ee6">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="classarrow_1_1io_1_1_ou tput_stream.html">io::OutputStream</a>* out);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ARROW_EXPORT</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#aca60da7b1ad5d741c9180f5271a36b50">SerializeSchema</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a nam e="l00213"></a><span class="lineno"> 213</span> ARROW_EXPORT</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ace91da34babf6685e5a71dcb0bb70eb5">WriteRecordBatchStream</a>(<span class="keyword">const</span> std::vector<std::shared_ptr<RecordBatch>>& batches,</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst);</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">// Compute the precise number of bytes needed in a contiguous memory segment to</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span cla ss="comment">// write the record batch. This involves generating the complete serialized</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment">// Flatbuffers metadata.</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> ARROW_EXPORT</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">GetRecordBatchSize</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t* size);</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> <span class="comment">// Compute the precise number of bytes needed in a contiguous memory segment to</span></div>< div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">// write the tensor including metadata, padding, and data</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> ARROW_EXPORT</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">GetTensorSize</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, int64_t* size);</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> ARROW_EXPORT</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ip c.html#aab7e08532aec7267dac70e923df75e52">WriteTensor</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  int64_t* body_length);</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#ifndef ARROW_NO_DEPRECATED_API</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> ARROW_EXPORT</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a4102cf3f45bce789692636051ec6128e">WriteLargeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t buffer_start_offset,</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  int64_t* body_length, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</spa n> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor">#endif // ARROW_IPC_WRITER_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:115</div></div> <div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></div><div class="ttdoc">Abstract interface for writing a stream of record batches. </div><div class="ttdef"><b>Definition:</b> writer.h:53</div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_a88fc025cbc22af0f537c96e96eb24435"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">arrow::ipc::WriteRecordBatch</a></div><div class="ttdeci">Status WriteRecordBatch(const RecordBatch &batch, int64_t buffer_start_offset, io::OutputStream *dst, int32_t *metadata_length, int64_t *body_length, MemoryPool *pool, int max_recursion_depth=kMaxNestingDepth, bool allow_64bit=false)</div><div class="ttdoc">Write the RecordBatch (collection of equal-length Arrow arrays) to the output stream in a contiguous ...</div></div> <div class="ttc" id="namespacearrow_html_ae1692c648f5447a7f95ddbe2c4e9a5fc"><div class="ttname"><a href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">arrow::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=nullptr)</div><div class="ttdoc">Create a Schema instance. </div></div> @@ -83,7 +83,7 @@ $(function() { <div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_stream_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></div><div class="ttdoc">Synchronous batch stream writer that writes the Arrow streaming format. </div><div class="ttdef"><b>Definition:</b> writer.h:83</div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_af3e2c42f9315d51ee531d46506790291"><div class="ttname"><a href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">arrow::ipc::GetRecordBatchSize</a></div><div class="ttdeci">Status GetRecordBatchSize(const RecordBatch &batch, int64_t *size)</div></div> <div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_file_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">arrow::ipc::RecordBatchFileWriter</a></div><div class="ttdoc">Creates the Arrow record batch file format. </div><div class="ttdef"><b>Definition:</b> writer.h:118</div></div> -<div class="ttc" id="classarrow_1_1_schema_html"><div class="ttname"><a href="classarrow_1_1_schema.html">arrow::Schema</a></div><div class="ttdoc">Sequence of arrow::Field objects describing the columns of a record batch or table data structure...</div><div class="ttdef"><b>Definition:</b> type.h:716</div></div> +<div class="ttc" id="classarrow_1_1_schema_html"><div class="ttname"><a href="classarrow_1_1_schema.html">arrow::Schema</a></div><div class="ttdoc">Sequence of arrow::Field objects describing the columns of a record batch or table data structure...</div><div class="ttdef"><b>Definition:</b> type.h:718</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> allocator.h:28</div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_a8358a45c7dd8605f8ad5af4cb3216602"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">arrow::ipc::GetTensorSize</a></div><div class="ttdeci">Status GetTensorSize(const Tensor &tensor, int64_t *size)</div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_aab7e08532aec7267dac70e923df75e52"><div class="ttname"><a href="namespacearrow_1_1ipc.html#aab7e08532aec7267dac70e923df75e52">arrow::ipc::WriteTensor</a></div><div class="ttdeci">Status WriteTensor(const Tensor &tensor, io::OutputStream *dst, int32_t *metadata_length, int64_t *body_length)</div><div class="ttdoc">EXPERIMENTAL: Write arrow::Tensor as a contiguous message <metadata size>=""><metadata><tensor data>=...</div></div>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/xxhash_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/xxhash_8h.html b/docs/cpp/xxhash_8h.html index 14f7b64..7019136 100644 --- a/docs/cpp/xxhash_8h.html +++ b/docs/cpp/xxhash_8h.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/plasma/thirdparty/xxhash.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/plasma/thirdparty/xxhash.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/xxhash_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/xxhash_8h_source.html b/docs/cpp/xxhash_8h_source.html index 8b7270c..3dff357 100644 --- a/docs/cpp/xxhash_8h_source.html +++ b/docs/cpp/xxhash_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/plasma/thirdparty/xxhash.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/plasma/thirdparty/xxhash.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/zmalloc_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/zmalloc_8h.html b/docs/cpp/zmalloc_8h.html index df4a5d5..7194e12 100644 --- a/docs/cpp/zmalloc_8h.html +++ b/docs/cpp/zmalloc_8h.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/plasma/thirdparty/ae/zmalloc.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/plasma/thirdparty/ae/zmalloc.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/zmalloc_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/zmalloc_8h_source.html b/docs/cpp/zmalloc_8h_source.html index 75e1136..02640aa 100644 --- a/docs/cpp/zmalloc_8h_source.html +++ b/docs/cpp/zmalloc_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/plasma/thirdparty/ae/zmalloc.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/plasma/thirdparty/ae/zmalloc.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script>
