Add initial GLib docs
Project: http://git-wip-us.apache.org/repos/asf/arrow-site/repo Commit: http://git-wip-us.apache.org/repos/asf/arrow-site/commit/cf45c51a Tree: http://git-wip-us.apache.org/repos/asf/arrow-site/tree/cf45c51a Diff: http://git-wip-us.apache.org/repos/asf/arrow-site/diff/cf45c51a Branch: refs/heads/asf-site Commit: cf45c51a3f9016ef9917a4aaa994543977dc1525 Parents: 36041ec Author: Wes McKinney <[email protected]> Authored: Tue Apr 25 17:28:29 2017 -0400 Committer: Wes McKinney <[email protected]> Committed: Tue Apr 25 17:28:29 2017 -0400 ---------------------------------------------------------------------- docs/c_glib/GArrowChunkedArray.html | 322 +++ docs/c_glib/GArrowColumn.html | 397 +++ docs/c_glib/GArrowField.html | 378 +++ docs/c_glib/GArrowFile.html | 203 ++ docs/c_glib/GArrowFileOutputStream.html | 163 ++ docs/c_glib/GArrowFileReader.html | 303 +++ docs/c_glib/GArrowFileWriter.html | 224 ++ docs/c_glib/GArrowInputStream.html | 76 + docs/c_glib/GArrowMemoryMappedFile.html | 164 ++ docs/c_glib/GArrowOutputStream.html | 76 + docs/c_glib/GArrowRandomAccessFile.html | 228 ++ docs/c_glib/GArrowReadable.html | 144 ++ docs/c_glib/GArrowRecordBatch.html | 430 ++++ docs/c_glib/GArrowSchema.html | 330 +++ docs/c_glib/GArrowStreamReader.html | 230 ++ docs/c_glib/GArrowStreamWriter.html | 251 ++ docs/c_glib/GArrowTable.html | 402 +++ docs/c_glib/GArrowTensor.html | 643 +++++ docs/c_glib/GArrowWriteable.html | 183 ++ docs/c_glib/GArrowWriteableFile.html | 143 ++ docs/c_glib/annotation-glossary.html | 47 + docs/c_glib/api-index-0-3-0.html | 178 ++ docs/c_glib/api-index-full.html | 1423 +++++++++++ docs/c_glib/array-builder-classes.html | 2366 ++++++++++++++++++ docs/c_glib/array-builder.html | 33 + docs/c_glib/array-classes.html | 1714 +++++++++++++ docs/c_glib/array.html | 33 + docs/c_glib/arrow-glib-GArrowError.html | 177 ++ docs/c_glib/arrow-glib-GArrowFileMode.html | 106 + .../arrow-glib-GArrowMetadataVersion.html | 107 + docs/c_glib/arrow-glib-GArrowType.html | 269 ++ docs/c_glib/arrow-glib.devhelp2 | 413 +++ docs/c_glib/buffer-classes.html | 740 ++++++ docs/c_glib/buffer.html | 33 + docs/c_glib/data-type-classes.html | 1032 ++++++++ docs/c_glib/data.html | 88 + docs/c_glib/deprecated-api-index.html | 31 + docs/c_glib/error.html | 33 + docs/c_glib/home.png | Bin 0 -> 169 bytes docs/c_glib/index.html | 160 ++ docs/c_glib/index.sgml | 625 +++++ docs/c_glib/input-output.html | 38 + docs/c_glib/input.html | 41 + docs/c_glib/io.html | 75 + docs/c_glib/ipc.html | 57 + docs/c_glib/left-insensitive.png | Bin 0 -> 329 bytes docs/c_glib/left.png | Bin 0 -> 187 bytes docs/c_glib/metadata.html | 33 + docs/c_glib/mode.html | 33 + docs/c_glib/object-tree.html | 109 + docs/c_glib/output.html | 44 + docs/c_glib/reader.html | 38 + docs/c_glib/right-insensitive.png | Bin 0 -> 233 bytes docs/c_glib/right.png | Bin 0 -> 186 bytes docs/c_glib/schema.html | 38 + docs/c_glib/style.css | 461 ++++ docs/c_glib/table.html | 44 + docs/c_glib/tensor.html | 33 + docs/c_glib/type.html | 38 + docs/c_glib/up-insensitive.png | Bin 0 -> 293 bytes docs/c_glib/up.png | Bin 0 -> 187 bytes docs/c_glib/writer.html | 38 + 62 files changed, 16018 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/arrow-site/blob/cf45c51a/docs/c_glib/GArrowChunkedArray.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowChunkedArray.html b/docs/c_glib/GArrowChunkedArray.html new file mode 100644 index 0000000..ed6086d --- /dev/null +++ b/docs/c_glib/GArrowChunkedArray.html @@ -0,0 +1,322 @@ +<!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: GArrowChunkedArray</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="table.html" title="Table"> +<link rel="prev" href="GArrowColumn.html" title="GArrowColumn"> +<link rel="next" href="buffer.html" title="Buffer"> +<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="#GArrowChunkedArray.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowChunkedArray.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GArrowChunkedArray.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="table.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowColumn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="buffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowChunkedArray"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowChunkedArray.top_of_page"></a>GArrowChunkedArray</span></h2> +<p>GArrowChunkedArray â Chunked array class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowChunkedArray.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="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-new" title="garrow_chunked_array_new ()">garrow_chunked_array_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-length" title="garrow_chunked_array_get_length ()">garrow_chunked_array_get_length</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-n-nulls" title="garrow_chunked_array_get_n_nulls ()">garrow_chunked_array_get_n_nulls</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-n-chunks" title="garrow_chunked_array_get_n_chunks ()">garrow_chunked_array_get_n_chunks</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowChunkedArray.html#garrow-chunked-array-get-chunk" title="garrow_chunked_array_get_chunk ()">garrow_chunked_array_get_chunk</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="GArrowChunkedArray.html#garrow-chunked-array-get-chunks" title="garrow_chunked_array_get_chunks ()">garrow_chunked_array_get_chunks</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.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="GArrowChunkedArray.html#GArrowChunkedArray--chunked-array" title="The âchunked-arrayâ property">chunked-array</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.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="GArrowChunkedArray.html#GArrowChunkedArray-struct" title="struct GArrowChunkedArray">GArrowChunkedArray</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowChunkedArray +</pre> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> is a class for chunked array. Chunked array +makes a list of <GTKDOCLINK HREF="GArrowArrays"><span class="type">GArrowArrays</span></GTKDOCLINK> one logical large array.</p> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-chunked-array-new"></a><h3>garrow_chunked_array_new ()</h3> +<pre class="programlisting"><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * +garrow_chunked_array_new (<em class="parameter"><code><GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> *chunks</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.5.8.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>chunks</p></td> +<td class="parameter_description"><p> The array chunks. </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></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.5.8.2.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-chunked-array-get-length"></a><h3>garrow_chunked_array_get_length ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +garrow_chunked_array_get_length (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.5.8.3.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>chunked_array</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.5.8.3.5"></a><h4>Returns</h4> +<p> The total number of rows in the chunked array.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-chunked-array-get-n-nulls"></a><h3>garrow_chunked_array_get_n_nulls ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +garrow_chunked_array_get_n_nulls (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.5.8.4.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>chunked_array</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.5.8.4.5"></a><h4>Returns</h4> +<p> The total number of NULL in the chunked array.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-chunked-array-get-n-chunks"></a><h3>garrow_chunked_array_get_n_chunks ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +garrow_chunked_array_get_n_chunks (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.5.8.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>chunked_array</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.5.8.5.5"></a><h4>Returns</h4> +<p> The total number of chunks in the chunked array.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-chunked-array-get-chunk"></a><h3>garrow_chunked_array_get_chunk ()</h3> +<pre class="programlisting"><a class="link" href="array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +garrow_chunked_array_get_chunk (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.5.8.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>chunked_array</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</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 chunk.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.5.8.6.5"></a><h4>Returns</h4> +<p> The i-th chunk of the chunked 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> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-chunked-array-get-chunks"></a><h3>garrow_chunked_array_get_chunks ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +garrow_chunked_array_get_chunks (<em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.5.8.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>chunked_array</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.5.8.7.5"></a><h4>Returns</h4> +<p> The chunks in the chunked array. </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> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowChunkedArray-struct"></a><h3>struct GArrowChunkedArray</h3> +<pre class="programlisting">struct GArrowChunkedArray;</pre> +<p>It wraps <code class="literal">arrow::ChunkedArray</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowChunkedArray.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowChunkedArray--chunked-array"></a><h3>The <code class="literal">âchunked-arrayâ</code> property</h3> +<pre class="programlisting"> âchunked-arrayâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ChunkedArray> *.</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/GArrowColumn.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowColumn.html b/docs/c_glib/GArrowColumn.html new file mode 100644 index 0000000..d544e34 --- /dev/null +++ b/docs/c_glib/GArrowColumn.html @@ -0,0 +1,397 @@ +<!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: GArrowColumn</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="table.html" title="Table"> +<link rel="prev" href="GArrowRecordBatch.html" title="GArrowRecordBatch"> +<link rel="next" href="GArrowChunkedArray.html" title="GArrowChunkedArray"> +<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="#GArrowColumn.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowColumn.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GArrowColumn.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="table.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowRecordBatch.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowChunkedArray.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowColumn"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowColumn.top_of_page"></a>GArrowColumn</span></h2> +<p>GArrowColumn â Column class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowColumn.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="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-new-array" title="garrow_column_new_array ()">garrow_column_new_array</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-new-chunked-array" title="garrow_column_new_chunked_array ()">garrow_column_new_chunked_array</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-get-length" title="garrow_column_get_length ()">garrow_column_get_length</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-get-n-nulls" title="garrow_column_get_n_nulls ()">garrow_column_get_n_nulls</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-get-field" title="garrow_column_get_field ()">garrow_column_get_field</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-get-name" title="garrow_column_get_name ()">garrow_column_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-get-data-type" title="garrow_column_get_data_type ()">garrow_column_get_data_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowColumn.html#garrow-column-get-data" title="garrow_column_get_data ()">garrow_column_get_data</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowColumn.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="GArrowColumn.html#GArrowColumn--column" title="The âcolumnâ property">column</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowColumn.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="GArrowColumn.html#GArrowColumn-struct" title="struct GArrowColumn">GArrowColumn</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowColumn.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowColumn +</pre> +</div> +<div class="refsect1"> +<a name="GArrowColumn.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> is a class for column. Column has a <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> and +zero or more values. Values are <a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a>.</p> +</div> +<div class="refsect1"> +<a name="GArrowColumn.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-column-new-array"></a><h3>garrow_column_new_array ()</h3> +<pre class="programlisting"><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +garrow_column_new_array (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>, + <em class="parameter"><code><a class="link" href="array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *array</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>field</p></td> +<td class="parameter_description"><p>The metadata of the column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>array</p></td> +<td class="parameter_description"><p>The data of the column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.2.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-column-new-chunked-array"></a><h3>garrow_column_new_chunked_array ()</h3> +<pre class="programlisting"><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="returnvalue">GArrowColumn</span></a> * +garrow_column_new_chunked_array (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>, + <em class="parameter"><code><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="type">GArrowChunkedArray</span></a> *chunked_array</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.3.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>field</p></td> +<td class="parameter_description"><p>The metadata of the column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>chunked_array</p></td> +<td class="parameter_description"><p>The data of the column.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.3.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-column-get-length"></a><h3>garrow_column_get_length ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +garrow_column_get_length (<em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.4.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>column</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.4.5"></a><h4>Returns</h4> +<p> The number of data of the column.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-column-get-n-nulls"></a><h3>garrow_column_get_n_nulls ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +garrow_column_get_n_nulls (<em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.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>column</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.5.5"></a><h4>Returns</h4> +<p> The number of nulls of the column.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-column-get-field"></a><h3>garrow_column_get_field ()</h3> +<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +garrow_column_get_field (<em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.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>column</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.6.5"></a><h4>Returns</h4> +<p> The metadata of the column. </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-column-get-name"></a><h3>garrow_column_get_name ()</h3> +<pre class="programlisting">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_column_get_name (<em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.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>column</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.7.5"></a><h4>Returns</h4> +<p> The name of the column.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-column-get-data-type"></a><h3>garrow_column_get_data_type ()</h3> +<pre class="programlisting"><a class="link" href="data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +garrow_column_get_data_type (<em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.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>column</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.8.5"></a><h4>Returns</h4> +<p> The data type of the column. </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-column-get-data"></a><h3>garrow_column_get_data ()</h3> +<pre class="programlisting"><a class="link" href="GArrowChunkedArray.html" title="GArrowChunkedArray"><span class="returnvalue">GArrowChunkedArray</span></a> * +garrow_column_get_data (<em class="parameter"><code><a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a> *column</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.7.4.8.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>column</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowColumn.html" title="GArrowColumn"><span class="type">GArrowColumn</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.7.4.8.9.5"></a><h4>Returns</h4> +<p> The data of the column. </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> +</div> +<div class="refsect1"> +<a name="GArrowColumn.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowColumn-struct"></a><h3>struct GArrowColumn</h3> +<pre class="programlisting">struct GArrowColumn;</pre> +<p>It wraps <code class="literal">arrow::Column</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowColumn.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowColumn--column"></a><h3>The <code class="literal">âcolumnâ</code> property</h3> +<pre class="programlisting"> âcolumnâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::Column> *.</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/GArrowField.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowField.html b/docs/c_glib/GArrowField.html new file mode 100644 index 0000000..f44948a --- /dev/null +++ b/docs/c_glib/GArrowField.html @@ -0,0 +1,378 @@ +<!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: GArrowField</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="schema.html" title="Schema"> +<link rel="prev" href="schema.html" title="Schema"> +<link rel="next" href="GArrowSchema.html" title="GArrowSchema"> +<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="#GArrowField.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowField.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GArrowField.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="schema.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="schema.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowSchema.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowField"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowField.top_of_page"></a>GArrowField</span></h2> +<p>GArrowField â Field class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowField.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="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-new" title="garrow_field_new ()">garrow_field_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-new-full" title="garrow_field_new_full ()">garrow_field_new_full</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-get-name" title="garrow_field_get_name ()">garrow_field_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-get-data-type" title="garrow_field_get_data_type ()">garrow_field_get_data_type</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="GArrowField.html#garrow-field-is-nullable" title="garrow_field_is_nullable ()">garrow_field_is_nullable</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="GArrowField.html#garrow-field-equal" title="garrow_field_equal ()">garrow_field_equal</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-to-string" title="garrow_field_to_string ()">garrow_field_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowField.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="GArrowField.html#GArrowField--field" title="The âfieldâ property">field</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowField.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="GArrowField.html#GArrowField-struct" title="struct GArrowField">GArrowField</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowField.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowField +</pre> +</div> +<div class="refsect1"> +<a name="GArrowField.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> is a class for field. Field is metadata of a +column. It has name, data type (<a class="link" href="data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a>) and nullable +information of the column.</p> +</div> +<div class="refsect1"> +<a name="GArrowField.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-field-new"></a><h3>garrow_field_new ()</h3> +<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +garrow_field_new (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *name</code></em>, + <em class="parameter"><code><a class="link" href="data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data_type</p></td> +<td class="parameter_description"><p>The data type of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.2.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-new-full"></a><h3>garrow_field_new_full ()</h3> +<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +garrow_field_new_full (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *name</code></em>, + <em class="parameter"><code><a class="link" href="data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gboolean"><span class="type">gboolean</span></GTKDOCLINK> nullable</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.3.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data_type</p></td> +<td class="parameter_description"><p>The data type of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nullable</p></td> +<td class="parameter_description"><p>Whether null may be included or not.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.3.5"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-get-name"></a><h3>garrow_field_get_name ()</h3> +<pre class="programlisting">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_field_get_name (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.4.4"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.4.5"></a><h4>Returns</h4> +<p> The name of the field.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-get-data-type"></a><h3>garrow_field_get_data_type ()</h3> +<pre class="programlisting"><a class="link" href="data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +garrow_field_get_data_type (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.5.5"></a><h4>Returns</h4> +<p> The data type of the 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-field-is-nullable"></a><h3>garrow_field_is_nullable ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_field_is_nullable (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.6.5"></a><h4>Returns</h4> +<p> Whether the filed may include null or not.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-equal"></a><h3>garrow_field_equal ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_field_equal (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>, + <em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *other_field</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>other_field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.7.5"></a><h4>Returns</h4> +<p> Whether they are equal or not.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-to-string"></a><h3>garrow_field_to_string ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_field_to_string (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.2.6.2.8.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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.2.6.2.8.8.5"></a><h4>Returns</h4> +<p> The string representation of the field.</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowField.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowField-struct"></a><h3>struct GArrowField</h3> +<pre class="programlisting">struct GArrowField;</pre> +<p>It wraps <code class="literal">arrow::Field</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowField.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowField--field"></a><h3>The <code class="literal">âfieldâ</code> property</h3> +<pre class="programlisting"> âfieldâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::Field> *.</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/GArrowFile.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowFile.html b/docs/c_glib/GArrowFile.html new file mode 100644 index 0000000..8c2e77b --- /dev/null +++ b/docs/c_glib/GArrowFile.html @@ -0,0 +1,203 @@ +<!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: GArrowFile</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="input-output.html" title="Input and output"> +<link rel="prev" href="input-output.html" title="Input and output"> +<link rel="next" href="GArrowMemoryMappedFile.html" title="GArrowMemoryMappedFile"> +<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="#GArrowFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowFile.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="input-output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="input-output.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowMemoryMappedFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowFile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowFile.top_of_page"></a>GArrowFile</span></h2> +<p>GArrowFile â File interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowFile.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"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowFile.html#garrow-file-close" title="garrow_file_close ()">garrow_file_close</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="GArrowFile.html#garrow-file-tell" title="garrow_file_tell ()">garrow_file_tell</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="returnvalue">GArrowFileMode</span></a> +</td> +<td class="function_name"> +<a class="link" href="GArrowFile.html#garrow-file-get-mode" title="garrow_file_get_mode ()">garrow_file_get_mode</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFile.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"> </td> +<td class="function_name"><a class="link" href="GArrowFile.html#GArrowFileInterface" title="GArrowFileInterface">GArrowFileInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowFile +</pre> +</div> +<div class="refsect1"> +<a name="GArrowFile.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> is an interface for file.</p> +</div> +<div class="refsect1"> +<a name="GArrowFile.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-file-close"></a><h3>garrow_file_close ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_file_close (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.5.2.7.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>file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</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">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.5.2.7.2.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> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-tell"></a><h3>garrow_file_tell ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_file_tell (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.5.2.7.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>file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</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">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.5.2.7.3.5"></a><h4>Returns</h4> +<p> The current offset on success, -1 if there was an error.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-get-mode"></a><h3>garrow_file_get_mode ()</h3> +<pre class="programlisting"><a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="returnvalue">GArrowFileMode</span></a> +garrow_file_get_mode (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.5.2.7.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>file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.5.2.7.4.5"></a><h4>Returns</h4> +<p> The mode of the file.</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowFile.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowFileInterface"></a><h3>GArrowFileInterface</h3> +<pre class="programlisting">typedef struct _GArrowFileInterface GArrowFileInterface;</pre> +<p> +</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/GArrowFileOutputStream.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/GArrowFileOutputStream.html b/docs/c_glib/GArrowFileOutputStream.html new file mode 100644 index 0000000..d3155f3 --- /dev/null +++ b/docs/c_glib/GArrowFileOutputStream.html @@ -0,0 +1,163 @@ +<!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: GArrowFileOutputStream</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="GArrowWriteableFile.html" title="GArrowWriteableFile"> +<link rel="next" href="input-output.html" title="Input and output"> +<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="#GArrowFileOutputStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowFileOutputStream.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#GArrowFileOutputStream.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GArrowFileOutputStream.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="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowWriteableFile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="input-output.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowFileOutputStream"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowFileOutputStream.top_of_page"></a>GArrowFileOutputStream</span></h2> +<p>GArrowFileOutputStream â A file output stream.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.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="GArrowFileOutputStream.html" title="GArrowFileOutputStream"><span class="returnvalue">GArrowFileOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowFileOutputStream.html#garrow-file-output-stream-open" title="garrow_file_output_stream_open ()">garrow_file_output_stream_open</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.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="GArrowFileOutputStream.html#GArrowFileOutputStream--file-output-stream" title="The âfile-output-streamâ property">file-output-stream</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.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="GArrowFileOutputStream.html#GArrowFileOutputStream-struct" title="struct GArrowFileOutputStream">GArrowFileOutputStream</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowFileOutputStream +</pre> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GArrowFileOutputStream implements +</p> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.description"></a><h2>Description</h2> +<p>The <a class="link" href="GArrowFileOutputStream.html" title="GArrowFileOutputStream"><span class="type">GArrowFileOutputStream</span></a> is a class for file output stream.</p> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-file-output-stream-open"></a><h3>garrow_file_output_stream_open ()</h3> +<pre class="programlisting"><a class="link" href="GArrowFileOutputStream.html" title="GArrowFileOutputStream"><span class="returnvalue">GArrowFileOutputStream</span></a> * +garrow_file_output_stream_open (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *path</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gboolean"><span class="type">gboolean</span></GTKDOCLINK> append</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.3.4.5.9.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>path</p></td> +<td class="parameter_description"><p>The path of the file output stream.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>append</p></td> +<td class="parameter_description"><p>Whether the path is opened as append mode or recreate mode.</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.3.4.5.9.2.5"></a><h4>Returns</h4> +<p> A newly opened +<a class="link" href="GArrowFileOutputStream.html" title="GArrowFileOutputStream"><span class="type">GArrowFileOutputStream</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowFileOutputStream-struct"></a><h3>struct GArrowFileOutputStream</h3> +<pre class="programlisting">struct GArrowFileOutputStream;</pre> +<p>It wraps <code class="literal">arrow::io::FileOutputStream</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowFileOutputStream.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowFileOutputStream--file-output-stream"></a><h3>The <code class="literal">âfile-output-streamâ</code> property</h3> +<pre class="programlisting"> âfile-output-streamâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::io::FileOutputStream> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html>
