http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/GArrowRecordBatch.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowRecordBatch.html b/docs/c_glib/GArrowRecordBatch.html deleted file mode 100644 index 130a925..0000000 --- a/docs/c_glib/GArrowRecordBatch.html +++ /dev/null @@ -1,639 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GArrowRecordBatch: 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="table.html" title="Table"> -<link rel="prev" href="GArrowTable.html" title="GArrowTable"> -<link rel="next" href="GArrowColumn.html" title="GArrowColumn"> -<meta name="generator" content="GTK-Doc V1.27 (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="#GArrowRecordBatch.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> - <a href="#GArrowRecordBatch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> - <a href="#GArrowRecordBatch.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="table.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="GArrowTable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="GArrowColumn.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="GArrowRecordBatch"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GArrowRecordBatch.top_of_page"></a>GArrowRecordBatch</span></h2> -<p>GArrowRecordBatch â Record batch class</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="GArrowRecordBatch.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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * -</td> -<td class="function_name"> -<a class="link" href="GArrowRecordBatch.html#garrow-record-batch-new" title="garrow_record_batch_new ()">garrow_record_batch_new</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="GArrowRecordBatch.html#garrow-record-batch-equal" title="garrow_record_batch_equal ()">garrow_record_batch_equal</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="GArrowRecordBatch.html#garrow-record-batch-get-schema" title="garrow_record_batch_get_schema ()">garrow_record_batch_get_schema</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * -</td> -<td class="function_name"> -<a class="link" href="GArrowRecordBatch.html#garrow-record-batch-get-column" title="garrow_record_batch_get_column ()">garrow_record_batch_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="GArrowRecordBatch.html#garrow-record-batch-get-columns" title="garrow_record_batch_get_columns ()">garrow_record_batch_get_columns</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * -</td> -<td class="function_name"> -<a class="link" href="GArrowRecordBatch.html#garrow-record-batch-get-column-name" title="garrow_record_batch_get_column_name ()">garrow_record_batch_get_column_name</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="GArrowRecordBatch.html#garrow-record-batch-get-n-columns" title="garrow_record_batch_get_n_columns ()">garrow_record_batch_get_n_columns</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="GArrowRecordBatch.html#garrow-record-batch-get-n-rows" title="garrow_record_batch_get_n_rows ()">garrow_record_batch_get_n_rows</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="GArrowRecordBatch.html#garrow-record-batch-slice" title="garrow_record_batch_slice ()">garrow_record_batch_slice</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="GArrowRecordBatch.html#garrow-record-batch-to-string" title="garrow_record_batch_to_string ()">garrow_record_batch_to_string</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="GArrowRecordBatch.html#garrow-record-batch-add-column" title="garrow_record_batch_add_column ()">garrow_record_batch_add_column</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="GArrowRecordBatch.html#garrow-record-batch-remove-column" title="garrow_record_batch_remove_column ()">garrow_record_batch_remove_column</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.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="GArrowRecordBatch.html#GArrowRecordBatch--record-batch" title="The ârecord-batchâ property">record-batch</a></td> -<td class="property_flags">Write / Construct Only</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.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="datatype_keyword">struct</td> -<td class="function_name"><a class="link" href="GArrowRecordBatch.html#GArrowRecordBatch-struct" title="struct GArrowRecordBatch">GArrowRecordBatch</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> - <span class="lineart">â°ââ</span> GArrowRecordBatch -</pre> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.description"></a><h2>Description</h2> -<p><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> is a class for record batch. Record batch is -similar to <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>. Record batch also has also zero or more -columns and zero or more records.</p> -<p>Record batch is used for shared memory IPC.</p> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="garrow-record-batch-new"></a><h3>garrow_record_batch_new ()</h3> -<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * -garrow_record_batch_new (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="guint32"><span class="type">guint32</span></GTKDOCLINK> n_rows</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> *columns</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-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>schema</p></td> -<td class="parameter_description"><p>The schema of the record batch.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>n_rows</p></td> -<td class="parameter_description"><p>The number of the rows in the record batch.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>columns</p></td> -<td class="parameter_description"><p>The columns in the record batch. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowArray]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-new.returns"></a><h4>Returns</h4> -<p>A newly created <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</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> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-equal"></a><h3>garrow_record_batch_equal ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> -garrow_record_batch_equal (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, - <em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *other_record_batch</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-record-batch-equal.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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>other_record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> to be compared.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-equal.returns"></a><h4>Returns</h4> -<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> -otherwise.</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-get-schema"></a><h3>garrow_record_batch_get_schema ()</h3> -<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * -garrow_record_batch_get_schema (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-record-batch-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-get-schema.returns"></a><h4>Returns</h4> -<p>The schema of the record batch. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-get-column"></a><h3>garrow_record_batch_get_column ()</h3> -<pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * -garrow_record_batch_get_column (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</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-record-batch-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</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. If it's negative, index is -counted backward from the end of the columns. <code class="literal">-1</code> means the last -column.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-get-column.returns"></a><h4>Returns</h4> -<p>The i-th column in the record batch -on success, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on out of index. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<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> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-get-columns"></a><h3>garrow_record_batch_get_columns ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * -garrow_record_batch_get_columns (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-record-batch-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-get-columns.returns"></a><h4>Returns</h4> -<p>The columns in the record batch. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowArray][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-get-column-name"></a><h3>garrow_record_batch_get_column_name ()</h3> -<pre class="programlisting">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * -garrow_record_batch_get_column_name (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</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-record-batch-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</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. If it's negative, index is -counted backward from the end of the columns. <code class="literal">-1</code> means the last -column.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-get-column-name.returns"></a><h4>Returns</h4> -<p>The name of the i-th column in the record batch -on success, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on out of index. </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> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-get-n-columns"></a><h3>garrow_record_batch_get_n_columns ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> -garrow_record_batch_get_n_columns (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-record-batch-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-get-n-columns.returns"></a><h4>Returns</h4> -<p> The number of columns in the record batch.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-get-n-rows"></a><h3>garrow_record_batch_get_n_rows ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> -garrow_record_batch_get_n_rows (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-record-batch-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-get-n-rows.returns"></a><h4>Returns</h4> -<p> The number of rows in the record batch.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-slice"></a><h3>garrow_record_batch_slice ()</h3> -<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * -garrow_record_batch_slice (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> offset</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> length</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-record-batch-slice.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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>offset</p></td> -<td class="parameter_description"><p>The offset of sub <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>The length of sub <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-record-batch-slice.returns"></a><h4>Returns</h4> -<p>The sub <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>. It covers -only from <code class="literal">offset</code> to <code class="literal">offset + length</code> range. The sub -<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> shares values with the base -<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-to-string"></a><h3>garrow_record_batch_to_string ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * -garrow_record_batch_to_string (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</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-to-string.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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</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 location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-to-string.returns"></a><h4>Returns</h4> -<p>The formatted record batch content or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error.</p> -<p> The returned string should be freed when 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-record-batch-add-column"></a><h3>garrow_record_batch_add_column ()</h3> -<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * -garrow_record_batch_add_column (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, - <em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>, - <em class="parameter"><code><a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *column</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-add-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</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 new column.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>field</p></td> -<td class="parameter_description"><p>The field to be added.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>column</p></td> -<td class="parameter_description"><p>The column to be added.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-add-column.returns"></a><h4>Returns</h4> -<p>The newly allocated -<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> that has a new column 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-9-0.html#api-index-0.9.0">0.9.0</a></p> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-record-batch-remove-column"></a><h3>garrow_record_batch_remove_column ()</h3> -<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * -garrow_record_batch_remove_column (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</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-remove-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>record_batch</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</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 new column.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-remove-column.returns"></a><h4>Returns</h4> -<p>The newly allocated -<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> that doesn't have the column 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-9-0.html#api-index-0.9.0">0.9.0</a></p> -</div> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="GArrowRecordBatch-struct"></a><h3>struct GArrowRecordBatch</h3> -<pre class="programlisting">struct GArrowRecordBatch;</pre> -<p>It wraps <code class="literal">arrow::RecordBatch</code>.</p> -</div> -</div> -<div class="refsect1"> -<a name="GArrowRecordBatch.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GArrowRecordBatch--record-batch"></a><h3>The <code class="literal">ârecord-batchâ</code> property</h3> -<pre class="programlisting"> ârecord-batchâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> -<p>The raw std::shared<arrow::RecordBatch> *.</p> -<p>Flags: Write / Construct Only</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.27</div> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/GArrowSchema.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowSchema.html b/docs/c_glib/GArrowSchema.html deleted file mode 100644 index 3a88caf..0000000 --- a/docs/c_glib/GArrowSchema.html +++ /dev/null @@ -1,556 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GArrowSchema: 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="schema.html" title="Schema"> -<link rel="prev" href="GArrowField.html" title="GArrowField"> -<link rel="next" href="table.html" title="Table"> -<meta name="generator" content="GTK-Doc V1.27 (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="#GArrowSchema.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> - <a href="#GArrowSchema.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> - <a href="#GArrowSchema.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="schema.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="GArrowField.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="table.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="GArrowSchema"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GArrowSchema.top_of_page"></a>GArrowSchema</span></h2> -<p>GArrowSchema â Schema class</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="GArrowSchema.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="GArrowSchema.html#garrow-schema-new" title="garrow_schema_new ()">garrow_schema_new</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="GArrowSchema.html#garrow-schema-equal" title="garrow_schema_equal ()">garrow_schema_equal</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * -</td> -<td class="function_name"> -<a class="link" href="GArrowSchema.html#garrow-schema-get-field" title="garrow_schema_get_field ()">garrow_schema_get_field</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * -</td> -<td class="function_name"> -<a class="link" href="GArrowSchema.html#garrow-schema-get-field-by-name" title="garrow_schema_get_field_by_name ()">garrow_schema_get_field_by_name</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="GArrowSchema.html#garrow-schema-n-fields" title="garrow_schema_n_fields ()">garrow_schema_n_fields</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="GArrowSchema.html#garrow-schema-get-fields" title="garrow_schema_get_fields ()">garrow_schema_get_fields</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="GArrowSchema.html#garrow-schema-to-string" title="garrow_schema_to_string ()">garrow_schema_to_string</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="GArrowSchema.html#garrow-schema-add-field" title="garrow_schema_add_field ()">garrow_schema_add_field</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="GArrowSchema.html#garrow-schema-remove-field" title="garrow_schema_remove_field ()">garrow_schema_remove_field</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="GArrowSchema.html#garrow-schema-replace-field" title="garrow_schema_replace_field ()">garrow_schema_replace_field</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowSchema.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="GArrowSchema.html#GArrowSchema--schema" title="The âschemaâ property">schema</a></td> -<td class="property_flags">Write / Construct Only</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowSchema.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="GArrowSchema.html#GARROW-TYPE-SCHEMA:CAPS" title="GARROW_TYPE_SCHEMA">GARROW_TYPE_SCHEMA</a></td> -</tr> -<tr> -<td class="datatype_keyword">struct</td> -<td class="function_name"><a class="link" href="GArrowSchema.html#GArrowSchemaClass" title="struct GArrowSchemaClass">GArrowSchemaClass</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="GArrowSchema.html#GArrowSchema-struct" title="GArrowSchema">GArrowSchema</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowSchema.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> - <span class="lineart">â°ââ</span> GArrowSchema -</pre> -</div> -<div class="refsect1"> -<a name="GArrowSchema.description"></a><h2>Description</h2> -<p><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> is a class for schema. Schema is metadata of a -table. It has zero or more <GTKDOCLINK HREF="GArrowFields"><span class="type">GArrowFields</span></GTKDOCLINK>.</p> -</div> -<div class="refsect1"> -<a name="GArrowSchema.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="garrow-schema-new"></a><h3>garrow_schema_new ()</h3> -<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * -garrow_schema_new (<em class="parameter"><code><GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> *fields</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-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>fields</p></td> -<td class="parameter_description"><p>The fields of the schema. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowField]</span></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-new.returns"></a><h4>Returns</h4> -<p> A newly created <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-equal"></a><h3>garrow_schema_equal ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> -garrow_schema_equal (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, - <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *other_schema</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-equal.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>other_schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> to be compared.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-equal.returns"></a><h4>Returns</h4> -<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> -otherwise.</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-schema-get-field"></a><h3>garrow_schema_get_field ()</h3> -<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * -garrow_schema_get_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-get-field.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-get-field.returns"></a><h4>Returns</h4> -<p>The i-th field of the schema. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-get-field-by-name"></a><h3>garrow_schema_get_field_by_name ()</h3> -<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * -garrow_schema_get_field_by_name (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, - <em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *name</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-get-field-by-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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>The name of the field to be found.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-get-field-by-name.returns"></a><h4>Returns</h4> -<p>The found field or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-n-fields"></a><h3>garrow_schema_n_fields ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> -garrow_schema_n_fields (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-n-fields.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-n-fields.returns"></a><h4>Returns</h4> -<p> The number of fields of the schema.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-get-fields"></a><h3>garrow_schema_get_fields ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * -garrow_schema_get_fields (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-get-fields.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-get-fields.returns"></a><h4>Returns</h4> -<p>The fields of the schema. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowField][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-to-string"></a><h3>garrow_schema_to_string ()</h3> -<pre class="programlisting"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * -garrow_schema_to_string (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre> -<div class="refsect3"> -<a name="garrow-schema-to-string.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="garrow-schema-to-string.returns"></a><h4>Returns</h4> -<p> The string representation of the schema.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-add-field"></a><h3>garrow_schema_add_field ()</h3> -<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * -garrow_schema_add_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, - <em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</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-schema-add-field.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 new field.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>field</p></td> -<td class="parameter_description"><p>The field to be added.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-schema-add-field.returns"></a><h4>Returns</h4> -<p>The newly allocated -<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that has a new field 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-10-0.html#api-index-0.10.0">0.10.0</a></p> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-remove-field"></a><h3>garrow_schema_remove_field ()</h3> -<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * -garrow_schema_remove_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</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-schema-remove-field.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field to be removed.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-schema-remove-field.returns"></a><h4>Returns</h4> -<p>The newly allocated -<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that doesn't have the field 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-10-0.html#api-index-0.10.0">0.10.0</a></p> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-schema-replace-field"></a><h3>garrow_schema_replace_field ()</h3> -<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * -garrow_schema_replace_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, - <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, - <em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</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-schema-replace-field.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>schema</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field to be replaced.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>field</p></td> -<td class="parameter_description"><p>The newly added <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</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 location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-schema-replace-field.returns"></a><h4>Returns</h4> -<p>The newly allocated -<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that has <em class="parameter"><code>field</code></em> -as the <em class="parameter"><code>i</code></em> --th field 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-10-0.html#api-index-0.10.0">0.10.0</a></p> -</div> -</div> -<div class="refsect1"> -<a name="GArrowSchema.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="GARROW-TYPE-SCHEMA:CAPS"></a><h3>GARROW_TYPE_SCHEMA</h3> -<pre class="programlisting">#define GARROW_TYPE_SCHEMA (garrow_schema_get_type()) -</pre> -</div> -<hr> -<div class="refsect2"> -<a name="GArrowSchemaClass"></a><h3>struct GArrowSchemaClass</h3> -<pre class="programlisting">struct GArrowSchemaClass { - GObjectClass parent_class; -}; -</pre> -</div> -<hr> -<div class="refsect2"> -<a name="GArrowSchema-struct"></a><h3>GArrowSchema</h3> -<pre class="programlisting">typedef struct _GArrowSchema GArrowSchema;</pre> -</div> -</div> -<div class="refsect1"> -<a name="GArrowSchema.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GArrowSchema--schema"></a><h3>The <code class="literal">âschemaâ</code> property</h3> -<pre class="programlisting"> âschemaâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> -<p>The raw std::shared<arrow::Schema> *.</p> -<p>Flags: Write / Construct Only</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.27</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/GArrowStreamReader.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowStreamReader.html b/docs/c_glib/GArrowStreamReader.html deleted file mode 100644 index ff9fa08..0000000 --- a/docs/c_glib/GArrowStreamReader.html +++ /dev/null @@ -1,230 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: GArrowStreamReader</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> -<link rel="up" href="reader.html" title="Reader"> -<link rel="prev" href="GArrowFileReader.html" title="GArrowFileReader"> -<link rel="next" href="writer.html" title="Writer"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"> -<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#GArrowStreamReader.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#GArrowStreamReader.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#GArrowStreamReader.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="GArrowFileReader.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="GArrowStreamReader"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GArrowStreamReader.top_of_page"></a>GArrowStreamReader</span></h2> -<p>GArrowStreamReader â Stream reader class</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="GArrowStreamReader.functions"></a><h2>Functions</h2> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="functions_return"> -<col class="functions_name"> -</colgroup> -<tbody> -<tr> -<td class="function_type"> -<a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="returnvalue">GArrowStreamReader</span></a> * -</td> -<td class="function_name"> -<a class="link" href="GArrowStreamReader.html#garrow-stream-reader-open" title="garrow_stream_reader_open ()">garrow_stream_reader_open</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="GArrowStreamReader.html#garrow-stream-reader-get-schema" title="garrow_stream_reader_get_schema ()">garrow_stream_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="GArrowStreamReader.html#garrow-stream-reader-get-next-record-batch" title="garrow_stream_reader_get_next_record_batch ()">garrow_stream_reader_get_next_record_batch</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.properties"></a><h2>Properties</h2> -<div class="informaltable"><table border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody><tr> -<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> -<td class="property_name"><a class="link" href="GArrowStreamReader.html#GArrowStreamReader--stream-reader" title="The âstream-readerâ property">stream-reader</a></td> -<td class="property_flags">Write / Construct Only</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="name"> -<col class="description"> -</colgroup> -<tbody><tr> -<td class="datatype_keyword">struct</td> -<td class="function_name"><a class="link" href="GArrowStreamReader.html#GArrowStreamReader-struct" title="struct GArrowStreamReader">GArrowStreamReader</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> - <span class="lineart">â°ââ</span> GArrowStreamReader -</pre> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.description"></a><h2>Description</h2> -<p><a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="type">GArrowStreamReader</span></a> is a class for receiving data by stream -based IPC.</p> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="garrow-stream-reader-open"></a><h3>garrow_stream_reader_open ()</h3> -<pre class="programlisting"><a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="returnvalue">GArrowStreamReader</span></a> * -garrow_stream_reader_open (<em class="parameter"><code><a class="link" href="GArrowInputStream.html" title="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.3.8.2.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>stream</p></td> -<td class="parameter_description"><p>The stream to be read.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.4.3.3.8.2.5"></a><h4>Returns</h4> -<p> A newly opened -<a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="type">GArrowStreamReader</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> -<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-stream-reader-get-schema"></a><h3>garrow_stream_reader_get_schema ()</h3> -<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * -garrow_stream_reader_get_schema (<em class="parameter"><code><a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="type">GArrowStreamReader</span></a> *stream_reader</code></em>);</pre> -<div class="refsect3"> -<a name="id-1.4.3.3.8.3.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>stream_reader</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="type">GArrowStreamReader</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.4.3.3.8.3.5"></a><h4>Returns</h4> -<p> The schema in the stream. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="garrow-stream-reader-get-next-record-batch"></a><h3>garrow_stream_reader_get_next_record_batch ()</h3> -<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * -garrow_stream_reader_get_next_record_batch - (<em class="parameter"><code><a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="type">GArrowStreamReader</span></a> *stream_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.3.8.4.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>stream_reader</p></td> -<td class="parameter_description"><p>A <a class="link" href="GArrowStreamReader.html" title="GArrowStreamReader"><span class="type">GArrowStreamReader</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> -<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.4.3.3.8.4.5"></a><h4>Returns</h4> -<p> The next record batch in the stream or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on end of stream. </p> -<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="GArrowStreamReader-struct"></a><h3>struct GArrowStreamReader</h3> -<pre class="programlisting">struct GArrowStreamReader;</pre> -<p>It wraps <code class="literal">arrow::ipc::StreamReader</code>.</p> -</div> -</div> -<div class="refsect1"> -<a name="GArrowStreamReader.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GArrowStreamReader--stream-reader"></a><h3>The <code class="literal">âstream-readerâ</code> property</h3> -<pre class="programlisting"> âstream-readerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> -<p>The raw std::shared<arrow::ipc::StreamReader> *.</p> -<p>Flags: Write / Construct Only</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> -</body> -</html>
