arrow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From w...@apache.org
Subject [04/12] arrow-site git commit: Add initial GLib docs
Date Tue, 25 Apr 2017 21:28:46 GMT
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/buffer-classes.html
----------------------------------------------------------------------
diff --git a/docs/c_glib/buffer-classes.html b/docs/c_glib/buffer-classes.html
new file mode 100644
index 0000000..be7253d
--- /dev/null
+++ b/docs/c_glib/buffer-classes.html
@@ -0,0 +1,740 @@
+<!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: Buffer classes</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Reference Manual">
+<link rel="up" href="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.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="#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 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">
+<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-slice" title="garrow_mutable_buffer_slice ()">garrow_mutable_buffer_slice</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>
+<tr>
+<td class="function_type">
+<a class="link" href="buffer-classes.html#GArrowPoolBuffer"><span class="returnvalue">GArrowPoolBuffer</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="buffer-classes.html#garrow-pool-buffer-new" title="garrow_pool_buffer_new ()">garrow_pool_buffer_new</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 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></tbody>
+</table></div>
+</div>
+<a name="GArrowBuffer"></a><a name="GArrowMutableBuffer"></a><a name="GArrowResizableBuffer"></a><a name="GArrowPoolBuffer"></a><div class="refsect1">
+<a name="buffer-classes.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="buffer-classes.html#GArrowBuffer-struct" title="struct GArrowBuffer">GArrowBuffer</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="buffer-classes.html#GArrowMutableBuffer-struct" title="struct GArrowMutableBuffer">GArrowMutableBuffer</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="buffer-classes.html#GArrowResizableBuffer-struct" title="struct GArrowResizableBuffer">GArrowResizableBuffer</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="buffer-classes.html#GArrowPoolBuffer-struct" title="struct GArrowPoolBuffer">GArrowPoolBuffer</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> <a class="link" href="buffer-classes.html#GArrowBuffer">GArrowBuffer</a>
+    <span class="lineart">│</span>   <span class="lineart">╰──</span> GArrowMutableBuffer
+    <span class="lineart">│</span>       <span class="lineart">╰──</span> <a class="link" href="buffer-classes.html#GArrowResizableBuffer">GArrowResizableBuffer</a>
+    <span class="lineart">│</span>           <span class="lineart">╰──</span> GArrowPoolBuffer
+    <span class="lineart">╰──</span> GArrowBuffer
+        <span class="lineart">╰──</span> <a class="link" href="buffer-classes.html#GArrowMutableBuffer">GArrowMutableBuffer</a>
+            <span class="lineart">╰──</span> GArrowResizableBuffer
+                <span class="lineart">╰──</span> <a class="link" href="buffer-classes.html#GArrowPoolBuffer">GArrowPoolBuffer</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="buffer-classes.includes"></a><h2>Includes</h2>
+<pre class="synopsis">#include &lt;arrow-glib/arrow-glib.h&gt;
+</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="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. <a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a> isn't instantiatable.</p>
+<p><a class="link" href="buffer-classes.html#GArrowPoolBuffer"><span class="type">GArrowPoolBuffer</span></a> is mutable, resizable and instantiatable.</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="id-1.2.8.2.13.2.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.2.5"></a><h4>Returns</h4>
+<p> A newly created <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a>.</p>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.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>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="id-1.2.8.2.13.3.5"></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>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.4.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.4.5"></a><h4>Returns</h4>
+<p> The number of bytes that where allocated for the buffer in
+total.</p>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.5.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.5.5"></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 0.3.0</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="id-1.2.8.2.13.6.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.6.5"></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>][nullable]</span></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.7.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.7.5"></a><h4>Returns</h4>
+<p> The number of bytes that might have valid data.</p>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.8.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.8.5"></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">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.9.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>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">[nullable]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.2.8.2.13.9.5"></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">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.10.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>buffer</p></td>
+<td class="parameter_description"><p>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="id-1.2.8.2.13.10.5"></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 0.3.0</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="id-1.2.8.2.13.11.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.11.5"></a><h4>Returns</h4>
+<p> A newly created <a class="link" href="buffer-classes.html#GArrowMutableBuffer"><span class="type">GArrowMutableBuffer</span></a>.</p>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.12.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>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="id-1.2.8.2.13.12.5"></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 0.3.0</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="id-1.2.8.2.13.13.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>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">[nullable]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.2.8.2.13.13.5"></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>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</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="id-1.2.8.2.13.14.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>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">[nullable]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.2.8.2.13.14.5"></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>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="garrow-pool-buffer-new"></a><h3>garrow_pool_buffer_new ()</h3>
+<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowPoolBuffer"><span class="returnvalue">GArrowPoolBuffer</span></a> *
+garrow_pool_buffer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.2.8.2.13.15.4"></a><h4>Returns</h4>
+<p> A newly created <a class="link" href="buffer-classes.html#GArrowPoolBuffer"><span class="type">GArrowPoolBuffer</span></a>.</p>
+<p></p>
+</div>
+<p class="since">Since 0.3.0</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="buffer-classes.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GArrowBuffer-struct"></a><h3>struct GArrowBuffer</h3>
+<pre class="programlisting">struct GArrowBuffer;</pre>
+<p>It wraps <code class="literal">arrow::Buffer</code>.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GArrowMutableBuffer-struct"></a><h3>struct GArrowMutableBuffer</h3>
+<pre class="programlisting">struct GArrowMutableBuffer;</pre>
+<p>It wraps <code class="literal">arrow::MutableBuffer</code>.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GArrowResizableBuffer-struct"></a><h3>struct GArrowResizableBuffer</h3>
+<pre class="programlisting">struct GArrowResizableBuffer;</pre>
+<p>It wraps <code class="literal">arrow::ResizableBuffer</code>.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GArrowPoolBuffer-struct"></a><h3>struct GArrowPoolBuffer</h3>
+<pre class="programlisting">struct GArrowPoolBuffer;</pre>
+<p>It wraps <code class="literal">arrow::PoolBuffer</code>.</p>
+</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&lt;arrow::Buffer&gt; *.</p>
+<p>Flags: Write / Construct Only</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/buffer.html
----------------------------------------------------------------------
diff --git a/docs/c_glib/buffer.html b/docs/c_glib/buffer.html
new file mode 100644
index 0000000..10b46c8
--- /dev/null
+++ b/docs/c_glib/buffer.html
@@ -0,0 +1,33 @@
+<!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: Buffer</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Reference Manual">
+<link rel="up" href="data.html" title="Part I. Data">
+<link rel="prev" href="GArrowChunkedArray.html" title="GArrowChunkedArray">
+<link rel="next" href="buffer-classes.html" title="Buffer classes">
+<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"></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="GArrowChunkedArray.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.20</div>
+</body>
+</html>


Mime
View raw message