http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/c_glib/object-tree.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/object-tree.html b/docs/c_glib/object-tree.html index 953ec69..00cdc50 100644 --- a/docs/c_glib/object-tree.html +++ b/docs/c_glib/object-tree.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Reference Manual"> <link rel="up" href="index.html" title="Reference Manual"> -<link rel="prev" href="GArrowStreamWriter.html" title="GArrowStreamWriter"> +<link rel="prev" href="writer-classes.html" title="Writer classes"> <link rel="next" href="api-index-full.html" title="API Index"> <meta name="generator" content="GTK-Doc V1.20 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> @@ -16,7 +16,7 @@ <td width="100%" align="left" class="shortcuts"></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="GArrowStreamWriter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="writer-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> @@ -34,6 +34,7 @@ <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowInt32ArrayBuilder">GArrowInt32ArrayBuilder</a> <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowInt64ArrayBuilder">GArrowInt64ArrayBuilder</a> <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowInt8ArrayBuilder">GArrowInt8ArrayBuilder</a> + <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowIntArrayBuilder">GArrowIntArrayBuilder</a> <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowListArrayBuilder">GArrowListArrayBuilder</a> <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowStructArrayBuilder">GArrowStructArrayBuilder</a> <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="array-builder-classes.html#GArrowUInt16ArrayBuilder">GArrowUInt16ArrayBuilder</a> @@ -79,26 +80,34 @@ <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="buffer-classes.html#GArrowMutableBuffer">GArrowMutableBuffer</a> <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="buffer-classes.html#GArrowResizableBuffer">GArrowResizableBuffer</a> <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="buffer-classes.html#GArrowPoolBuffer">GArrowPoolBuffer</a> + <span class="lineart">âââ</span> <a class="link" href="input-stream-classes.html#GArrowInputStream">GArrowInputStream</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="input-stream-classes.html#GArrowSeekableInputStream">GArrowSeekableInputStream</a> + <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="input-stream-classes.html#GArrowBufferInputStream">GArrowBufferInputStream</a> + <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="input-stream-classes.html#GArrowGIOInputStream">GArrowGIOInputStream</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="input-stream-classes.html#GArrowMemoryMappedInputStream">GArrowMemoryMappedInputStream</a> + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowOutputStream">GArrowOutputStream</a> + <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream">GArrowBufferOutputStream</a> + <span class="lineart">â</span> <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowFileOutputStream">GArrowFileOutputStream</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream">GArrowGIOOutputStream</a> <span class="lineart">âââ</span> <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray">GArrowChunkedArray</a> <span class="lineart">âââ</span> <a class="link" href="GArrowColumn.html" title="GArrowColumn">GArrowColumn</a> + <span class="lineart">âââ</span> <a class="link" href="reader-classes.html#GArrowFeatherFileReader">GArrowFeatherFileReader</a> + <span class="lineart">âââ</span> <a class="link" href="writer-classes.html#GArrowFeatherFileWriter">GArrowFeatherFileWriter</a> <span class="lineart">âââ</span> <a class="link" href="GArrowField.html" title="GArrowField">GArrowField</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowFileOutputStream.html" title="GArrowFileOutputStream">GArrowFileOutputStream</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowFileReader.html" title="GArrowFileReader">GArrowFileReader</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowStreamWriter.html" title="GArrowStreamWriter">GArrowStreamWriter</a> - <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter">GArrowFileWriter</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowMemoryMappedFile.html" title="GArrowMemoryMappedFile">GArrowMemoryMappedFile</a> + <span class="lineart">âââ</span> <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader">GArrowRecordBatchFileReader</a> + <span class="lineart">âââ</span> <a class="link" href="writer-classes.html#GArrowRecordBatchWriter">GArrowRecordBatchWriter</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter">GArrowRecordBatchStreamWriter</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter">GArrowRecordBatchFileWriter</a> <span class="lineart">âââ</span> <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch">GArrowRecordBatch</a> + <span class="lineart">âââ</span> <a class="link" href="reader-classes.html#GArrowRecordBatchReader">GArrowRecordBatchReader</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader">GArrowRecordBatchStreamReader</a> <span class="lineart">âââ</span> <a class="link" href="GArrowSchema.html" title="GArrowSchema">GArrowSchema</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader">GArrowStreamReader</a> <span class="lineart">âââ</span> <a class="link" href="GArrowTable.html" title="GArrowTable">GArrowTable</a> <span class="lineart">â°ââ</span> <a class="link" href="GArrowTensor.html" title="GArrowTensor">GArrowTensor</a> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> <span class="lineart">âââ</span> <a class="link" href="GArrowFile.html" title="GArrowFile">GArrowFile</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowWriteable.html" title="GArrowWriteable">GArrowWriteable</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowOutputStream.html" title="GArrowOutputStream">GArrowOutputStream</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowInputStream.html" title="GArrowInputStream">GArrowInputStream</a> <span class="lineart">âââ</span> <a class="link" href="GArrowReadable.html" title="GArrowReadable">GArrowReadable</a> - <span class="lineart">âââ</span> <a class="link" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile">GArrowRandomAccessFile</a> + <span class="lineart">âââ</span> <a class="link" href="GArrowWriteable.html" title="GArrowWriteable">GArrowWriteable</a> <span class="lineart">â°ââ</span> <a class="link" href="GArrowWriteableFile.html" title="GArrowWriteableFile">GArrowWriteableFile</a> </pre> </div>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/c_glib/output-stream-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/output-stream-classes.html b/docs/c_glib/output-stream-classes.html new file mode 100644 index 0000000..dc41947 --- /dev/null +++ b/docs/c_glib/output-stream-classes.html @@ -0,0 +1,375 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> Reference Manual: Output stream classes</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="GArrowWriteableFile.html" title="GArrowWriteableFile"> +<link rel="next" href="input-output.html" title="Input and output"> +<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#output-stream-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#output-stream-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#output-stream-classes.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#output-stream-classes.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowWriteableFile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="input-output.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="output-stream-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="output-stream-classes.top_of_page"></a>Output stream classes</span></h2> +<p>Output stream classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="output-stream-classes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-output-stream-write-tensor" title="garrow_output_stream_write_tensor ()">garrow_output_stream_write_tensor</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="returnvalue">GArrowFileOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-file-output-stream-new" title="garrow_file_output_stream_new ()">garrow_file_output_stream_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="returnvalue">GArrowBufferOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-buffer-output-stream-new" title="garrow_buffer_output_stream_new ()">garrow_buffer_output_stream_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="returnvalue">GArrowGIOOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-gio-output-stream-new" title="garrow_gio_output_stream_new ()">garrow_gio_output_stream_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="GOutputStream"><span class="returnvalue">GOutputStream</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-gio-output-stream-get-raw" title="garrow_gio_output_stream_get_raw ()">garrow_gio_output_stream_get_raw</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="output-stream-classes.html#GArrowOutputStream--output-stream" title="The âoutput-streamâ property">output-stream</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<a name="GArrowOutputStream"></a><a name="GArrowFileOutputStream"></a><a name="GArrowBufferOutputStream"></a><a name="GArrowGIOOutputStream"></a><div class="refsect1"> +<a name="output-stream-classes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowOutputStream-struct" title="struct GArrowOutputStream">GArrowOutputStream</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowFileOutputStream-struct" title="struct GArrowFileOutputStream">GArrowFileOutputStream</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowBufferOutputStream-struct" title="struct GArrowBufferOutputStream">GArrowBufferOutputStream</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream-struct" title="struct GArrowGIOOutputStream">GArrowGIOOutputStream</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowOutputStream">GArrowOutputStream</a> + <span class="lineart">â</span> <span class="lineart">âââ</span> GArrowBufferOutputStream + <span class="lineart">â</span> <span class="lineart">âââ</span> GArrowFileOutputStream + <span class="lineart">â</span> <span class="lineart">â°ââ</span> GArrowGIOOutputStream + <span class="lineart">â°ââ</span> GArrowOutputStream + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream">GArrowBufferOutputStream</a> + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowFileOutputStream">GArrowFileOutputStream</a> + <span class="lineart">â°ââ</span> <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream">GArrowGIOOutputStream</a> +</pre> +</div> +<div class="refsect1"> +<a name="output-stream-classes.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GArrowOutputStream implements +</p> +<p> +GArrowFileOutputStream implements +</p> +<p> +GArrowBufferOutputStream implements +</p> +<p> +GArrowGIOOutputStream implements +</p> +</div> +<div class="refsect1"> +<a name="output-stream-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="output-stream-classes.description"></a><h2>Description</h2> +<p><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> is an interface for stream output. Stream +output is file based and writeable</p> +<p><a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="type">GArrowFileOutputStream</span></a> is a class for file output stream.</p> +<p><a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="type">GArrowBufferOutputStream</span></a> is a class for buffer output stream.</p> +<p><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a> is a class for <code class="literal">GOutputStream</code> based output +stream.</p> +</div> +<div class="refsect1"> +<a name="output-stream-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-output-stream-write-tensor"></a><h3>garrow_output_stream_write_tensor ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_output_stream_write_tensor (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *stream</code></em>, + <em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.4.4.14.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stream</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowWriteable.html" title="GArrowWriteable"><span class="type">GArrowWriteable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> to be written.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.4.14.2.5"></a><h4>Returns</h4> +<p> The number of written bytes on success, -1 on error.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-output-stream-new"></a><h3>garrow_file_output_stream_new ()</h3> +<pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="returnvalue">GArrowFileOutputStream</span></a> * +garrow_file_output_stream_new (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *path</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gboolean"><span class="type">gboolean</span></GTKDOCLINK> append</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.4.4.14.3.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>path</p></td> +<td class="parameter_description"><p>The path of the file output stream.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>append</p></td> +<td class="parameter_description"><p>Whether the path is opened as append mode or recreate mode.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.4.14.3.5"></a><h4>Returns</h4> +<p> A newly opened <a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="type">GArrowFileOutputStream</span></a> or +<GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-output-stream-new"></a><h3>garrow_buffer_output_stream_new ()</h3> +<pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="returnvalue">GArrowBufferOutputStream</span></a> * +garrow_buffer_output_stream_new (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.4.4.14.4.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p>The resizable buffer to be output.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.4.14.4.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="type">GArrowBufferOutputStream</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-gio-output-stream-new"></a><h3>garrow_gio_output_stream_new ()</h3> +<pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="returnvalue">GArrowGIOOutputStream</span></a> * +garrow_gio_output_stream_new (<em class="parameter"><code><GTKDOCLINK HREF="GOutputStream"><span class="type">GOutputStream</span></GTKDOCLINK> *gio_output_stream</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.4.4.14.5.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>gio_output_stream</p></td> +<td class="parameter_description"><p>The stream to be output.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.4.14.5.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-gio-output-stream-get-raw"></a><h3>garrow_gio_output_stream_get_raw ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GOutputStream"><span class="returnvalue">GOutputStream</span></GTKDOCLINK> * +garrow_gio_output_stream_get_raw (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a> *output_stream</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.4.4.14.6.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>output_stream</p></td> +<td class="parameter_description"><p>A <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.4.4.14.6.5"></a><h4>Returns</h4> +<p> The wrapped <GTKDOCLINK HREF="GOutputStream"><span class="type">GOutputStream</span></GTKDOCLINK>. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since 0.5.0</p> +</div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowOutputStream-struct"></a><h3>struct GArrowOutputStream</h3> +<pre class="programlisting">struct GArrowOutputStream;</pre> +<p>It wraps <code class="literal">arrow::io::OutputStream</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowFileOutputStream-struct"></a><h3>struct GArrowFileOutputStream</h3> +<pre class="programlisting">struct GArrowFileOutputStream;</pre> +<p>It wraps <code class="literal">arrow::io::FileOutputStream</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowBufferOutputStream-struct"></a><h3>struct GArrowBufferOutputStream</h3> +<pre class="programlisting">struct GArrowBufferOutputStream;</pre> +<p>It wraps <code class="literal">arrow::io::BufferOutputStream</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowGIOOutputStream-struct"></a><h3>struct GArrowGIOOutputStream</h3> +<pre class="programlisting">struct GArrowGIOOutputStream;</pre> +<p>It's an output stream for <code class="literal">GOutputStream</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowOutputStream--output-stream"></a><h3>The <code class="literal">âoutput-streamâ</code> property</h3> +<pre class="programlisting"> âoutput-streamâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::io::OutputStream> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/c_glib/output.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/output.html b/docs/c_glib/output.html index 2ca7baf..d430722 100644 --- a/docs/c_glib/output.html +++ b/docs/c_glib/output.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Reference Manual"> <link rel="up" href="io.html" title="Part II. IO"> -<link rel="prev" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"> +<link rel="prev" href="input-stream-classes.html" title="Input stream classes"> <link rel="next" href="GArrowWriteable.html" title="GArrowWriteable"> <meta name="generator" content="GTK-Doc V1.20 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> @@ -16,7 +16,7 @@ <td width="100%" align="left" class="shortcuts"></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="io.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="GArrowRandomAccessFile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="input-stream-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="GArrowWriteable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> @@ -27,13 +27,10 @@ <span class="refentrytitle"><a href="GArrowWriteable.html">GArrowWriteable</a></span><span class="refpurpose"> â Output interface</span> </dt> <dt> -<span class="refentrytitle"><a href="GArrowOutputStream.html">GArrowOutputStream</a></span><span class="refpurpose"> â Stream output interface</span> -</dt> -<dt> <span class="refentrytitle"><a href="GArrowWriteableFile.html">GArrowWriteableFile</a></span><span class="refpurpose"> â File output interface</span> </dt> <dt> -<span class="refentrytitle"><a href="GArrowFileOutputStream.html">GArrowFileOutputStream</a></span><span class="refpurpose"> â A file output stream.</span> +<span class="refentrytitle"><a href="output-stream-classes.html">Output stream classes</a></span><span class="refpurpose"></span> </dt> </dl></div> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/c_glib/reader-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/reader-classes.html b/docs/c_glib/reader-classes.html new file mode 100644 index 0000000..d7dae65 --- /dev/null +++ b/docs/c_glib/reader-classes.html @@ -0,0 +1,975 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title> Reference Manual: Reader classes</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="reader.html" title="Reader"> +<link rel="prev" href="reader.html" title="Reader"> +<link rel="next" href="writer.html" title="Writer"> +<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#reader-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#reader-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#reader-classes.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="reader.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="reader.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="writer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="reader-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="reader-classes.top_of_page"></a>Reader classes</span></h2> +<p>Reader classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="reader-classes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-reader-get-schema" title="garrow_record_batch_reader_get_schema ()">garrow_record_batch_reader_get_schema</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-reader-get-next-record-batch" title="garrow_record_batch_reader_get_next_record_batch ()">garrow_record_batch_reader_get_next_record_batch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next-record-batch" title="garrow_record_batch_reader_read_next_record_batch ()">garrow_record_batch_reader_read_next_record_batch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="returnvalue">GArrowRecordBatchStreamReader</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-stream-reader-new" title="garrow_record_batch_stream_reader_new ()">garrow_record_batch_stream_reader_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="returnvalue">GArrowRecordBatchFileReader</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-file-reader-new" title="garrow_record_batch_file_reader_new ()">garrow_record_batch_file_reader_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-schema" title="garrow_record_batch_file_reader_get_schema ()">garrow_record_batch_file_reader_get_schema</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-n-record-batches" title="garrow_record_batch_file_reader_get_n_record_batches ()">garrow_record_batch_file_reader_get_n_record_batches</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="arrow-glib-GArrowMetadataVersion.html#GArrowMetadataVersion" title="enum GArrowMetadataVersion"><span class="returnvalue">GArrowMetadataVersion</span></a> +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-version" title="garrow_record_batch_file_reader_get_version ()">garrow_record_batch_file_reader_get_version</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-record-batch" title="garrow_record_batch_file_reader_get_record_batch ()">garrow_record_batch_file_reader_get_record_batch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-record-batch-file-reader-read-record-batch" title="garrow_record_batch_file_reader_read_record_batch ()">garrow_record_batch_file_reader_read_record_batch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="returnvalue">GArrowFeatherFileReader</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-new" title="garrow_feather_file_reader_new ()">garrow_feather_file_reader_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-description" title="garrow_feather_file_reader_get_description ()">garrow_feather_file_reader_get_description</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-has-description" title="garrow_feather_file_reader_has_description ()">garrow_feather_file_reader_has_description</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-version" title="garrow_feather_file_reader_get_version ()">garrow_feather_file_reader_get_version</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-n-rows" title="garrow_feather_file_reader_get_n_rows ()">garrow_feather_file_reader_get_n_rows</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-n-columns" title="garrow_feather_file_reader_get_n_columns ()">garrow_feather_file_reader_get_n_columns</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-column-name" title="garrow_feather_file_reader_get_column_name ()">garrow_feather_file_reader_get_column_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-column" title="garrow_feather_file_reader_get_column ()">garrow_feather_file_reader_get_column</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-feather-file-reader-get-columns" title="garrow_feather_file_reader_get_columns ()">garrow_feather_file_reader_get_columns</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="reader-classes.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReader--record-batch-reader" title="The ârecord-batch-readerâ property">record-batch-reader</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader--record-batch-file-reader" title="The ârecord-batch-file-readerâ property">record-batch-file-reader</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="reader-classes.html#GArrowFeatherFileReader--feather-table-reader" title="The âfeather-table-readerâ property">feather-table-reader</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<a name="GArrowRecordBatchReader"></a><a name="GArrowRecordBatchStreamReader"></a><a name="GArrowRecordBatchFileReader"></a><a name="GArrowFeatherFileReader"></a><div class="refsect1"> +<a name="reader-classes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReader-struct" title="struct GArrowRecordBatchReader">GArrowRecordBatchReader</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader-struct" title="struct GArrowRecordBatchStreamReader">GArrowRecordBatchStreamReader</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader-struct" title="struct GArrowRecordBatchFileReader">GArrowRecordBatchFileReader</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowFeatherFileReader-struct" title="struct GArrowFeatherFileReader">GArrowFeatherFileReader</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="reader-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">âââ</span> GArrowFeatherFileReader + <span class="lineart">âââ</span> GArrowRecordBatchFileReader + <span class="lineart">âââ</span> <a class="link" href="reader-classes.html#GArrowRecordBatchReader">GArrowRecordBatchReader</a> + <span class="lineart">â</span> <span class="lineart">â°ââ</span> GArrowRecordBatchStreamReader + <span class="lineart">â°ââ</span> GArrowRecordBatchReader + <span class="lineart">â°ââ</span> <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader">GArrowRecordBatchStreamReader</a> +</pre> +</div> +<div class="refsect1"> +<a name="reader-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="reader-classes.description"></a><h2>Description</h2> +<p><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> is a base class for reading record batches +in stream format from input.</p> +<p><a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="type">GArrowRecordBatchStreamReader</span></a> is a class for reading record +batches in stream format from input synchronously.</p> +<p><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> is a class for reading record +batches in file format from input.</p> +<p><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> is a class for reading columns in Feather +file format from input.</p> +</div> +<div class="refsect1"> +<a name="reader-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-record-batch-reader-get-schema"></a><h3>garrow_record_batch_reader_get_schema ()</h3> +<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +garrow_record_batch_reader_get_schema (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.2.5"></a><h4>Returns</h4> +<p> The schema in the stream. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-reader-get-next-record-batch"></a><h3>garrow_record_batch_reader_get_next_record_batch ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_reader_get_next_record_batch + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="warning"> +<p><code class="literal">garrow_record_batch_reader_get_next_record_batch</code> has been deprecated since version 0.5.0 and should not be used in newly-written code.</p> +<p>Use <a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next-record-batch" title="garrow_record_batch_reader_read_next_record_batch ()"><code class="function">garrow_record_batch_reader_read_next_record_batch()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.3.7"></a><h4>Returns</h4> +<p> The next record batch in the stream or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on end of stream. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-reader-read-next-record-batch"></a><h3>garrow_record_batch_reader_read_next_record_batch ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_reader_read_next_record_batch + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.4.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.4.5"></a><h4>Returns</h4> +<p> The next record batch in the stream or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on end of stream. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.5.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-stream-reader-new"></a><h3>garrow_record_batch_stream_reader_new ()</h3> +<pre class="programlisting"><a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="returnvalue">GArrowRecordBatchStreamReader</span></a> * +garrow_record_batch_stream_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="type">GArrowInputStream</span></a> *stream</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.5.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stream</p></td> +<td class="parameter_description"><p>The stream to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.5.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="type">GArrowRecordBatchStreamReader</span></a> +or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-reader-new"></a><h3>garrow_record_batch_file_reader_new ()</h3> +<pre class="programlisting"><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="returnvalue">GArrowRecordBatchFileReader</span></a> * +garrow_record_batch_file_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.6.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>file</p></td> +<td class="parameter_description"><p>The file to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.6.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> +or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-reader-get-schema"></a><h3>garrow_record_batch_file_reader_get_schema ()</h3> +<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +garrow_record_batch_file_reader_get_schema + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.7.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.7.5"></a><h4>Returns</h4> +<p> The schema in the file. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-reader-get-n-record-batches"></a><h3>garrow_record_batch_file_reader_get_n_record_batches ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +garrow_record_batch_file_reader_get_n_record_batches + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.8.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.8.5"></a><h4>Returns</h4> +<p> The number of record batches in the file.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-reader-get-version"></a><h3>garrow_record_batch_file_reader_get_version ()</h3> +<pre class="programlisting"><a class="link" href="arrow-glib-GArrowMetadataVersion.html#GArrowMetadataVersion" title="enum GArrowMetadataVersion"><span class="returnvalue">GArrowMetadataVersion</span></a> +garrow_record_batch_file_reader_get_version + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.9.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.9.5"></a><h4>Returns</h4> +<p> The format version in the file.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-reader-get-record-batch"></a><h3>garrow_record_batch_file_reader_get_record_batch ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_file_reader_get_record_batch + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="warning"> +<p><code class="literal">garrow_record_batch_file_reader_get_record_batch</code> has been deprecated since version 0.5.0 and should not be used in newly-written code.</p> +<p>Use <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-read-record-batch" title="garrow_record_batch_file_reader_read_record_batch ()"><code class="function">garrow_record_batch_file_reader_read_record_batch()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.10.6"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>i</p></td> +<td class="parameter_description"><p>The index of the target record batch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.10.7"></a><h4>Returns</h4> +<p> The i-th record batch in the file or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-reader-read-record-batch"></a><h3>garrow_record_batch_file_reader_read_record_batch ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_file_reader_read_record_batch + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.11.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>i</p></td> +<td class="parameter_description"><p>The index of the target record batch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.11.5"></a><h4>Returns</h4> +<p> The i-th record batch in the file or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.5.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-new"></a><h3>garrow_feather_file_reader_new ()</h3> +<pre class="programlisting"><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="returnvalue">GArrowFeatherFileReader</span></a> * +garrow_feather_file_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.12.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>file</p></td> +<td class="parameter_description"><p>The file to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.12.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> +or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-description"></a><h3>garrow_feather_file_reader_get_description ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_feather_file_reader_get_description + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.13.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.13.5"></a><h4>Returns</h4> +<p> The description of the file if it exists, +<GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> otherwise. You can confirm whether description exists or not by +<a class="link" href="reader-classes.html#garrow-feather-file-reader-has-description" title="garrow_feather_file_reader_has_description ()"><code class="function">garrow_feather_file_reader_has_description()</code></a>. +It should be freed with <GTKDOCLINK HREF="g-free"><code class="function">g_free()</code></GTKDOCLINK> when no longer needed. </p> +<p><span class="annotation">[nullable]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-has-description"></a><h3>garrow_feather_file_reader_has_description ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_feather_file_reader_has_description + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.14.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.14.5"></a><h4>Returns</h4> +<p> Whether the file has description or not.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-version"></a><h3>garrow_feather_file_reader_get_version ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> +garrow_feather_file_reader_get_version + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.15.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.15.5"></a><h4>Returns</h4> +<p> The format version of the file.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-n-rows"></a><h3>garrow_feather_file_reader_get_n_rows ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_feather_file_reader_get_n_rows (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.16.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.16.5"></a><h4>Returns</h4> +<p> The number of rows in the file.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-n-columns"></a><h3>garrow_feather_file_reader_get_n_columns ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_feather_file_reader_get_n_columns + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.17.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.17.5"></a><h4>Returns</h4> +<p> The number of columns in the file.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-column-name"></a><h3>garrow_feather_file_reader_get_column_name ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_feather_file_reader_get_column_name + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> i</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.18.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>i</p></td> +<td class="parameter_description"><p>The index of the target column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.18.5"></a><h4>Returns</h4> +<p> The i-th column name in the file. +It should be freed with <GTKDOCLINK HREF="g-free"><code class="function">g_free()</code></GTKDOCLINK> when no longer needed.</p> +<p></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-column"></a><h3>garrow_feather_file_reader_get_column ()</h3> +<pre class="programlisting"><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +garrow_feather_file_reader_get_column (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.19.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>i</p></td> +<td class="parameter_description"><p>The index of the target column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.19.5"></a><h4>Returns</h4> +<p> The i-th column in the file or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-feather-file-reader-get-columns"></a><h3>garrow_feather_file_reader_get_columns ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +garrow_feather_file_reader_get_columns + (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.2.13.20.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.13.20.5"></a><h4>Returns</h4> +<p> The columns in the file. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowColumn][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.4.0</p> +</div> +</div> +<div class="refsect1"> +<a name="reader-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowRecordBatchReader-struct"></a><h3>struct GArrowRecordBatchReader</h3> +<pre class="programlisting">struct GArrowRecordBatchReader;</pre> +<p>It wraps <code class="literal">arrow::ipc::RecordBatchReader</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchStreamReader-struct"></a><h3>struct GArrowRecordBatchStreamReader</h3> +<pre class="programlisting">struct GArrowRecordBatchStreamReader;</pre> +<p>It wraps <code class="literal">arrow::ipc::RecordBatchStreamReader</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchFileReader-struct"></a><h3>struct GArrowRecordBatchFileReader</h3> +<pre class="programlisting">struct GArrowRecordBatchFileReader;</pre> +<p>It wraps <code class="literal">arrow::ipc::RecordBatchFileReader</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowFeatherFileReader-struct"></a><h3>struct GArrowFeatherFileReader</h3> +<pre class="programlisting">struct GArrowFeatherFileReader;</pre> +<p>It wraps <code class="literal">arrow::ipc::feather::TableReader</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="reader-classes.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowRecordBatchReader--record-batch-reader"></a><h3>The <code class="literal">ârecord-batch-readerâ</code> property</h3> +<pre class="programlisting"> ârecord-batch-readerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ipc::RecordBatchRecordBatchReader> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchFileReader--record-batch-file-reader"></a><h3>The <code class="literal">ârecord-batch-file-readerâ</code> property</h3> +<pre class="programlisting"> ârecord-batch-file-readerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ipc::RecordBatchFileReader> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowFeatherFileReader--feather-table-reader"></a><h3>The <code class="literal">âfeather-table-readerâ</code> property</h3> +<pre class="programlisting"> âfeather-table-readerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ipc::feather::TableReader> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/c_glib/reader.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/reader.html b/docs/c_glib/reader.html index 42ced9f..8aa9269 100644 --- a/docs/c_glib/reader.html +++ b/docs/c_glib/reader.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="Reference Manual"> <link rel="up" href="ipc.html" title="Part III. IPC"> <link rel="prev" href="arrow-glib-GArrowMetadataVersion.html" title="GArrowMetadataVersion"> -<link rel="next" href="GArrowFileReader.html" title="GArrowFileReader"> +<link rel="next" href="reader-classes.html" title="Reader classes"> <meta name="generator" content="GTK-Doc V1.20 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -17,19 +17,14 @@ <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ipc.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="arrow-glib-GArrowMetadataVersion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="GArrowFileReader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="reader-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> <a name="reader"></a>Reader</h2></div></div></div> -<div class="toc"><dl class="toc"> -<dt> -<span class="refentrytitle"><a href="GArrowFileReader.html">GArrowFileReader</a></span><span class="refpurpose"> â File reader class</span> -</dt> -<dt> -<span class="refentrytitle"><a href="GArrowStreamReader.html">GArrowStreamReader</a></span><span class="refpurpose"> â Stream reader class</span> -</dt> -</dl></div> +<div class="toc"><dl class="toc"><dt> +<span class="refentrytitle"><a href="reader-classes.html">Reader classes</a></span><span class="refpurpose"></span> +</dt></dl></div> </div> <div class="footer"> <hr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/c_glib/tensor.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/tensor.html b/docs/c_glib/tensor.html index 167ad8b..8928bb5 100644 --- a/docs/c_glib/tensor.html +++ b/docs/c_glib/tensor.html @@ -23,7 +23,7 @@ <div class="titlepage"><div><div><h2 class="title"> <a name="tensor"></a>Tensor</h2></div></div></div> <div class="toc"><dl class="toc"><dt> -<span class="refentrytitle"><a href="GArrowTensor.html">GArrowTensor</a></span><span class="refpurpose"> â Tensor class.</span> +<span class="refentrytitle"><a href="GArrowTensor.html">GArrowTensor</a></span><span class="refpurpose"> â Tensor class</span> </dt></dl></div> </div> <div class="footer">
