http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_readable_file.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_readable_file.html b/docs/cpp/classarrow_1_1io_1_1_readable_file.html index 53b960d..b076418 100644 --- a/docs/cpp/classarrow_1_1io_1_1_readable_file.html +++ b/docs/cpp/classarrow_1_1io_1_1_readable_file.html @@ -72,7 +72,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="file_8h_source.html">file.h</a>></code></p> +<p><code>#include <<a class="el" href="file_8h_source.html">arrow/io/file.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::io::ReadableFile:</div> <div class="dyncontent"> @@ -99,6 +99,12 @@ Public Member Functions</h2></td></tr> <tr class="separator:a97facce4830c0e69fb181dba7298622f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa04232524cdf6eff20321da6b812983e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_readable_file.html#aa04232524cdf6eff20321da6b812983e">Read</a> (int64_t nbytes, std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out) override</td></tr> <tr class="separator:aa04232524cdf6eff20321da6b812983e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a676384489b53732f27a439e2abcd61a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_readable_file.html#a676384489b53732f27a439e2abcd61a8">ReadAt</a> (int64_t position, int64_t nbytes, int64_t *bytes_read, uint8_t *out) override</td></tr> +<tr class="memdesc:a676384489b53732f27a439e2abcd61a8"><td class="mdescLeft"> </td><td class="mdescRight">Thread-safe implementation of ReadAt. <a href="#a676384489b53732f27a439e2abcd61a8">More...</a><br /></td></tr> +<tr class="separator:a676384489b53732f27a439e2abcd61a8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aee5401488de17cd60e8082fece38662e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_readable_file.html#aee5401488de17cd60e8082fece38662e">ReadAt</a> (int64_t position, int64_t nbytes, std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out) override</td></tr> +<tr class="memdesc:aee5401488de17cd60e8082fece38662e"><td class="mdescLeft"> </td><td class="mdescRight">Thread-safe implementation of ReadAt. <a href="#aee5401488de17cd60e8082fece38662e">More...</a><br /></td></tr> +<tr class="separator:aee5401488de17cd60e8082fece38662e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a22e771665cbe38953ca816f091c0d457"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_readable_file.html#a22e771665cbe38953ca816f091c0d457">GetSize</a> (int64_t *size) override</td></tr> <tr class="separator:a22e771665cbe38953ca816f091c0d457"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae69e98b1f39e03e6cb168527e00227cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_readable_file.html#ae69e98b1f39e03e6cb168527e00227cb">Seek</a> (int64_t position) override</td></tr> @@ -108,14 +114,9 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a7f10720e35c4dd6d3517b04319e2a8d1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_readable_file.html#a7f10720e35c4dd6d3517b04319e2a8d1">file_descriptor</a> () const</td></tr> <tr class="separator:a7f10720e35c4dd6d3517b04319e2a8d1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarrow_1_1io_1_1_random_access_file"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1io_1_1_random_access_file')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></td></tr> -<tr class="memitem:a00dbb151b3c3b63080cbce073dc277af inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_random_access_file.html#a00dbb151b3c3b63080cbce073dc277af">ReadAt</a> (int64_t position, int64_t nbytes, int64_t *bytes_read, uint8_t *out)</td></tr> -<tr class="memdesc:a00dbb151b3c3b63080cbce073dc277af inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="mdescLeft"> </td><td class="mdescRight">Read at position, provide default implementations using Read(...), but can be overridden. <a href="classarrow_1_1io_1_1_random_access_file.html#a00dbb151b3c3b63080cbce073dc277af">More...</a><br /></td></tr> -<tr class="separator:a00dbb151b3c3b63080cbce073dc277af inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af0601e7e1f154a615a80697f5bb3aa52 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_random_access_file.html#af0601e7e1f154a615a80697f5bb3aa52">ReadAt</a> (int64_t position, int64_t nbytes, std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out)</td></tr> -<tr class="memdesc:af0601e7e1f154a615a80697f5bb3aa52 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="mdescLeft"> </td><td class="mdescRight">Default implementation is thread-safe. <a href="classarrow_1_1io_1_1_random_access_file.html#af0601e7e1f154a615a80697f5bb3aa52">More...</a><br /></td></tr> -<tr class="separator:af0601e7e1f154a615a80697f5bb3aa52 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2c52831f6121cc1a751f1573e58c6bf9 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memItemLeft" align="right" valign="top">std::mutex & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_random_access_file.html#a2c52831f6121cc1a751f1573e58c6bf9">lock</a> ()</td></tr> -<tr class="separator:a2c52831f6121cc1a751f1573e58c6bf9 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a30c6917dfe0b6e508dac2ecc81917187 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_random_access_file.html#a30c6917dfe0b6e508dac2ecc81917187">~RandomAccessFile</a> () override</td></tr> +<tr class="memdesc:a30c6917dfe0b6e508dac2ecc81917187 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="mdescLeft"> </td><td class="mdescRight">Necessary because we hold a std::unique_ptr. <a href="classarrow_1_1io_1_1_random_access_file.html#a30c6917dfe0b6e508dac2ecc81917187">More...</a><br /></td></tr> +<tr class="separator:a30c6917dfe0b6e508dac2ecc81917187 inherit pub_methods_classarrow_1_1io_1_1_random_access_file"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarrow_1_1io_1_1_file_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1io_1_1_file_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td></tr> <tr class="memitem:aa42dcdfad00634f01192b39f1d9b4929 inherit pub_methods_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#aa42dcdfad00634f01192b39f1d9b4929">~FileInterface</a> ()=0</td></tr> <tr class="separator:aa42dcdfad00634f01192b39f1d9b4929 inherit pub_methods_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> @@ -143,16 +144,13 @@ Additional Inherited Members</h2></td></tr> <tr class="memitem:a32c1cb28aa86db601b68a96615a3161c inherit pro_methods_classarrow_1_1io_1_1_random_access_file"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_random_access_file.html#a32c1cb28aa86db601b68a96615a3161c">RandomAccessFile</a> ()</td></tr> <tr class="separator:a32c1cb28aa86db601b68a96615a3161c inherit pro_methods_classarrow_1_1io_1_1_random_access_file"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_input_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_input_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_input_stream.html">arrow::io::InputStream</a></td></tr> -<tr class="memitem:aa7d3c448d324b0975577776d833133a4 inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_input_stream.html#aa7d3c448d324b0975577776d833133a4">InputStream</a> ()</td></tr> -<tr class="separator:aa7d3c448d324b0975577776d833133a4 inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeb778572d0e9bf4902dbfbbc5353d7fd inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_input_stream.html#aeb778572d0e9bf4902dbfbbc5353d7fd">InputStream</a> ()=default</td></tr> +<tr class="separator:aeb778572d0e9bf4902dbfbbc5353d7fd inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_file_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_file_interface')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td></tr> <tr class="memitem:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#afea9126bb21e3720212a826aa78b5534">FileInterface</a> ()</td></tr> <tr class="separator:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af3dd01a780076e39a34770beb513f71f inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#af3dd01a780076e39a34770beb513f71f">set_mode</a> (<a class="el" href="structarrow_1_1io_1_1_file_mode.html#a41b6fb9caec96f1e634fb8052c9a9310">FileMode::type</a> <a class="el" href="classarrow_1_1io_1_1_file_interface.html#a75a3739361570bb121b9adb04d5d8686">mode</a>)</td></tr> <tr class="separator:af3dd01a780076e39a34770beb513f71f inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="inherit_header pro_attribs_classarrow_1_1io_1_1_random_access_file"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classarrow_1_1io_1_1_random_access_file')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></td></tr> -<tr class="memitem:a69bbf2b55f82c780ab8f75559ac57fed inherit pro_attribs_classarrow_1_1io_1_1_random_access_file"><td class="memItemLeft" align="right" valign="top">std::mutex </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_random_access_file.html#a69bbf2b55f82c780ab8f75559ac57fed">lock_</a></td></tr> -<tr class="separator:a69bbf2b55f82c780ab8f75559ac57fed inherit pro_attribs_classarrow_1_1io_1_1_random_access_file"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_attribs_classarrow_1_1io_1_1_file_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classarrow_1_1io_1_1_file_interface')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td></tr> <tr class="memitem:a504d0410eb6066316365a4549d000ee0 inherit pro_attribs_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1io_1_1_file_mode.html#a41b6fb9caec96f1e634fb8052c9a9310">FileMode::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a504d0410eb6066316365a4549d000ee0">mode_</a></td></tr> <tr class="separator:a504d0410eb6066316365a4549d000ee0 inherit pro_attribs_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> @@ -427,6 +425,104 @@ Additional Inherited Members</h2></td></tr> </div> </div> +<a id="a676384489b53732f27a439e2abcd61a8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a676384489b53732f27a439e2abcd61a8">◆ </a></span>ReadAt() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::io::ReadableFile::ReadAt </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>position</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>nbytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t * </td> + <td class="paramname"><em>bytes_read</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint8_t * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Thread-safe implementation of ReadAt. </p> + +<p>Implements <a class="el" href="classarrow_1_1io_1_1_random_access_file.html#a287cb25eadcb1708b020d36bfc65c38b">arrow::io::RandomAccessFile</a>.</p> + +</div> +</div> +<a id="aee5401488de17cd60e8082fece38662e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aee5401488de17cd60e8082fece38662e">◆ </a></span>ReadAt() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::io::ReadableFile::ReadAt </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>position</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>nbytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Thread-safe implementation of ReadAt. </p> + +<p>Implements <a class="el" href="classarrow_1_1io_1_1_random_access_file.html#ab31b267019a84af465ef91aaafd3a72e">arrow::io::RandomAccessFile</a>.</p> + +</div> +</div> <a id="ae69e98b1f39e03e6cb168527e00227cb"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae69e98b1f39e03e6cb168527e00227cb">◆ </a></span>Seek()</h2>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_seekable.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_seekable.html b/docs/cpp/classarrow_1_1io_1_1_seekable.html index 04f093f..d78e834 100644 --- a/docs/cpp/classarrow_1_1io_1_1_seekable.html +++ b/docs/cpp/classarrow_1_1io_1_1_seekable.html @@ -71,27 +71,23 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="interfaces_8h_source.html">interfaces.h</a>></code></p> +<p><code>#include <<a class="el" href="interfaces_8h_source.html">arrow/io/interfaces.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::io::Seekable:</div> <div class="dyncontent"> <div class="center"> <img src="classarrow_1_1io_1_1_seekable.png" usemap="#arrow::io::Seekable_map" alt=""/> <map id="arrow::io::Seekable_map" name="arrow::io::Seekable_map"> -<area href="classarrow_1_1io_1_1_random_access_file.html" alt="arrow::io::RandomAccessFile" shape="rect" coords="515,56,711,80"/> -<area href="classarrow_1_1io_1_1_writeable_file.html" alt="arrow::io::WriteableFile" shape="rect" coords="1236,56,1432,80"/> -<area href="classarrow_1_1io_1_1_buffer_reader.html" title="Random access zero-copy reads on an arrow::Buffer. " alt="arrow::io::BufferReader" shape="rect" coords="103,112,299,136"/> -<area href="classarrow_1_1io_1_1_hdfs_readable_file.html" alt="arrow::io::HdfsReadableFile" shape="rect" coords="309,112,505,136"/> -<area href="classarrow_1_1io_1_1_readable_file.html" alt="arrow::io::ReadableFile" shape="rect" coords="515,112,711,136"/> -<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="721,112,917,136"/> -<area href="classarrow_1_1py_1_1_py_readable_file.html" alt="arrow::py::PyReadableFile" shape="rect" coords="927,112,1123,136"/> -<area href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html" title="Enables random writes into a fixed-size mutable buffer. " alt="arrow::io::FixedSizeBufferWriter" shape="rect" coords="1133,112,1329,136"/> -<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="1339,112,1535,136"/> -<area href="classarrow_1_1gpu_1_1_cuda_buffer_reader.html" title="File interface for zero-copy read from CUDA buffers. " alt="arrow::gpu::CudaBufferReader" shape="rect" coords="0,168,196,192"/> -<area href="classarrow_1_1py_1_1_py_bytes_reader.html" alt="arrow::py::PyBytesReader" shape="rect" coords="206,168,402,192"/> -<area href="classarrow_1_1io_1_1_memory_mapped_file.html" alt="arrow::io::MemoryMappedFile" shape="rect" coords="721,168,917,192"/> -<area href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html" title="File interface for writing to CUDA buffers, with optional buffering. " alt="arrow::gpu::CudaBufferWriter" shape="rect" coords="1133,168,1329,192"/> -<area href="classarrow_1_1io_1_1_memory_mapped_file.html" alt="arrow::io::MemoryMappedFile" shape="rect" coords="1339,168,1535,192"/> +<area href="classarrow_1_1io_1_1_random_access_file.html" alt="arrow::io::RandomAccessFile" shape="rect" coords="0,56,196,80"/> +<area href="classarrow_1_1io_1_1_writeable_file.html" alt="arrow::io::WriteableFile" shape="rect" coords="412,56,608,80"/> +<area href="classarrow_1_1io_1_1_buffer_reader.html" title="Random access zero-copy reads on an arrow::Buffer. " alt="arrow::io::BufferReader" shape="rect" coords="206,112,402,136"/> +<area href="classarrow_1_1io_1_1_hdfs_readable_file.html" alt="arrow::io::HdfsReadableFile" shape="rect" coords="206,168,402,192"/> +<area href="classarrow_1_1io_1_1_readable_file.html" alt="arrow::io::ReadableFile" shape="rect" coords="206,224,402,248"/> +<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="206,280,402,304"/> +<area href="classarrow_1_1py_1_1_py_readable_file.html" alt="arrow::py::PyReadableFile" shape="rect" coords="206,336,402,360"/> +<area href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html" title="File interface for writing to CUDA buffers, with optional buffering. " alt="arrow::gpu::CudaBufferWriter" shape="rect" coords="618,112,814,136"/> +<area href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html" title="Enables random writes into a fixed-size mutable buffer. " alt="arrow::io::FixedSizeBufferWriter" shape="rect" coords="618,168,814,192"/> +<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="618,224,814,248"/> </map> </div></div> <table class="memberdecls"> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_seekable.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_seekable.png b/docs/cpp/classarrow_1_1io_1_1_seekable.png index 88952d8..5c92fcf 100644 Binary files a/docs/cpp/classarrow_1_1io_1_1_seekable.png and b/docs/cpp/classarrow_1_1io_1_1_seekable.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_stdin_stream-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_stdin_stream-members.html b/docs/cpp/classarrow_1_1io_1_1_stdin_stream-members.html index 271d663..b1f3aae 100644 --- a/docs/cpp/classarrow_1_1io_1_1_stdin_stream-members.html +++ b/docs/cpp/classarrow_1_1io_1_1_stdin_stream-members.html @@ -72,7 +72,7 @@ $(function() { <table class="directory"> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdin_stream.html#a98c95b8908eab01a28881d9bfd28ee87">Close</a>() override</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdin_stream.html">arrow::io::StdinStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#afea9126bb21e3720212a826aa78b5534">FileInterface</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_input_stream.html#aa7d3c448d324b0975577776d833133a4">InputStream</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_input_stream.html">arrow::io::InputStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_input_stream.html#aeb778572d0e9bf4902dbfbbc5353d7fd">InputStream</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_input_stream.html">arrow::io::InputStream</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a75a3739361570bb121b9adb04d5d8686">mode</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a504d0410eb6066316365a4549d000ee0">mode_</a></td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdin_stream.html#a336e54c848f4f6154c6b993c12ac3b2b">Read</a>(int64_t nbytes, int64_t *bytes_read, uint8_t *out) override</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdin_stream.html">arrow::io::StdinStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_stdin_stream.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_stdin_stream.html b/docs/cpp/classarrow_1_1io_1_1_stdin_stream.html index 961c2bd..1a7fee8 100644 --- a/docs/cpp/classarrow_1_1io_1_1_stdin_stream.html +++ b/docs/cpp/classarrow_1_1io_1_1_stdin_stream.html @@ -71,7 +71,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="io-util_8h_source.html">io-util.h</a>></code></p> +<p><code>#include <<a class="el" href="io-util_8h_source.html">arrow/util/io-util.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::io::StdinStream:</div> <div class="dyncontent"> @@ -110,8 +110,8 @@ Public Member Functions</h2></td></tr> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_input_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_input_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_input_stream.html">arrow::io::InputStream</a></td></tr> -<tr class="memitem:aa7d3c448d324b0975577776d833133a4 inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_input_stream.html#aa7d3c448d324b0975577776d833133a4">InputStream</a> ()</td></tr> -<tr class="separator:aa7d3c448d324b0975577776d833133a4 inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeb778572d0e9bf4902dbfbbc5353d7fd inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_input_stream.html#aeb778572d0e9bf4902dbfbbc5353d7fd">InputStream</a> ()=default</td></tr> +<tr class="separator:aeb778572d0e9bf4902dbfbbc5353d7fd inherit pro_methods_classarrow_1_1io_1_1_input_stream"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_file_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_file_interface')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td></tr> <tr class="memitem:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#afea9126bb21e3720212a826aa78b5534">FileInterface</a> ()</td></tr> <tr class="separator:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_stdout_stream-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_stdout_stream-members.html b/docs/cpp/classarrow_1_1io_1_1_stdout_stream-members.html index 24c93fa..89cb8bb 100644 --- a/docs/cpp/classarrow_1_1io_1_1_stdout_stream-members.html +++ b/docs/cpp/classarrow_1_1io_1_1_stdout_stream-members.html @@ -75,7 +75,7 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html#a1e88868d908a490eabd1dd29e99bfc99">Flush</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html">arrow::io::Writeable</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a75a3739361570bb121b9adb04d5d8686">mode</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a504d0410eb6066316365a4549d000ee0">mode_</a></td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a75ceada7c785d78fbb2a81d2ce6b6e93">OutputStream</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a5b1e0adea7ef92368ddc07027995aca1">OutputStream</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#af3dd01a780076e39a34770beb513f71f">set_mode</a>(FileMode::type mode)</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdout_stream.html#add5fc3e46136cb12fcf8949d22921981">StdoutStream</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdout_stream.html">arrow::io::StdoutStream</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdout_stream.html#ac6c17ba8bfef28c14b29f8321cc72939">Tell</a>(int64_t *position) const override</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_stdout_stream.html">arrow::io::StdoutStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_stdout_stream.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_stdout_stream.html b/docs/cpp/classarrow_1_1io_1_1_stdout_stream.html index c070be3..d258e10 100644 --- a/docs/cpp/classarrow_1_1io_1_1_stdout_stream.html +++ b/docs/cpp/classarrow_1_1io_1_1_stdout_stream.html @@ -71,7 +71,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="io-util_8h_source.html">io-util.h</a>></code></p> +<p><code>#include <<a class="el" href="io-util_8h_source.html">arrow/util/io-util.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::io::StdoutStream:</div> <div class="dyncontent"> @@ -113,8 +113,8 @@ Public Member Functions</h2></td></tr> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_output_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_output_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></td></tr> -<tr class="memitem:a75ceada7c785d78fbb2a81d2ce6b6e93 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a75ceada7c785d78fbb2a81d2ce6b6e93">OutputStream</a> ()</td></tr> -<tr class="separator:a75ceada7c785d78fbb2a81d2ce6b6e93 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5b1e0adea7ef92368ddc07027995aca1 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a5b1e0adea7ef92368ddc07027995aca1">OutputStream</a> ()=default</td></tr> +<tr class="separator:a5b1e0adea7ef92368ddc07027995aca1 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_file_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_file_interface')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td></tr> <tr class="memitem:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#afea9126bb21e3720212a826aa78b5534">FileInterface</a> ()</td></tr> <tr class="separator:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_writeable.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_writeable.html b/docs/cpp/classarrow_1_1io_1_1_writeable.html index dc96dbd..e7387ad 100644 --- a/docs/cpp/classarrow_1_1io_1_1_writeable.html +++ b/docs/cpp/classarrow_1_1io_1_1_writeable.html @@ -71,7 +71,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="interfaces_8h_source.html">interfaces.h</a>></code></p> +<p><code>#include <<a class="el" href="interfaces_8h_source.html">arrow/io/interfaces.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::io::Writeable:</div> <div class="dyncontent"> @@ -86,10 +86,10 @@ Inheritance diagram for arrow::io::Writeable:</div> <area href="classarrow_1_1io_1_1_stdout_stream.html" alt="arrow::io::StdoutStream" shape="rect" coords="824,112,1020,136"/> <area href="classarrow_1_1io_1_1_writeable_file.html" alt="arrow::io::WriteableFile" shape="rect" coords="1030,112,1226,136"/> <area href="classarrow_1_1py_1_1_py_output_stream.html" alt="arrow::py::PyOutputStream" shape="rect" coords="1236,112,1432,136"/> -<area href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html" title="Enables random writes into a fixed-size mutable buffer. " alt="arrow::io::FixedSizeBufferWriter" shape="rect" coords="927,168,1123,192"/> -<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="1133,168,1329,192"/> -<area href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html" title="File interface for writing to CUDA buffers, with optional buffering. " alt="arrow::gpu::CudaBufferWriter" shape="rect" coords="927,224,1123,248"/> -<area href="classarrow_1_1io_1_1_memory_mapped_file.html" alt="arrow::io::MemoryMappedFile" shape="rect" coords="1133,224,1329,248"/> +<area href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html" title="File interface for writing to CUDA buffers, with optional buffering. " alt="arrow::gpu::CudaBufferWriter" shape="rect" coords="824,168,1020,192"/> +<area href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html" title="Enables random writes into a fixed-size mutable buffer. " alt="arrow::io::FixedSizeBufferWriter" shape="rect" coords="1030,168,1226,192"/> +<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="1236,168,1432,192"/> +<area href="classarrow_1_1io_1_1_memory_mapped_file.html" alt="arrow::io::MemoryMappedFile" shape="rect" coords="1236,224,1432,248"/> </map> </div></div> <table class="memberdecls"> @@ -195,7 +195,7 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Implemented in <a class="el" href="classarrow_1_1io_1_1_hdfs_output_stream.html#a5abe030f122e99a30ec334be9f4dd5cc">arrow::io::HdfsOutputStream</a>, <a class="el" href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html#a3372e3089ed496b454573b783ab43c82">arrow::gpu::CudaBufferWriter</a>, <a class="el" href="classarrow_1_1io_1_1_memory_mapped_file.html#a802242dc9f111f5f514f25b5795368c4">arrow::io::MemoryMappedFile</a>, <a class="el" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a111724a73af1ee5baa58f722e8555d35">arrow::io::FixedSizeBufferWriter</a>, <a class="el" href="classarrow_1_1py_1_1_py_output_stream.html#ae017972bbd8b7e8833e2a0dfe429e5fd">arrow::py::PyOutputStream</a>, <a class="el" href="classarrow_1_1io_1_1_mock_output_stream.html#a5135d2c0e6452faad33907027cb25939">arrow::io::MockOutputStream</a>, <a class="el" href="classarrow_1_1io_1_1_file_output_stream.html#a5c8e0547caa65535457e1a204fa4186b">arrow::io::FileOutputStream</a>, <a class="el" href="classarrow_1_1io_1_ 1_buffer_output_stream.html#ad55d013471db94fd4acb18c7936165fa">arrow::io::BufferOutputStream</a>, and <a class="el" href="classarrow_1_1io_1_1_stdout_stream.html#acf8fde9b89a4af6d24a7fda92bdfddb8">arrow::io::StdoutStream</a>.</p> +<p>Implemented in <a class="el" href="classarrow_1_1io_1_1_hdfs_output_stream.html#a5abe030f122e99a30ec334be9f4dd5cc">arrow::io::HdfsOutputStream</a>, <a class="el" href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html#a3372e3089ed496b454573b783ab43c82">arrow::gpu::CudaBufferWriter</a>, <a class="el" href="classarrow_1_1io_1_1_memory_mapped_file.html#a802242dc9f111f5f514f25b5795368c4">arrow::io::MemoryMappedFile</a>, <a class="el" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a111724a73af1ee5baa58f722e8555d35">arrow::io::FixedSizeBufferWriter</a>, <a class="el" href="classarrow_1_1io_1_1_mock_output_stream.html#a5135d2c0e6452faad33907027cb25939">arrow::io::MockOutputStream</a>, <a class="el" href="classarrow_1_1py_1_1_py_output_stream.html#ae017972bbd8b7e8833e2a0dfe429e5fd">arrow::py::PyOutputStream</a>, <a class="el" href="classarrow_1_1io_1_1_file_output_stream.html#a5c8e0547caa65535457e1a204fa4186b">arrow::io::FileOutputStream</a>, <a class="el" href="classarrow_1_1io_1_ 1_buffer_output_stream.html#ad55d013471db94fd4acb18c7936165fa">arrow::io::BufferOutputStream</a>, and <a class="el" href="classarrow_1_1io_1_1_stdout_stream.html#acf8fde9b89a4af6d24a7fda92bdfddb8">arrow::io::StdoutStream</a>.</p> </div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_writeable.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_writeable.png b/docs/cpp/classarrow_1_1io_1_1_writeable.png index bb835e4..6b9ae80 100644 Binary files a/docs/cpp/classarrow_1_1io_1_1_writeable.png and b/docs/cpp/classarrow_1_1io_1_1_writeable.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_writeable_file-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_writeable_file-members.html b/docs/cpp/classarrow_1_1io_1_1_writeable_file-members.html index 36b8a8d..1c875cd 100644 --- a/docs/cpp/classarrow_1_1io_1_1_writeable_file-members.html +++ b/docs/cpp/classarrow_1_1io_1_1_writeable_file-members.html @@ -75,13 +75,13 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html#a1e88868d908a490eabd1dd29e99bfc99">Flush</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html">arrow::io::Writeable</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a75a3739361570bb121b9adb04d5d8686">mode</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a504d0410eb6066316365a4549d000ee0">mode_</a></td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a75ceada7c785d78fbb2a81d2ce6b6e93">OutputStream</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a5b1e0adea7ef92368ddc07027995aca1">OutputStream</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_seekable.html#a410ba0e0932dbcb939b570ee3c8c6d25">Seek</a>(int64_t position)=0</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_seekable.html">arrow::io::Seekable</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#af3dd01a780076e39a34770beb513f71f">set_mode</a>(FileMode::type mode)</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#a7adb21f4512ff36c420648f9b9d4f652">Tell</a>(int64_t *position) const =0</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html#affb65b3befef7ff413f52fa30f0434ec">Write</a>(const uint8_t *data, int64_t nbytes)=0</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html">arrow::io::Writeable</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html#a2448c22a077c56826284ee34e2b3087f">Write</a>(const std::string &data)</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable.html">arrow::io::Writeable</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html#a650f2ad9683cdbcc49ffeb2e75b7a082">WriteableFile</a>()</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html">arrow::io::WriteableFile</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html#a0e73c948283c76d1802b14dfadc986a5">WriteableFile</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html">arrow::io::WriteableFile</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html#a0eff169b078f5971b012f4a04225dce5">WriteAt</a>(int64_t position, const uint8_t *data, int64_t nbytes)=0</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html">arrow::io::WriteableFile</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#aa42dcdfad00634f01192b39f1d9b4929">~FileInterface</a>()=0</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1io_1_1_seekable.html#a7642c30d2f852e0f79fec036a94ca093">~Seekable</a>()=default</td><td class="entry"><a class="el" href="classarrow_1_1io_1_1_seekable.html">arrow::io::Seekable</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_writeable_file.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_writeable_file.html b/docs/cpp/classarrow_1_1io_1_1_writeable_file.html index e35fceb..b3d94c9 100644 --- a/docs/cpp/classarrow_1_1io_1_1_writeable_file.html +++ b/docs/cpp/classarrow_1_1io_1_1_writeable_file.html @@ -72,7 +72,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="interfaces_8h_source.html">interfaces.h</a>></code></p> +<p><code>#include <<a class="el" href="interfaces_8h_source.html">arrow/io/interfaces.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::io::WriteableFile:</div> <div class="dyncontent"> @@ -83,10 +83,10 @@ Inheritance diagram for arrow::io::WriteableFile:</div> <area href="classarrow_1_1io_1_1_seekable.html" alt="arrow::io::Seekable" shape="rect" coords="309,56,505,80"/> <area href="classarrow_1_1io_1_1_file_interface.html" alt="arrow::io::FileInterface" shape="rect" coords="0,0,196,24"/> <area href="classarrow_1_1io_1_1_writeable.html" alt="arrow::io::Writeable" shape="rect" coords="206,0,402,24"/> -<area href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html" title="Enables random writes into a fixed-size mutable buffer. " alt="arrow::io::FixedSizeBufferWriter" shape="rect" coords="103,168,299,192"/> -<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="309,168,505,192"/> -<area href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html" title="File interface for writing to CUDA buffers, with optional buffering. " alt="arrow::gpu::CudaBufferWriter" shape="rect" coords="103,224,299,248"/> -<area href="classarrow_1_1io_1_1_memory_mapped_file.html" alt="arrow::io::MemoryMappedFile" shape="rect" coords="309,224,505,248"/> +<area href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html" title="File interface for writing to CUDA buffers, with optional buffering. " alt="arrow::gpu::CudaBufferWriter" shape="rect" coords="0,168,196,192"/> +<area href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html" title="Enables random writes into a fixed-size mutable buffer. " alt="arrow::io::FixedSizeBufferWriter" shape="rect" coords="206,168,402,192"/> +<area href="classarrow_1_1io_1_1_read_write_file_interface.html" alt="arrow::io::ReadWriteFileInterface" shape="rect" coords="412,168,608,192"/> +<area href="classarrow_1_1io_1_1_memory_mapped_file.html" alt="arrow::io::MemoryMappedFile" shape="rect" coords="412,224,608,248"/> </map> </div></div> <table class="memberdecls"> @@ -121,11 +121,11 @@ Public Member Functions</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> -<tr class="memitem:a650f2ad9683cdbcc49ffeb2e75b7a082"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html#a650f2ad9683cdbcc49ffeb2e75b7a082">WriteableFile</a> ()</td></tr> -<tr class="separator:a650f2ad9683cdbcc49ffeb2e75b7a082"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e73c948283c76d1802b14dfadc986a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_writeable_file.html#a0e73c948283c76d1802b14dfadc986a5">WriteableFile</a> ()=default</td></tr> +<tr class="separator:a0e73c948283c76d1802b14dfadc986a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_output_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_output_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></td></tr> -<tr class="memitem:a75ceada7c785d78fbb2a81d2ce6b6e93 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a75ceada7c785d78fbb2a81d2ce6b6e93">OutputStream</a> ()</td></tr> -<tr class="separator:a75ceada7c785d78fbb2a81d2ce6b6e93 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5b1e0adea7ef92368ddc07027995aca1 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_output_stream.html#a5b1e0adea7ef92368ddc07027995aca1">OutputStream</a> ()=default</td></tr> +<tr class="separator:a5b1e0adea7ef92368ddc07027995aca1 inherit pro_methods_classarrow_1_1io_1_1_output_stream"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_classarrow_1_1io_1_1_file_interface"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarrow_1_1io_1_1_file_interface')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarrow_1_1io_1_1_file_interface.html">arrow::io::FileInterface</a></td></tr> <tr class="memitem:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1io_1_1_file_interface.html#afea9126bb21e3720212a826aa78b5534">FileInterface</a> ()</td></tr> <tr class="separator:afea9126bb21e3720212a826aa78b5534 inherit pro_methods_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> @@ -139,8 +139,8 @@ Additional Inherited Members</h2></td></tr> <tr class="separator:a504d0410eb6066316365a4549d000ee0 inherit pro_attribs_classarrow_1_1io_1_1_file_interface"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a id="a650f2ad9683cdbcc49ffeb2e75b7a082"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a650f2ad9683cdbcc49ffeb2e75b7a082">◆ </a></span>WriteableFile()</h2> +<a id="a0e73c948283c76d1802b14dfadc986a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0e73c948283c76d1802b14dfadc986a5">◆ </a></span>WriteableFile()</h2> <div class="memitem"> <div class="memproto"> @@ -157,7 +157,7 @@ Additional Inherited Members</h2></td></tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> +<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td> </tr> </table> </div><div class="memdoc"> @@ -205,7 +205,7 @@ Additional Inherited Members</h2></td></tr> </table> </div><div class="memdoc"> -<p>Implemented in <a class="el" href="classarrow_1_1io_1_1_memory_mapped_file.html#a0466202ed13ca71c111fef920bf0309f">arrow::io::MemoryMappedFile</a>, and <a class="el" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a5075a02f5ab158f7a556d135d7f8c8bd">arrow::io::FixedSizeBufferWriter</a>.</p> +<p>Implemented in <a class="el" href="classarrow_1_1gpu_1_1_cuda_buffer_writer.html#a4c4fd4a537283c9e95d4c79a8de44eb2">arrow::gpu::CudaBufferWriter</a>, <a class="el" href="classarrow_1_1io_1_1_memory_mapped_file.html#a0466202ed13ca71c111fef920bf0309f">arrow::io::MemoryMappedFile</a>, and <a class="el" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a5075a02f5ab158f7a556d135d7f8c8bd">arrow::io::FixedSizeBufferWriter</a>.</p> </div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1io_1_1_writeable_file.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1io_1_1_writeable_file.png b/docs/cpp/classarrow_1_1io_1_1_writeable_file.png index 99408ec..5ea7ba3 100644 Binary files a/docs/cpp/classarrow_1_1io_1_1_writeable_file.png and b/docs/cpp/classarrow_1_1io_1_1_writeable_file.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_dictionary_memo.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1ipc_1_1_dictionary_memo.html b/docs/cpp/classarrow_1_1ipc_1_1_dictionary_memo.html index 962a64b..4f9a453 100644 --- a/docs/cpp/classarrow_1_1ipc_1_1_dictionary_memo.html +++ b/docs/cpp/classarrow_1_1ipc_1_1_dictionary_memo.html @@ -71,29 +71,39 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="dictionary_8h_source.html">dictionary.h</a>></code></p> +<p>Memoization data structure for handling shared dictionaries. + <a href="classarrow_1_1ipc_1_1_dictionary_memo.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="dictionary_8h_source.html">arrow/ipc/dictionary.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a34df1f797134f38e133d339149063660"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#a34df1f797134f38e133d339149063660">DictionaryMemo</a> ()</td></tr> <tr class="separator:a34df1f797134f38e133d339149063660"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afd23dd4f43af7950aa0f2ad7a200282c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#afd23dd4f43af7950aa0f2ad7a200282c">GetDictionary</a> (int64_t id, std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > *<a class="el" href="namespacearrow.html#a60af355046f03b01c4fcbc6fcaed4ea1">dictionary</a>) const</td></tr> +<tr class="memdesc:afd23dd4f43af7950aa0f2ad7a200282c"><td class="mdescLeft"> </td><td class="mdescRight">Returns KeyError if dictionary not found. <a href="#afd23dd4f43af7950aa0f2ad7a200282c">More...</a><br /></td></tr> <tr class="separator:afd23dd4f43af7950aa0f2ad7a200282c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80e6dfe4542127d9e99cfe3cb1dd9184"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#a80e6dfe4542127d9e99cfe3cb1dd9184">GetId</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &<a class="el" href="namespacearrow.html#a60af355046f03b01c4fcbc6fcaed4ea1">dictionary</a>)</td></tr> <tr class="memdesc:a80e6dfe4542127d9e99cfe3cb1dd9184"><td class="mdescLeft"> </td><td class="mdescRight">Return id for dictionary, computing new id if necessary. <a href="#a80e6dfe4542127d9e99cfe3cb1dd9184">More...</a><br /></td></tr> <tr class="separator:a80e6dfe4542127d9e99cfe3cb1dd9184"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abfbb76f816b51b76e70af5859c1b0678"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#abfbb76f816b51b76e70af5859c1b0678">HasDictionary</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &<a class="el" href="namespacearrow.html#a60af355046f03b01c4fcbc6fcaed4ea1">dictionary</a>) const</td></tr> +<tr class="memdesc:abfbb76f816b51b76e70af5859c1b0678"><td class="mdescLeft"> </td><td class="mdescRight">Return true if dictionary array object is in this memo. <a href="#abfbb76f816b51b76e70af5859c1b0678">More...</a><br /></td></tr> <tr class="separator:abfbb76f816b51b76e70af5859c1b0678"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e6c29e40aaf94885a05aee6c8282e5d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#a9e6c29e40aaf94885a05aee6c8282e5d">HasDictionaryId</a> (int64_t id) const</td></tr> +<tr class="memdesc:a9e6c29e40aaf94885a05aee6c8282e5d"><td class="mdescLeft"> </td><td class="mdescRight">Return true if we have a dictionary for the input id. <a href="#a9e6c29e40aaf94885a05aee6c8282e5d">More...</a><br /></td></tr> <tr class="separator:a9e6c29e40aaf94885a05aee6c8282e5d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7084b7d6b3a6044a2596baf7649caf58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#a7084b7d6b3a6044a2596baf7649caf58">AddDictionary</a> (int64_t id, const std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> > &<a class="el" href="namespacearrow.html#a60af355046f03b01c4fcbc6fcaed4ea1">dictionary</a>)</td></tr> +<tr class="memdesc:a7084b7d6b3a6044a2596baf7649caf58"><td class="mdescLeft"> </td><td class="mdescRight">Add a dictionary to the memo with a particular id. <a href="#a7084b7d6b3a6044a2596baf7649caf58">More...</a><br /></td></tr> <tr class="separator:a7084b7d6b3a6044a2596baf7649caf58"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a35fa7e8c3cac8ac1047413241d229fad"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacearrow_1_1ipc.html#ac4462a1d18d35a0a17f3f6333d83cb3f">DictionaryMap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#a35fa7e8c3cac8ac1047413241d229fad">id_to_dictionary</a> () const</td></tr> <tr class="separator:a35fa7e8c3cac8ac1047413241d229fad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e1330ef1334ce32fa3e54fe7936ba72"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_dictionary_memo.html#a5e1330ef1334ce32fa3e54fe7936ba72">size</a> () const</td></tr> +<tr class="memdesc:a5e1330ef1334ce32fa3e54fe7936ba72"><td class="mdescLeft"> </td><td class="mdescRight">The number of dictionaries stored in the memo. <a href="#a5e1330ef1334ce32fa3e54fe7936ba72">More...</a><br /></td></tr> <tr class="separator:a5e1330ef1334ce32fa3e54fe7936ba72"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Memoization data structure for handling shared dictionaries. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a34df1f797134f38e133d339149063660"></a> <h2 class="memtitle"><span class="permalink"><a href="#a34df1f797134f38e133d339149063660">◆ </a></span>DictionaryMemo()</h2> @@ -138,6 +148,9 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Add a dictionary to the memo with a particular id. </p> +<p>Returns KeyError if that dictionary already exists </p> + </div> </div> <a id="afd23dd4f43af7950aa0f2ad7a200282c"></a> @@ -166,6 +179,8 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Returns KeyError if dictionary not found. </p> + </div> </div> <a id="a80e6dfe4542127d9e99cfe3cb1dd9184"></a> @@ -204,6 +219,8 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Return true if dictionary array object is in this memo. </p> + </div> </div> <a id="a9e6c29e40aaf94885a05aee6c8282e5d"></a> @@ -222,6 +239,8 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Return true if we have a dictionary for the input id. </p> + </div> </div> <a id="a35fa7e8c3cac8ac1047413241d229fad"></a> @@ -272,6 +291,8 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>The number of dictionaries stored in the memo. </p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_input_stream_message_reader.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1ipc_1_1_input_stream_message_reader.html b/docs/cpp/classarrow_1_1ipc_1_1_input_stream_message_reader.html index 35b3f0e..844903c 100644 --- a/docs/cpp/classarrow_1_1ipc_1_1_input_stream_message_reader.html +++ b/docs/cpp/classarrow_1_1ipc_1_1_input_stream_message_reader.html @@ -74,7 +74,7 @@ $(function() { <p>Implementation of <a class="el" href="classarrow_1_1ipc_1_1_message_reader.html" title="Abstract interface for a sequence of messages. ">MessageReader</a> that reads from InputStream. <a href="classarrow_1_1ipc_1_1_input_stream_message_reader.html#details">More...</a></p> -<p><code>#include <<a class="el" href="message_8h_source.html">message.h</a>></code></p> +<p><code>#include <<a class="el" href="message_8h_source.html">arrow/ipc/message.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::ipc::InputStreamMessageReader:</div> <div class="dyncontent"> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_json_reader.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1ipc_1_1_json_reader.html b/docs/cpp/classarrow_1_1ipc_1_1_json_reader.html index c32b5fa..4775baf 100644 --- a/docs/cpp/classarrow_1_1ipc_1_1_json_reader.html +++ b/docs/cpp/classarrow_1_1ipc_1_1_json_reader.html @@ -72,27 +72,38 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="json_8h_source.html">json.h</a>></code></p> +<p>Read the JSON representation of an Arrow record batch file or stream. + <a href="classarrow_1_1ipc_1_1_json_reader.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="json_8h_source.html">arrow/ipc/json.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ac24f90c6a4eb3a93285642e110ccb222"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_reader.html#ac24f90c6a4eb3a93285642e110ccb222">~JsonReader</a> ()</td></tr> <tr class="separator:ac24f90c6a4eb3a93285642e110ccb222"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ca066d8bec5b5b8bd6112f3c17dbafd"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_reader.html#a3ca066d8bec5b5b8bd6112f3c17dbafd">schema</a> () const</td></tr> +<tr class="memdesc:a3ca066d8bec5b5b8bd6112f3c17dbafd"><td class="mdescLeft"> </td><td class="mdescRight">Return the schema read from the JSON. <a href="#a3ca066d8bec5b5b8bd6112f3c17dbafd">More...</a><br /></td></tr> <tr class="separator:a3ca066d8bec5b5b8bd6112f3c17dbafd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac090e876c38e5ec7bed99f3c8aabb456"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_reader.html#ac090e876c38e5ec7bed99f3c8aabb456">num_record_batches</a> () const</td></tr> +<tr class="memdesc:ac090e876c38e5ec7bed99f3c8aabb456"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of record batches. <a href="#ac090e876c38e5ec7bed99f3c8aabb456">More...</a><br /></td></tr> <tr class="separator:ac090e876c38e5ec7bed99f3c8aabb456"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae862d62e1aef20d4f9c2c4e647440bc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_reader.html#ae862d62e1aef20d4f9c2c4e647440bc1">ReadRecordBatch</a> (int i, std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch) const</td></tr> +<tr class="memdesc:ae862d62e1aef20d4f9c2c4e647440bc1"><td class="mdescLeft"> </td><td class="mdescRight">Read a particular record batch from the file. <a href="#ae862d62e1aef20d4f9c2c4e647440bc1">More...</a><br /></td></tr> <tr class="separator:ae862d62e1aef20d4f9c2c4e647440bc1"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a7f504d9cf5be76c7407acb1219749e4c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_reader.html#a7f504d9cf5be76c7407acb1219749e4c">Open</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool, const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &data, std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_json_reader.html">JsonReader</a> > *reader)</td></tr> +<tr class="memdesc:a7f504d9cf5be76c7407acb1219749e4c"><td class="mdescLeft"> </td><td class="mdescRight">Create a new JSON reader. <a href="#a7f504d9cf5be76c7407acb1219749e4c">More...</a><br /></td></tr> <tr class="separator:a7f504d9cf5be76c7407acb1219749e4c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae3d651e403cfc6ec7f63257f59d99bb5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_reader.html#ae3d651e403cfc6ec7f63257f59d99bb5">Open</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &data, std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_json_reader.html">JsonReader</a> > *reader)</td></tr> +<tr class="memdesc:ae3d651e403cfc6ec7f63257f59d99bb5"><td class="mdescLeft"> </td><td class="mdescRight">Create a new JSON reader that uses the default memory pool. <a href="#ae3d651e403cfc6ec7f63257f59d99bb5">More...</a><br /></td></tr> <tr class="separator:ae3d651e403cfc6ec7f63257f59d99bb5"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Read the JSON representation of an Arrow record batch file or stream. </p> +<p>This is used for integration testing </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="ac24f90c6a4eb3a93285642e110ccb222"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac24f90c6a4eb3a93285642e110ccb222">◆ </a></span>~JsonReader()</h2> @@ -126,6 +137,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Return the number of record batches. </p> + </div> </div> <a id="a7f504d9cf5be76c7407acb1219749e4c"></a> @@ -168,6 +181,17 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Create a new JSON reader. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">pool</td><td>a <a class="el" href="classarrow_1_1_memory_pool.html" title="Base class for memory allocation. ">MemoryPool</a> to use for buffer allocations </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>a <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> containing the JSON data </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">reader</td><td>the returned reader object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + </div> </div> <a id="ae3d651e403cfc6ec7f63257f59d99bb5"></a> @@ -204,6 +228,16 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Create a new JSON reader that uses the default memory pool. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>a <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a> containing the JSON data </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">reader</td><td>the returned reader object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + </div> </div> <a id="ae862d62e1aef20d4f9c2c4e647440bc1"></a> @@ -232,6 +266,15 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Read a particular record batch from the file. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>the record batch index, does not boundscheck </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">batch</td><td>the read record batch </td></tr> + </table> + </dd> +</dl> + </div> </div> <a id="a3ca066d8bec5b5b8bd6112f3c17dbafd"></a> @@ -249,6 +292,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Return the schema read from the JSON. </p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_json_writer.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1ipc_1_1_json_writer.html b/docs/cpp/classarrow_1_1ipc_1_1_json_writer.html index e9f01e0..0dbb144 100644 --- a/docs/cpp/classarrow_1_1ipc_1_1_json_writer.html +++ b/docs/cpp/classarrow_1_1ipc_1_1_json_writer.html @@ -72,23 +72,32 @@ $(function() { </div><!--header--> <div class="contents"> -<p><code>#include <<a class="el" href="json_8h_source.html">json.h</a>></code></p> +<p>Write the JSON representation of an Arrow record batch file or stream. + <a href="classarrow_1_1ipc_1_1_json_writer.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="json_8h_source.html">arrow/ipc/json.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a5ee67188577cb18ecb9ea5c94caeb0c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_writer.html#a5ee67188577cb18ecb9ea5c94caeb0c8">~JsonWriter</a> ()</td></tr> <tr class="separator:a5ee67188577cb18ecb9ea5c94caeb0c8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9420078d728f84aebae1013f12f3f19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_writer.html#ac9420078d728f84aebae1013f12f3f19">WriteRecordBatch</a> (const <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> &batch)</td></tr> +<tr class="memdesc:ac9420078d728f84aebae1013f12f3f19"><td class="mdescLeft"> </td><td class="mdescRight">Append a record batch. <a href="#ac9420078d728f84aebae1013f12f3f19">More...</a><br /></td></tr> <tr class="separator:ac9420078d728f84aebae1013f12f3f19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a59c1e4b606e783745a1492e049ec654b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_writer.html#a59c1e4b606e783745a1492e049ec654b">Finish</a> (std::string *result)</td></tr> +<tr class="memdesc:a59c1e4b606e783745a1492e049ec654b"><td class="mdescLeft"> </td><td class="mdescRight">Finish the JSON payload and return as a std::string. <a href="#a59c1e4b606e783745a1492e049ec654b">More...</a><br /></td></tr> <tr class="separator:a59c1e4b606e783745a1492e049ec654b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> -<tr class="memitem:ad5aa5f9f2e82d2ca9ea27c724e638244"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_writer.html#ad5aa5f9f2e82d2ca9ea27c724e638244">Open</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_json_writer.html">JsonWriter</a> > *out)</td></tr> +<tr class="memitem:ad5aa5f9f2e82d2ca9ea27c724e638244"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_json_writer.html#ad5aa5f9f2e82d2ca9ea27c724e638244">Open</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_json_writer.html">JsonWriter</a> > *out)</td></tr> +<tr class="memdesc:ad5aa5f9f2e82d2ca9ea27c724e638244"><td class="mdescLeft"> </td><td class="mdescRight">Create a new JSON writer that writes to memory. <a href="#ad5aa5f9f2e82d2ca9ea27c724e638244">More...</a><br /></td></tr> <tr class="separator:ad5aa5f9f2e82d2ca9ea27c724e638244"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Write the JSON representation of an Arrow record batch file or stream. </p> +<p>This is used for integration testing </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a5ee67188577cb18ecb9ea5c94caeb0c8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5ee67188577cb18ecb9ea5c94caeb0c8">◆ </a></span>~JsonWriter()</h2> @@ -123,6 +132,15 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Finish the JSON payload and return as a std::string. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the JSON as as a std::string </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + </div> </div> <a id="ad5aa5f9f2e82d2ca9ea27c724e638244"></a> @@ -159,6 +177,16 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Create a new JSON writer that writes to memory. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">schema</td><td>the schema of record batches </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the returned writer object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> + </div> </div> <a id="ac9420078d728f84aebae1013f12f3f19"></a> @@ -177,6 +205,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Append a record batch. </p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_message.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1ipc_1_1_message.html b/docs/cpp/classarrow_1_1ipc_1_1_message.html index 342c842..01a9570 100644 --- a/docs/cpp/classarrow_1_1ipc_1_1_message.html +++ b/docs/cpp/classarrow_1_1ipc_1_1_message.html @@ -76,7 +76,7 @@ $(function() { <p>An IPC message including metadata and body. <a href="classarrow_1_1ipc_1_1_message.html#details">More...</a></p> -<p><code>#include <<a class="el" href="message_8h_source.html">message.h</a>></code></p> +<p><code>#include <<a class="el" href="message_8h_source.html">arrow/ipc/message.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> @@ -108,8 +108,10 @@ Public Member Functions</h2></td></tr> <tr class="memdesc:a22b16d852c30e70a4a6825c4376c67e3"><td class="mdescLeft"> </td><td class="mdescRight">the <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> body, if any <a href="#a22b16d852c30e70a4a6825c4376c67e3">More...</a><br /></td></tr> <tr class="separator:a22b16d852c30e70a4a6825c4376c67e3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac35d37942c386ee92eb436381744d6c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1ipc_1_1_message.html#a6d6973b3b03de50d7be9dbab4db910db">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_message.html#ac35d37942c386ee92eb436381744d6c9">type</a> () const</td></tr> +<tr class="memdesc:ac35d37942c386ee92eb436381744d6c9"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> type. <a href="#ac35d37942c386ee92eb436381744d6c9">More...</a><br /></td></tr> <tr class="separator:ac35d37942c386ee92eb436381744d6c9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2f64085955886f84817cb1676cf63b54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">MetadataVersion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_message.html#a2f64085955886f84817cb1676cf63b54">metadata_version</a> () const</td></tr> +<tr class="memdesc:a2f64085955886f84817cb1676cf63b54"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> metadata version. <a href="#a2f64085955886f84817cb1676cf63b54">More...</a><br /></td></tr> <tr class="separator:a2f64085955886f84817cb1676cf63b54"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a68fda3f801ed4cd05f5e9530dcfe8a34"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_message.html#a68fda3f801ed4cd05f5e9530dcfe8a34">header</a> () const</td></tr> <tr class="separator:a68fda3f801ed4cd05f5e9530dcfe8a34"><td class="memSeparator" colspan="2"> </td></tr> @@ -216,7 +218,7 @@ Static Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p>the <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> body, if any </p> -<dl class="section return"><dt>Returns</dt><dd>buffer is nullptr if no body </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>buffer is null if no body </dd></dl> </div> </div> @@ -299,6 +301,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>The <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> metadata version. </p> + </div> </div> <a id="ac5355af471fa5305790e959fe369f8cb"></a> @@ -345,11 +349,12 @@ Static Public Member Functions</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">metadata</td><td>a buffer containing the Flatbuffer metadata </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">body</td><td>a buffer containing the message body, which may be nullptr </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">body</td><td>a buffer containing the message body, which may be null </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the created message </td></tr> </table> </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl> </div> </div> @@ -398,10 +403,11 @@ Static Public Member Functions</h2></td></tr> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">metadata</td><td>containing a serialized <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> flatbuffer </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>an InputStream </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the created <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a></td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the created <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> </td></tr> </table> </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a></dd></dl> <dl class="section note"><dt>Note</dt><dd>If stream supports zero-copy, this is zero-copy </dd></dl> </div> @@ -459,6 +465,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>The <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> type. </p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_message_reader.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1ipc_1_1_message_reader.html b/docs/cpp/classarrow_1_1ipc_1_1_message_reader.html index 5ebd67e..5506cfe 100644 --- a/docs/cpp/classarrow_1_1ipc_1_1_message_reader.html +++ b/docs/cpp/classarrow_1_1ipc_1_1_message_reader.html @@ -74,7 +74,7 @@ $(function() { <p>Abstract interface for a sequence of messages. <a href="classarrow_1_1ipc_1_1_message_reader.html#details">More...</a></p> -<p><code>#include <<a class="el" href="message_8h_source.html">message.h</a>></code></p> +<p><code>#include <<a class="el" href="message_8h_source.html">arrow/ipc/message.h</a>></code></p> <div class="dynheader"> Inheritance diagram for arrow::ipc::MessageReader:</div> <div class="dyncontent">
