http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/buffer-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/buffer-classes.html b/docs/c_glib/arrow-glib/buffer-classes.html new file mode 100644 index 0000000..631c352 --- /dev/null +++ b/docs/c_glib/arrow-glib/buffer-classes.html @@ -0,0 +1,976 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Buffer 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="buffer.html" title="Buffer"> +<link rel="prev" href="buffer.html" title="Buffer"> +<link rel="next" href="error.html" title="Error"> +<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="#buffer-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#buffer-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#buffer-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="buffer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="buffer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="error.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="buffer-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="buffer-classes.top_of_page"></a>Buffer classes</span></h2> +<p>Buffer classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="buffer-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="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-new" title="garrow_buffer_new ()">garrow_buffer_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-new-bytes" title="garrow_buffer_new_bytes ()">garrow_buffer_new_bytes</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="buffer-classes.html#garrow-buffer-equal" title="garrow_buffer_equal ()">garrow_buffer_equal</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="buffer-classes.html#garrow-buffer-equal-n-bytes" title="garrow_buffer_equal_n_bytes ()">garrow_buffer_equal_n_bytes</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="buffer-classes.html#garrow-buffer-is-mutable" title="garrow_buffer_is_mutable ()">garrow_buffer_is_mutable</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="buffer-classes.html#garrow-buffer-get-capacity" title="garrow_buffer_get_capacity ()">garrow_buffer_get_capacity</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="GBytes"><span class="returnvalue">GBytes</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-get-data" title="garrow_buffer_get_data ()">garrow_buffer_get_data</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="GBytes"><span class="returnvalue">GBytes</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-get-mutable-data" title="garrow_buffer_get_mutable_data ()">garrow_buffer_get_mutable_data</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="buffer-classes.html#garrow-buffer-get-size" title="garrow_buffer_get_size ()">garrow_buffer_get_size</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-get-parent" title="garrow_buffer_get_parent ()">garrow_buffer_get_parent</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-copy" title="garrow_buffer_copy ()">garrow_buffer_copy</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-buffer-slice" title="garrow_buffer_slice ()">garrow_buffer_slice</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="returnvalue">GArrowMutableBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-mutable-buffer-new" title="garrow_mutable_buffer_new ()">garrow_mutable_buffer_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="returnvalue">GArrowMutableBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-mutable-buffer-new-bytes" title="garrow_mutable_buffer_new_bytes ()">garrow_mutable_buffer_new_bytes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="returnvalue">GArrowMutableBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-mutable-buffer-slice" title="garrow_mutable_buffer_slice ()">garrow_mutable_buffer_slice</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="returnvalue">GArrowResizableBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="buffer-classes.html#garrow-resizable-buffer-new" title="garrow_resizable_buffer_new ()">garrow_resizable_buffer_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="buffer-classes.html#garrow-resizable-buffer-resize" title="garrow_resizable_buffer_resize ()">garrow_resizable_buffer_resize</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="buffer-classes.html#garrow-resizable-buffer-reserve" title="garrow_resizable_buffer_reserve ()">garrow_resizable_buffer_reserve</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="buffer-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="buffer-classes.html#GArrowBuffer--buffer" title="The âbufferâ property">buffer</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"> +<GTKDOCLINK HREF="GBytes"><span class="type">GBytes</span></GTKDOCLINK> *</td> +<td class="property_name"><a class="link" href="buffer-classes.html#GArrowBuffer--data" title="The âdataâ property">data</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<a name="GArrowBuffer"></a><a name="GArrowMutableBuffer"></a><a name="GArrowResizableBuffer"></a><div class="refsect1"> +<a name="buffer-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="buffer-classes.html#GARROW-TYPE-BUFFER:CAPS" title="GARROW_TYPE_BUFFER">GARROW_TYPE_BUFFER</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="buffer-classes.html#GArrowBufferClass" title="struct GArrowBufferClass">GArrowBufferClass</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="buffer-classes.html#GARROW-TYPE-MUTABLE-BUFFER:CAPS" title="GARROW_TYPE_MUTABLE_BUFFER">GARROW_TYPE_MUTABLE_BUFFER</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="buffer-classes.html#GArrowMutableBufferClass" title="struct GArrowMutableBufferClass">GArrowMutableBufferClass</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="buffer-classes.html#GARROW-TYPE-RESIZABLE-BUFFER:CAPS" title="GARROW_TYPE_RESIZABLE_BUFFER">GARROW_TYPE_RESIZABLE_BUFFER</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="buffer-classes.html#GArrowResizableBufferClass" title="struct GArrowResizableBufferClass">GArrowResizableBufferClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="buffer-classes.html#GArrowBuffer-struct" title="GArrowBuffer">GArrowBuffer</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="buffer-classes.html#GArrowMutableBuffer-struct" title="GArrowMutableBuffer">GArrowMutableBuffer</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="buffer-classes.html#GArrowResizableBuffer-struct" title="GArrowResizableBuffer">GArrowResizableBuffer</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="buffer-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowBuffer + <span class="lineart">â°ââ</span> GArrowMutableBuffer + <span class="lineart">â°ââ</span> GArrowResizableBuffer +</pre> +</div> +<div class="refsect1"> +<a name="buffer-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="buffer-classes.description"></a><h2>Description</h2> +<p><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> is a class for keeping data. Other classes such as +<a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> and <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> can use data in buffer.</p> +<p><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> is immutable.</p> +<p><a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a> is mutable.</p> +<p><a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a> is mutable and resizable.</p> +</div> +<div class="refsect1"> +<a name="buffer-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-buffer-new"></a><h3>garrow_buffer_new ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_buffer_new (<em class="parameter"><code>const <GTKDOCLINK HREF="guint8"><span class="type">guint8</span></GTKDOCLINK> *data</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> size</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-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>data</p></td> +<td class="parameter_description"><p>Data for the buffer. +They aren't owned by the new buffer. +You must not free the data while the new buffer is alive. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>The number of bytes of the data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-new-bytes"></a><h3>garrow_buffer_new_bytes ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_buffer_new_bytes (<em class="parameter"><code><GTKDOCLINK HREF="GBytes"><span class="type">GBytes</span></GTKDOCLINK> *data</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-new-bytes.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>data</p></td> +<td class="parameter_description"><p>Data for the buffer.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-new-bytes.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</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-buffer-equal"></a><h3>garrow_buffer_equal ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_buffer_equal (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>, + <em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *other_buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>other_buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> to be compared.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-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-buffer-equal-n-bytes"></a><h3>garrow_buffer_equal_n_bytes ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_buffer_equal_n_bytes (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>, + <em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *other_buffer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_bytes</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-equal-n-bytes.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>other_buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> to be compared.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of first bytes to be compared.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-equal-n-bytes.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data in the first +<code class="literal">n_bytes</code>, <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-buffer-is-mutable"></a><h3>garrow_buffer_is_mutable ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_buffer_is_mutable (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-is-mutable.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-is-mutable.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if the buffer is mutable, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-get-capacity"></a><h3>garrow_buffer_get_capacity ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_buffer_get_capacity (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-get-capacity.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-get-capacity.returns"></a><h4>Returns</h4> +<p> The number of bytes that where allocated for the buffer in +total.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-get-data"></a><h3>garrow_buffer_get_data ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GBytes"><span class="returnvalue">GBytes</span></GTKDOCLINK> * +garrow_buffer_get_data (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-get-data.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-get-data.returns"></a><h4>Returns</h4> +<p>The data of the buffer. The data is owned by +the buffer. You should not free or modify the data. </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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-get-mutable-data"></a><h3>garrow_buffer_get_mutable_data ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GBytes"><span class="returnvalue">GBytes</span></GTKDOCLINK> * +garrow_buffer_get_mutable_data (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-get-mutable-data.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-get-mutable-data.returns"></a><h4>Returns</h4> +<p>The data of the buffer. If the +buffer is imutable, it returns <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. The data is owned by the +buffer. You should not free the data. </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> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-get-size"></a><h3>garrow_buffer_get_size ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_buffer_get_size (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-get-size.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-get-size.returns"></a><h4>Returns</h4> +<p> The number of bytes that might have valid data.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-get-parent"></a><h3>garrow_buffer_get_parent ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_buffer_get_parent (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-get-parent.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-get-parent.returns"></a><h4>Returns</h4> +<p>The parent <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-copy"></a><h3>garrow_buffer_copy ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_buffer_copy (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> start</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> size</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-buffer-copy.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>start</p></td> +<td class="parameter_description"><p>An offset of data to be copied in byte.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>The number of bytes to be copied from the start.</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-buffer-copy.returns"></a><h4>Returns</h4> +<p>A newly copied <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> on success, <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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-slice"></a><h3>garrow_buffer_slice ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_buffer_slice (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *buffer</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> size</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>offset</p></td> +<td class="parameter_description"><p>An offset in the buffer data in byte.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>The number of bytes of the sliced data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-slice.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> that shares +data of the base <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>. The created <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> has data +start with offset from the base buffer data and are the specified +bytes size. </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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-mutable-buffer-new"></a><h3>garrow_mutable_buffer_new ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="returnvalue">GArrowMutableBuffer</span></a> * +garrow_mutable_buffer_new (<em class="parameter"><code><GTKDOCLINK HREF="guint8"><span class="type">guint8</span></GTKDOCLINK> *data</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> size</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-mutable-buffer-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>data</p></td> +<td class="parameter_description"><p>Data for the buffer. +They aren't owned by the new buffer. +You must not free the data while the new buffer is alive. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>The number of bytes of the data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-mutable-buffer-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-mutable-buffer-new-bytes"></a><h3>garrow_mutable_buffer_new_bytes ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="returnvalue">GArrowMutableBuffer</span></a> * +garrow_mutable_buffer_new_bytes (<em class="parameter"><code><GTKDOCLINK HREF="GBytes"><span class="type">GBytes</span></GTKDOCLINK> *data</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-mutable-buffer-new-bytes.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>data</p></td> +<td class="parameter_description"><p>Data for the buffer.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-mutable-buffer-new-bytes.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a>.</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-mutable-buffer-slice"></a><h3>garrow_mutable_buffer_slice ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="returnvalue">GArrowMutableBuffer</span></a> * +garrow_mutable_buffer_slice (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a> *buffer</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> size</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-mutable-buffer-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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>offset</p></td> +<td class="parameter_description"><p>An offset in the buffer data in byte.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>The number of bytes of the sliced data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-mutable-buffer-slice.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a> that +shares data of the base <a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a>. The created +<a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a> has data start with offset from the base +buffer data and are the specified bytes size. </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-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-resizable-buffer-new"></a><h3>garrow_resizable_buffer_new ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="returnvalue">GArrowResizableBuffer</span></a> * +garrow_resizable_buffer_new (<em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> initial_size</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-resizable-buffer-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>initial_size</p></td> +<td class="parameter_description"><p>The initial buffer size in bytes.</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-resizable-buffer-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a>. </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-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-resizable-buffer-resize"></a><h3>garrow_resizable_buffer_resize ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_resizable_buffer_resize (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a> *buffer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> new_size</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-resizable-buffer-resize.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>new_size</p></td> +<td class="parameter_description"><p>The new buffer size in bytes.</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-resizable-buffer-resize.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> if there was an error.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-resizable-buffer-reserve"></a><h3>garrow_resizable_buffer_reserve ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_resizable_buffer_reserve (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a> *buffer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> new_capacity</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-resizable-buffer-reserve.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>buffer</p></td> +<td class="parameter_description"><p>A <a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>new_capacity</p></td> +<td class="parameter_description"><p>The new buffer capacity in bytes.</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-resizable-buffer-reserve.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> if there was an error.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-3-0.html#api-index-0.3.0">0.3.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="buffer-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GARROW-TYPE-BUFFER:CAPS"></a><h3>GARROW_TYPE_BUFFER</h3> +<pre class="programlisting">#define GARROW_TYPE_BUFFER (garrow_buffer_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowBufferClass"></a><h3>struct GArrowBufferClass</h3> +<pre class="programlisting">struct GArrowBufferClass { + GObjectClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-TYPE-MUTABLE-BUFFER:CAPS"></a><h3>GARROW_TYPE_MUTABLE_BUFFER</h3> +<pre class="programlisting">#define GARROW_TYPE_MUTABLE_BUFFER (garrow_mutable_buffer_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowMutableBufferClass"></a><h3>struct GArrowMutableBufferClass</h3> +<pre class="programlisting">struct GArrowMutableBufferClass { + GArrowBufferClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-TYPE-RESIZABLE-BUFFER:CAPS"></a><h3>GARROW_TYPE_RESIZABLE_BUFFER</h3> +<pre class="programlisting">#define GARROW_TYPE_RESIZABLE_BUFFER (garrow_resizable_buffer_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowResizableBufferClass"></a><h3>struct GArrowResizableBufferClass</h3> +<pre class="programlisting">struct GArrowResizableBufferClass { + GArrowMutableBufferClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowBuffer-struct"></a><h3>GArrowBuffer</h3> +<pre class="programlisting">typedef struct _GArrowBuffer GArrowBuffer;</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowMutableBuffer-struct"></a><h3>GArrowMutableBuffer</h3> +<pre class="programlisting">typedef struct _GArrowMutableBuffer GArrowMutableBuffer;</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowResizableBuffer-struct"></a><h3>GArrowResizableBuffer</h3> +<pre class="programlisting">typedef struct _GArrowResizableBuffer GArrowResizableBuffer;</pre> +</div> +</div> +<div class="refsect1"> +<a name="buffer-classes.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowBuffer--buffer"></a><h3>The <code class="literal">âbufferâ</code> property</h3> +<pre class="programlisting"> âbufferâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::Buffer> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowBuffer--data"></a><h3>The <code class="literal">âdataâ</code> property</h3> +<pre class="programlisting"> âdataâ <GTKDOCLINK HREF="GBytes"><span class="type">GBytes</span></GTKDOCLINK> *</pre> +<p>The raw data passed as GBytes *.</p> +<p>Flags: Read / 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/arrow-glib/buffer.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/buffer.html b/docs/c_glib/arrow-glib/buffer.html new file mode 100644 index 0000000..ff3d3e3 --- /dev/null +++ b/docs/c_glib/arrow-glib/buffer.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>Buffer: 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="table-builder-classes.html" title="Table builder classes"> +<link rel="next" href="buffer-classes.html" title="Buffer classes"> +<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"></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="table-builder-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="buffer-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="buffer"></a>Buffer</h2></div></div></div> +<div class="toc"><dl class="toc"><dt> +<span class="refentrytitle"><a href="buffer-classes.html">Buffer classes</a></span><span class="refpurpose"></span> +</dt></dl></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/arrow-glib/composite-array-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/composite-array-classes.html b/docs/c_glib/arrow-glib/composite-array-classes.html new file mode 100644 index 0000000..d4f6635 --- /dev/null +++ b/docs/c_glib/arrow-glib/composite-array-classes.html @@ -0,0 +1,626 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Composite array 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="array.html" title="Array"> +<link rel="prev" href="basic-array-classes.html" title="Basic array classes"> +<link rel="next" href="array-builder.html" title="Array builder"> +<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="#composite-array-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#composite-array-classes.object-hierarchy" class="shortcut">Object Hierarchy</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="array.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="basic-array-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="array-builder.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="composite-array-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="composite-array-classes.top_of_page"></a>Composite array classes</span></h2> +<p>Composite array classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="composite-array-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="composite-array-classes.html#GArrowListArray"><span class="returnvalue">GArrowListArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="composite-array-classes.html#garrow-list-array-new" title="garrow_list_array_new ()">garrow_list_array_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +</td> +<td class="function_name"> +<a class="link" href="composite-array-classes.html#garrow-list-array-get-value-type" title="garrow_list_array_get_value_type ()">garrow_list_array_get_value_type</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="composite-array-classes.html#garrow-list-array-get-value" title="garrow_list_array_get_value ()">garrow_list_array_get_value</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="returnvalue">GArrowStructArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="composite-array-classes.html#garrow-struct-array-new" title="garrow_struct_array_new ()">garrow_struct_array_new</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="composite-array-classes.html#garrow-struct-array-get-field" title="garrow_struct_array_get_field ()">garrow_struct_array_get_field</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="composite-array-classes.html#garrow-struct-array-get-fields" title="garrow_struct_array_get_fields ()">garrow_struct_array_get_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="composite-array-classes.html#garrow-struct-array-flatten" title="garrow_struct_array_flatten ()">garrow_struct_array_flatten</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="returnvalue">GArrowDictionaryArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="composite-array-classes.html#garrow-dictionary-array-new" title="garrow_dictionary_array_new ()">garrow_dictionary_array_new</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="composite-array-classes.html#garrow-dictionary-array-get-indices" title="garrow_dictionary_array_get_indices ()">garrow_dictionary_array_get_indices</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="composite-array-classes.html#garrow-dictionary-array-get-dictionary" title="garrow_dictionary_array_get_dictionary ()">garrow_dictionary_array_get_dictionary</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="composite-data-type-classes.html#GArrowDictionaryDataType"><span class="returnvalue">GArrowDictionaryDataType</span></a> * +</td> +<td class="function_name"> +<a class="link" href="composite-array-classes.html#garrow-dictionary-array-get-dictionary-data-type" title="garrow_dictionary_array_get_dictionary_data_type ()">garrow_dictionary_array_get_dictionary_data_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<a name="GArrowListArray"></a><a name="GArrowStructArray"></a><a name="GArrowDictionaryArray"></a><div class="refsect1"> +<a name="composite-array-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="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="composite-array-classes.html#GArrowListArray-struct" title="struct GArrowListArray">GArrowListArray</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="composite-array-classes.html#GArrowStructArray-struct" title="struct GArrowStructArray">GArrowStructArray</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="composite-array-classes.html#GARROW-TYPE-DICTIONARY-ARRAY:CAPS" title="GARROW_TYPE_DICTIONARY_ARRAY">GARROW_TYPE_DICTIONARY_ARRAY</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="composite-array-classes.html#GArrowDictionaryArrayClass" title="struct GArrowDictionaryArrayClass">GArrowDictionaryArrayClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="composite-array-classes.html#GArrowDictionaryArray-struct" title="GArrowDictionaryArray">GArrowDictionaryArray</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="composite-array-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> <a class="link" href="basic-array-classes.html#GArrowArray">GArrowArray</a> + <span class="lineart">âââ</span> GArrowDictionaryArray + <span class="lineart">âââ</span> GArrowListArray + <span class="lineart">â°ââ</span> GArrowStructArray +</pre> +</div> +<div class="refsect1"> +<a name="composite-array-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="composite-array-classes.description"></a><h2>Description</h2> +<p><a class="link" href="composite-array-classes.html#GArrowListArray"><span class="type">GArrowListArray</span></a> is a class for list array. It can store zero or +more list data. If you don't have Arrow format data, you need to +use <a class="link" href="array-builder-classes.html#GArrowListArrayBuilder"><span class="type">GArrowListArrayBuilder</span></a> to create a new array.</p> +<p><a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</span></a> is a class for struct array. It can store zero +or more structs. One struct has zero or more fields. If you don't +have Arrow format data, you need to use <a class="link" href="array-builder-classes.html#GArrowStructArrayBuilder"><span class="type">GArrowStructArrayBuilder</span></a> +to create a new array.</p> +<p><a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a> is a class for dictionary array. It can +store data with dictionary and indices. It's space effective than +normal array when the array has many same values. You can convert a +normal array to dictionary array by <a class="link" href="basic-array-classes.html#garrow-array-dictionary-encode" title="garrow_array_dictionary_encode ()"><code class="function">garrow_array_dictionary_encode()</code></a>.</p> +</div> +<div class="refsect1"> +<a name="composite-array-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-list-array-new"></a><h3>garrow_list_array_new ()</h3> +<pre class="programlisting"><a class="link" href="composite-array-classes.html#GArrowListArray"><span class="returnvalue">GArrowListArray</span></a> * +garrow_list_array_new (<em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> length</code></em>, + <em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *value_offsets</code></em>, + <em class="parameter"><code><a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *values</code></em>, + <em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *null_bitmap</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_nulls</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-list-array-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>length</p></td> +<td class="parameter_description"><p>The number of elements.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>value_offsets</p></td> +<td class="parameter_description"><p>The offsets of <em class="parameter"><code>values</code></em> +in Arrow format.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>values</p></td> +<td class="parameter_description"><p>The values as <a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>null_bitmap</p></td> +<td class="parameter_description"><p>The bitmap that shows null elements. The +N-th element is null when the N-th bit is 0, not null otherwise. +If the array has no null elements, the bitmap must be <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> and +<em class="parameter"><code>n_nulls</code></em> +is 0. </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> +<tr> +<td class="parameter_name"><p>n_nulls</p></td> +<td class="parameter_description"><p>The number of null elements. If -1 is specified, the +number of nulls are computed from <em class="parameter"><code>null_bitmap</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-list-array-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="composite-array-classes.html#GArrowListArray"><span class="type">GArrowListArray</span></a>.</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-list-array-get-value-type"></a><h3>garrow_list_array_get_value_type ()</h3> +<pre class="programlisting"><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +garrow_list_array_get_value_type (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowListArray"><span class="type">GArrowListArray</span></a> *array</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-list-array-get-value-type.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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowListArray"><span class="type">GArrowListArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-list-array-get-value-type.returns"></a><h4>Returns</h4> +<p>The data type of value in each list. </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-list-array-get-value"></a><h3>garrow_list_array_get_value ()</h3> +<pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +garrow_list_array_get_value (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowListArray"><span class="type">GArrowListArray</span></a> *array</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> i</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-list-array-get-value.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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowListArray"><span class="type">GArrowListArray</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 value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-list-array-get-value.returns"></a><h4>Returns</h4> +<p>The i-th list. </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-struct-array-new"></a><h3>garrow_struct_array_new ()</h3> +<pre class="programlisting"><a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="returnvalue">GArrowStructArray</span></a> * +garrow_struct_array_new (<em class="parameter"><code><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> length</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> *children</code></em>, + <em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> *null_bitmap</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_nulls</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-struct-array-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>data_type</p></td> +<td class="parameter_description"><p>The data type of the struct.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>length</p></td> +<td class="parameter_description"><p>The number of elements.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>children</p></td> +<td class="parameter_description"><p>The arrays for each field +as <GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> of <a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a>. </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>null_bitmap</p></td> +<td class="parameter_description"><p>The bitmap that shows null elements. The +N-th element is null when the N-th bit is 0, not null otherwise. +If the array has no null elements, the bitmap must be <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> and +<em class="parameter"><code>n_nulls</code></em> +is 0. </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> +<tr> +<td class="parameter_name"><p>n_nulls</p></td> +<td class="parameter_description"><p>The number of null elements. If -1 is specified, the +number of nulls are computed from <em class="parameter"><code>null_bitmap</code></em> +.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-struct-array-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</span></a>.</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-struct-array-get-field"></a><h3>garrow_struct_array_get_field ()</h3> +<pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +garrow_struct_array_get_field (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</span></a> *array</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-struct-array-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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</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 in the struct.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-struct-array-get-field.returns"></a><h4>Returns</h4> +<p>The i-th field. </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-struct-array-get-fields"></a><h3>garrow_struct_array_get_fields ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +garrow_struct_array_get_fields (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</span></a> *array</code></em>);</pre> +<div class="warning"> +<p><code class="literal">garrow_struct_array_get_fields</code> has been deprecated since version 0.10.0. and should not be used in newly-written code.</p> +<p>Use <a class="link" href="composite-array-classes.html#garrow-struct-array-flatten" title="garrow_struct_array_flatten ()"><code class="function">garrow_struct_array_flatten()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="garrow-struct-array-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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-struct-array-get-fields.returns"></a><h4>Returns</h4> +<p>The fields in the struct. </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-struct-array-flatten"></a><h3>garrow_struct_array_flatten ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +garrow_struct_array_flatten (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</span></a> *array</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-struct-array-flatten.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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowStructArray"><span class="type">GArrowStructArray</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-struct-array-flatten.returns"></a><h4>Returns</h4> +<p>The fields in the struct. </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> +<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-dictionary-array-new"></a><h3>garrow_dictionary_array_new ()</h3> +<pre class="programlisting"><a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="returnvalue">GArrowDictionaryArray</span></a> * +garrow_dictionary_array_new (<em class="parameter"><code><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>, + <em class="parameter"><code><a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *indices</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-dictionary-array-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>data_type</p></td> +<td class="parameter_description"><p>The data type of dictionary.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>indices</p></td> +<td class="parameter_description"><p>The indices of values in dictionary.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-dictionary-array-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</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-dictionary-array-get-indices"></a><h3>garrow_dictionary_array_get_indices ()</h3> +<pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +garrow_dictionary_array_get_indices (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a> *array</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-dictionary-array-get-indices.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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-dictionary-array-get-indices.returns"></a><h4>Returns</h4> +<p>The indices of values in dictionary. </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-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-dictionary-array-get-dictionary"></a><h3>garrow_dictionary_array_get_dictionary ()</h3> +<pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +garrow_dictionary_array_get_dictionary + (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a> *array</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-dictionary-array-get-dictionary.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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-dictionary-array-get-dictionary.returns"></a><h4>Returns</h4> +<p>The dictionary of this array. </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-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-dictionary-array-get-dictionary-data-type"></a><h3>garrow_dictionary_array_get_dictionary_data_type ()</h3> +<pre class="programlisting"><a class="link" href="composite-data-type-classes.html#GArrowDictionaryDataType"><span class="returnvalue">GArrowDictionaryDataType</span></a> * +garrow_dictionary_array_get_dictionary_data_type + (<em class="parameter"><code><a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a> *array</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-dictionary-array-get-dictionary-data-type.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>array</p></td> +<td class="parameter_description"><p>A <a class="link" href="composite-array-classes.html#GArrowDictionaryArray"><span class="type">GArrowDictionaryArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-dictionary-array-get-dictionary-data-type.returns"></a><h4>Returns</h4> +<p>The dictionary data type of this array. </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-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="composite-array-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowListArray-struct"></a><h3>struct GArrowListArray</h3> +<pre class="programlisting">struct GArrowListArray;</pre> +<p>It wraps <code class="literal">arrow::ListArray</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowStructArray-struct"></a><h3>struct GArrowStructArray</h3> +<pre class="programlisting">struct GArrowStructArray;</pre> +<p>It wraps <code class="literal">arrow::StructArray</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-TYPE-DICTIONARY-ARRAY:CAPS"></a><h3>GARROW_TYPE_DICTIONARY_ARRAY</h3> +<pre class="programlisting">#define GARROW_TYPE_DICTIONARY_ARRAY (garrow_dictionary_array_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowDictionaryArrayClass"></a><h3>struct GArrowDictionaryArrayClass</h3> +<pre class="programlisting">struct GArrowDictionaryArrayClass { + GArrowArrayClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowDictionaryArray-struct"></a><h3>GArrowDictionaryArray</h3> +<pre class="programlisting">typedef struct _GArrowDictionaryArray GArrowDictionaryArray;</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
