http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/reader-classes.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/reader-classes.html b/build/docs/c_glib/reader-classes.html new file mode 100644 index 0000000..6cc65fb --- /dev/null +++ b/build/docs/c_glib/reader-classes.html @@ -0,0 +1,1100 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<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.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="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="#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 class="informaltable" 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="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"> +<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 class="informaltable" 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#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> +<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> +</tbody> +</table></div> +</div> +<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 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#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> +<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> +<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> +<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> GArrowRecordBatchReader + <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"> +<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="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"> +<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="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: <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"> +<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" 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-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"> +<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-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">[<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-4-0.html#api-index-0.4.0">0.4.0</a></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="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="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"> +<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.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-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"> +<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="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"> +<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">[<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-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">[<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: <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"> +<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="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"> +<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">[<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-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">[<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: <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"> +<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="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"> +<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="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: <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"> +<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="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"> +<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="garrow-record-batch-file-reader-get-n-record-batches.returns"></a><h4>Returns</h4> +<p> The number of record batches in the file.</p> +</div> +<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"> +<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="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"> +<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="garrow-record-batch-file-reader-get-version.returns"></a><h4>Returns</h4> +<p> The format version in the file.</p> +</div> +<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"> +<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="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"> +<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">[<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-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">[<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-4-0.html#api-index-0.4.0">0.4.0</a></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="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"> +<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">[<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-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">[<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-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="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"> +<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">[<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-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">[<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: <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"> +<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="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"> +<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="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">[<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: <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"> +<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="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"> +<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="garrow-feather-file-reader-has-description.returns"></a><h4>Returns</h4> +<p> Whether the file has description or not.</p> +</div> +<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"> +<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="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"> +<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="garrow-feather-file-reader-get-version.returns"></a><h4>Returns</h4> +<p> The format version of the file.</p> +</div> +<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"> +<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="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"> +<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="garrow-feather-file-reader-get-n-rows.returns"></a><h4>Returns</h4> +<p> The number of rows in the file.</p> +</div> +<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"> +<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="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"> +<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="garrow-feather-file-reader-get-n-columns.returns"></a><h4>Returns</h4> +<p> The number of columns in the file.</p> +</div> +<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"> +<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="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"> +<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="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> +</div> +<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"> +<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="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"> +<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">[<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-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">[<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-4-0.html#api-index-0.4.0">0.4.0</a></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="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"> +<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">[<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-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: <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="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"> +<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> +<hr> +<div class="refsect2"> +<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> +<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> +<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.25</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/reader.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/reader.html b/build/docs/c_glib/reader.html new file mode 100644 index 0000000..f8d1703 --- /dev/null +++ b/build/docs/c_glib/reader.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<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.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="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> +<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="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="reader-classes.html">Reader classes</a></span><span class="refpurpose"></span> +</dt></dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/right-insensitive.png ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/right-insensitive.png b/build/docs/c_glib/right-insensitive.png new file mode 100644 index 0000000..f999f00 Binary files /dev/null and b/build/docs/c_glib/right-insensitive.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/right.png ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/right.png b/build/docs/c_glib/right.png new file mode 100644 index 0000000..4653997 Binary files /dev/null and b/build/docs/c_glib/right.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/schema.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/schema.html b/build/docs/c_glib/schema.html new file mode 100644 index 0000000..96ff6cb --- /dev/null +++ b/build/docs/c_glib/schema.html @@ -0,0 +1,37 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<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.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="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> +<td><a accesskey="p" href="composite-data-type-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowField.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="schema"></a>Schema</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="GArrowField.html">GArrowField</a></span><span class="refpurpose"> â Field class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GArrowSchema.html">GArrowSchema</a></span><span class="refpurpose"> â Schema class</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/style.css ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/style.css b/build/docs/c_glib/style.css new file mode 100644 index 0000000..3675420 --- /dev/null +++ b/build/docs/c_glib/style.css @@ -0,0 +1,479 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ + background: #e6f3ff; + border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + background: rgba(252, 175, 62, 0.1); + border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); + border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); +} +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note p, .warning p +{ + margin: 0; +} + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-weight: normal; +} + +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + +/* code listings */ + +.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 .function, +.listing_code .programlisting .function a, +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 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 */ + border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; + background: none; +} +.listing_lines pre, .listing_code pre { + 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; + } +} +
