http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/reader-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/reader-classes.html b/docs/c_glib/reader-classes.html index d7dae65..6cc65fb 100644 --- a/docs/c_glib/reader-classes.html +++ b/docs/c_glib/reader-classes.html @@ -2,21 +2,21 @@ <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"> +<title>Reader classes: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib 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)"> +<meta name="generator" content="GTK-Doc V1.25 (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"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><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="#" 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> @@ -35,7 +35,7 @@ </tr></table></div> <div class="refsect1"> <a name="reader-classes.functions"></a><h2>Functions</h2> -<div class="informaltable"><table width="100%" border="0"> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_return"> <col class="functions_name"> @@ -67,6 +67,22 @@ </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" title="garrow_record_batch_reader_read_next ()">garrow_record_batch_reader_read_next</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="reader-classes.html#GArrowTableBatchReader"><span class="returnvalue">GArrowTableBatchReader</span></a> * +</td> +<td class="function_name"> +<a class="link" href="reader-classes.html#garrow-table-batch-reader-new" title="garrow_table_batch_reader_new ()">garrow_table_batch_reader_new</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"> @@ -198,7 +214,7 @@ </div> <div class="refsect1"> <a name="reader-classes.properties"></a><h2>Properties</h2> -<div class="informaltable"><table border="0"> +<div class="informaltable"><table class="informaltable" border="0"> <colgroup> <col width="150px" class="properties_type"> <col width="300px" class="properties_name"> @@ -207,33 +223,45 @@ <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_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#GArrowRecordBatchFileReader--record-batch-file-reader" title="The ârecord-batch-file-readerâ property">record-batch-file-reader</a></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> <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_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> </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="GArrowRecordBatchStreamReader"></a><a name="GArrowRecordBatchFileReader"></a><a name="GArrowFeatherFileReader"></a><a name="GArrowRecordBatchReader"></a><a name="GArrowTableBatchReader"></a><div class="refsect1"> <a name="reader-classes.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="name"> <col class="description"> </colgroup> <tbody> <tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-RECORD-BATCH-READER:CAPS" title="GARROW_TYPE_RECORD_BATCH_READER">GARROW_TYPE_RECORD_BATCH_READER</a></td> +</tr> +<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> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReaderClass" title="struct GArrowRecordBatchReaderClass">GArrowRecordBatchReaderClass</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-TABLE-BATCH-READER:CAPS" title="GARROW_TYPE_TABLE_BATCH_READER">GARROW_TYPE_TABLE_BATCH_READER</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowTableBatchReaderClass" title="struct GArrowTableBatchReaderClass">GArrowTableBatchReaderClass</a></td> </tr> <tr> <td class="datatype_keyword">struct</td> @@ -247,6 +275,14 @@ <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> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReader-struct" title="GArrowRecordBatchReader">GArrowRecordBatchReader</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="reader-classes.html#GArrowTableBatchReader-struct" title="GArrowTableBatchReader">GArrowTableBatchReader</a></td> +</tr> </tbody> </table></div> </div> @@ -255,10 +291,10 @@ <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> + <span class="lineart">âââ</span> <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader">GArrowRecordBatchStreamReader</a> + <span class="lineart">âââ</span> GArrowTableBatchReader + <span class="lineart">â°ââ</span> GArrowRecordBatchStreamReader </pre> </div> <div class="refsect1"> @@ -284,8 +320,8 @@ file format from input.</p> <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"> +<a name="garrow-record-batch-reader-get-schema.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -299,11 +335,11 @@ garrow_record_batch_reader_get_schema (<em class="parameter"><code><a class="lin </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.2.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-reader-get-schema.returns"></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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -314,11 +350,11 @@ garrow_record_batch_reader_get_next_record_batch <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> +<p>Use <a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next" title="garrow_record_batch_reader_read_next ()"><code class="function">garrow_record_batch_reader_read_next()</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"> +<a name="garrow-record-batch-reader-get-next-record-batch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -333,17 +369,17 @@ garrow_record_batch_reader_get_next_record_batch <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.3.7"></a><h4>Returns</h4> +<a name="garrow-record-batch-reader-get-next-record-batch.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -352,9 +388,48 @@ garrow_record_batch_reader_get_next_record_batch 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="warning"> +<p><code class="literal">garrow_record_batch_reader_read_next_record_batch</code> has been deprecated since version 0.8.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" title="garrow_record_batch_reader_read_next ()"><code class="function">garrow_record_batch_reader_read_next()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="garrow-record-batch-reader-read-next-record-batch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-record-batch-reader-read-next-record-batch.returns"></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">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-5-0.html#api-index-0.5.0">0.5.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-reader-read-next"></a><h3>garrow_record_batch_reader_read_next ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_reader_read_next (<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"> +<a name="garrow-record-batch-reader-read-next.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -369,17 +444,43 @@ garrow_record_batch_reader_read_next_record_batch <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.4.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-reader-read-next.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-table-batch-reader-new"></a><h3>garrow_table_batch_reader_new ()</h3> +<pre class="programlisting"><a class="link" href="reader-classes.html#GArrowTableBatchReader"><span class="returnvalue">GArrowTableBatchReader</span></a> * +garrow_table_batch_reader_new (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-table-batch-reader-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>table</p></td> +<td class="parameter_description"><p>The table to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-table-batch-reader-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="reader-classes.html#GArrowTableBatchReader"><span class="type">GArrowTableBatchReader</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> </div> <hr> <div class="refsect2"> @@ -388,8 +489,8 @@ garrow_record_batch_reader_read_next_record_batch 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"> +<a name="garrow-record-batch-stream-reader-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -404,18 +505,18 @@ garrow_record_batch_stream_reader_new (<em class="parameter"><code><a class="lin <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.5.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-stream-reader-new.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -424,8 +525,8 @@ or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> o 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"> +<a name="garrow-record-batch-file-reader-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -440,18 +541,18 @@ garrow_record_batch_file_reader_new (<em class="parameter"><code><a class="link" <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.6.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-file-reader-new.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -460,8 +561,8 @@ or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> o 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"> +<a name="garrow-record-batch-file-reader-get-schema.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -475,11 +576,11 @@ garrow_record_batch_file_reader_get_schema </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.7.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-file-reader-get-schema.returns"></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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -488,8 +589,8 @@ garrow_record_batch_file_reader_get_schema 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"> +<a name="garrow-record-batch-file-reader-get-n-record-batches.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -503,11 +604,10 @@ garrow_record_batch_file_reader_get_n_record_batches </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.8.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-file-reader-get-n-record-batches.returns"></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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -516,8 +616,8 @@ garrow_record_batch_file_reader_get_n_record_batches 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"> +<a name="garrow-record-batch-file-reader-get-version.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -531,11 +631,10 @@ garrow_record_batch_file_reader_get_version </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.9.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-file-reader-get-version.returns"></a><h4>Returns</h4> <p> The format version in the file.</p> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -550,8 +649,8 @@ garrow_record_batch_file_reader_get_record_batch <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"> +<a name="garrow-record-batch-file-reader-get-record-batch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -571,17 +670,17 @@ garrow_record_batch_file_reader_get_record_batch <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.10.7"></a><h4>Returns</h4> +<a name="garrow-record-batch-file-reader-get-record-batch.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -592,8 +691,8 @@ garrow_record_batch_file_reader_read_record_batch <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"> +<a name="garrow-record-batch-file-reader-read-record-batch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -613,17 +712,17 @@ garrow_record_batch_file_reader_read_record_batch <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.11.5"></a><h4>Returns</h4> +<a name="garrow-record-batch-file-reader-read-record-batch.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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> +<p class="since">Since: <a class="link" href="api-index-0-5-0.html#api-index-0.5.0">0.5.0</a></p> </div> <hr> <div class="refsect2"> @@ -632,8 +731,8 @@ garrow_record_batch_file_reader_read_record_batch 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"> +<a name="garrow-feather-file-reader-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -648,18 +747,18 @@ garrow_feather_file_reader_new (<em class="parameter"><code><a class="link" href <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.12.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-new.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -668,8 +767,8 @@ or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> o 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"> +<a name="garrow-feather-file-reader-get-description.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -683,14 +782,14 @@ garrow_feather_file_reader_get_description </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.13.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-description.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -699,8 +798,8 @@ It should be freed with <GTKDOCLINK HREF="g-free"><code class="function">g_free( 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"> +<a name="garrow-feather-file-reader-has-description.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -714,11 +813,10 @@ garrow_feather_file_reader_has_description </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.14.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-has-description.returns"></a><h4>Returns</h4> <p> Whether the file has description or not.</p> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -727,8 +825,8 @@ garrow_feather_file_reader_has_description 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"> +<a name="garrow-feather-file-reader-get-version.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -742,11 +840,10 @@ garrow_feather_file_reader_get_version </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.15.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-version.returns"></a><h4>Returns</h4> <p> The format version of the file.</p> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -754,8 +851,8 @@ garrow_feather_file_reader_get_version <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"> +<a name="garrow-feather-file-reader-get-n-rows.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -769,11 +866,10 @@ garrow_feather_file_reader_get_n_rows (<em class="parameter"><code><a class="lin </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.16.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-n-rows.returns"></a><h4>Returns</h4> <p> The number of rows in the file.</p> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -782,8 +878,8 @@ garrow_feather_file_reader_get_n_rows (<em class="parameter"><code><a class="lin 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"> +<a name="garrow-feather-file-reader-get-n-columns.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -797,11 +893,10 @@ garrow_feather_file_reader_get_n_columns </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.17.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-n-columns.returns"></a><h4>Returns</h4> <p> The number of columns in the file.</p> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -811,8 +906,8 @@ 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"> +<a name="garrow-feather-file-reader-get-column-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -833,12 +928,11 @@ garrow_feather_file_reader_get_column_name </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.18.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-column-name.returns"></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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -848,8 +942,8 @@ garrow_feather_file_reader_get_column (<em class="parameter"><code><a class="lin <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"> +<a name="garrow-feather-file-reader-get-column.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -869,17 +963,17 @@ garrow_feather_file_reader_get_column (<em class="parameter"><code><a class="lin <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.19.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-column.returns"></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> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> </div> <hr> <div class="refsect2"> @@ -889,8 +983,8 @@ 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"> +<a name="garrow-feather-file-reader-get-columns.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> @@ -905,25 +999,47 @@ garrow_feather_file_reader_get_columns <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> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> -<a name="id-1.4.3.2.13.20.5"></a><h4>Returns</h4> +<a name="garrow-feather-file-reader-get-columns.returns"></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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></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> +<a name="GARROW-TYPE-RECORD-BATCH-READER:CAPS"></a><h3>GARROW_TYPE_RECORD_BATCH_READER</h3> +<pre class="programlisting">#define GARROW_TYPE_RECORD_BATCH_READER (garrow_record_batch_reader_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchReaderClass"></a><h3>struct GArrowRecordBatchReaderClass</h3> +<pre class="programlisting">struct GArrowRecordBatchReaderClass { + GObjectClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-TYPE-TABLE-BATCH-READER:CAPS"></a><h3>GARROW_TYPE_TABLE_BATCH_READER</h3> +<pre class="programlisting">#define GARROW_TYPE_TABLE_BATCH_READER (garrow_table_batch_reader_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowTableBatchReaderClass"></a><h3>struct GArrowTableBatchReaderClass</h3> +<pre class="programlisting">struct GArrowTableBatchReaderClass { + GArrowRecordBatchReaderClass parent_class; +}; +</pre> </div> <hr> <div class="refsect2"> @@ -943,17 +1059,20 @@ garrow_feather_file_reader_get_columns <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> +<hr> <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> +<a name="GArrowRecordBatchReader-struct"></a><h3>GArrowRecordBatchReader</h3> +<pre class="programlisting">typedef struct _GArrowRecordBatchReader GArrowRecordBatchReader;</pre> </div> <hr> <div class="refsect2"> +<a name="GArrowTableBatchReader-struct"></a><h3>GArrowTableBatchReader</h3> +<pre class="programlisting">typedef struct _GArrowTableBatchReader GArrowTableBatchReader;</pre> +</div> +</div> +<div class="refsect1"> +<a name="reader-classes.property-details"></a><h2>Property Details</h2> +<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> @@ -966,10 +1085,16 @@ garrow_feather_file_reader_get_columns <p>The raw std::shared<arrow::ipc::feather::TableReader> *.</p> <p>Flags: Write / Construct Only</p> </div> +<hr> +<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> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/reader.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/reader.html b/docs/c_glib/reader.html index 8aa9269..f8d1703 100644 --- a/docs/c_glib/reader.html +++ b/docs/c_glib/reader.html @@ -2,17 +2,17 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Reader</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<title>Reader: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib 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="reader-classes.html" title="Reader classes"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <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="ipc.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -27,7 +27,6 @@ </dt></dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/right.png ---------------------------------------------------------------------- diff --git a/docs/c_glib/right.png b/docs/c_glib/right.png index 78f5875..4653997 100644 Binary files a/docs/c_glib/right.png and b/docs/c_glib/right.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/schema.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/schema.html b/docs/c_glib/schema.html index c01cf59..96ff6cb 100644 --- a/docs/c_glib/schema.html +++ b/docs/c_glib/schema.html @@ -2,17 +2,17 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Schema</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<title>Schema: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> <link rel="up" href="data.html" title="Part I. Data"> <link rel="prev" href="composite-data-type-classes.html" title="Composite data type classes"> <link rel="next" href="GArrowField.html" title="GArrowField"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <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="data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -32,7 +32,6 @@ </dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/style.css ---------------------------------------------------------------------- diff --git a/docs/c_glib/style.css b/docs/c_glib/style.css index 705a5c9..3675420 100644 --- a/docs/c_glib/style.css +++ b/docs/c_glib/style.css @@ -30,127 +30,6 @@ body vertical-align: top; } -@media screen { - sup a.footnote - { - position: relative; - top: 0em ! important; - } - /* this is needed so that the local anchors are displayed below the naviagtion */ - div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] - { - display: inline-block; - position: relative; - top:-5em; - } - /* this seems to be a bug in the xsl style sheets when generating indexes */ - div.index div.index - { - top: 0em; - } - /* make space for the fixed navigation bar and add space at the bottom so that - * link targets appear somewhat close to top - */ - body - { - padding-top: 5em; - padding-bottom: 500px; - max-width: 60em; - } - p - { - max-width: 60em; - } - /* style and size the navigation bar */ - table.navigation#top - { - position: fixed; - background: #e2e2e2; - border-bottom: solid 1px #babdb6; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - z-index: 10; - } - .navigation a, .navigation a:visited - { - /* tango:sky blue 3 */ - color: #204a87; - } - .navigation a:hover - { - /* tango:sky blue 2 */ - color: #3465a4; - } - td.shortcuts - { - /* tango:sky blue 2 */ - color: #3465a4; - font-size: 80%; - white-space: nowrap; - } - td.shortcuts .dim - { - color: #babdb6; - } -} -@media screen and (min-width: 60em) { - /* screen larger than 60em */ - body { margin: auto; } -} -@media screen and (max-width: 60em) { - /* screen less than 60em */ - #nav_hierarchy { display: none; } - #nav_interfaces { display: none; } - #nav_prerequisites { display: none; } - #nav_derived_interfaces { display: none; } - #nav_implementations { display: none; } - #nav_child_properties { display: none; } - #nav_style_properties { display: none; } - #nav_index { display: none; } - #nav_glossary { display: none; } - .gallery_image { display: none; } - .property_flags { display: none; } - .signal_flags { display: none; } - .parameter_annotations { display: none; } - .enum_member_annotations { display: none; } - .struct_member_annotations { display: none; } - .union_member_annotations { display: none; } - /* now that a column is hidden, optimize space */ - col.parameters_name { width: auto; } - col.parameters_description { width: auto; } - col.struct_members_name { width: auto; } - col.struct_members_description { width: auto; } - col.enum_members_name { width: auto; } - col.enum_members_description { width: auto; } - col.union_members_name { width: auto; } - col.union_members_description { width: auto; } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - background: #e2e2e2; - border: solid 1px #babdb6; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - } -} - -.navigation .title -{ - font-size: 120%; -} - div.gallery-float { float: left; @@ -181,7 +60,7 @@ a:hover div.informaltable table { border-collapse: separate; - border-spacing: 20px 3px; + border-spacing: 1em 0.3em; border: none; } @@ -239,6 +118,11 @@ div.informaltable table td, div.informaltable table th color: #729fcf; } +td p +{ + margin: 0.25em; +} + div.table table { border-collapse: collapse; @@ -264,6 +148,8 @@ div.table table th h4 { color: #555753; + margin-top: 1em; + margin-bottom: 1em; } hr @@ -282,17 +168,16 @@ dl.toc dt padding-bottom: 0.25em; } -dl.toc > dd > dl > dt +dl.toc > dt { padding-top: 0.25em; padding-bottom: 0.25em; + font-weight: bold; } -dl.toc > dt +dl.toc > dl { - padding-top: 1em; padding-bottom: 0.5em; - font-weight: bold; } .parameter @@ -404,21 +289,28 @@ h2 .extralinks, h3 .extralinks font-weight: normal; } +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + /* code listings */ -.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ -.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ -.listing_code .programlisting .function { color: #000000; font-weight: bold; } -.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ -.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .normal, +.listing_code .programlisting .normal a, +.listing_code .programlisting .number, +.listing_code .programlisting .cbracket, +.listing_code .programlisting .symbol { color: #555753; } +.listing_code .programlisting .comment, .listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ -.listing_code .programlisting .normal { color: #000000; } -.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .function, +.listing_code .programlisting .function a, .listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ -.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ -.listing_code .programlisting .type { color: #000000; } -.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ -.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ +.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */ +.listing_code .programlisting .keyword, +.listing_code .programlisting .usertype, +.listing_code .programlisting .type, +.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */ .listing_frame { /* tango:sky blue 1 */ @@ -433,11 +325,6 @@ h2 .extralinks, h3 .extralinks padding: 0.5em; } .listing_lines { - /* this just adds visual clutter and - takes precious room from small screens */ - display: none; -} -.listing_lines { /* tango:sky blue 0.5 */ background: #a6c5e3; background: rgba(114, 159, 207, 0.2); @@ -459,3 +346,134 @@ h2 .extralinks, h3 .extralinks margin: 0px; } +@media screen { + /* these have a <sup> as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} +
