http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/orc-file-reader.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/orc-file-reader.html b/docs/c_glib/arrow-glib/orc-file-reader.html new file mode 100644 index 0000000..b7846c4 --- /dev/null +++ b/docs/c_glib/arrow-glib/orc-file-reader.html @@ -0,0 +1,490 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ORC reader: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="reader.html" title="Reader"> +<link rel="prev" href="reader-classes.html" title="Reader classes"> +<link rel="next" href="writer.html" title="Writer"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> + <a href="#orc-file-reader.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#orc-file-reader.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#orc-file-reader.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="reader.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="reader-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="writer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="orc-file-reader"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="orc-file-reader.top_of_page"></a>ORC reader</span></h2> +<p>ORC reader</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="orc-file-reader.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="returnvalue">GArrowORCFileReader</span></a> * +</td> +<td class="function_name"> +<a class="link" href="orc-file-reader.html#garrow-orc-file-reader-new" title="garrow_orc_file_reader_new ()">garrow_orc_file_reader_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="orc-file-reader.html#garrow-orc-file-reader-set-field-indexes" title="garrow_orc_file_reader_set_field_indexes ()">garrow_orc_file_reader_set_field_indexes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="orc-file-reader.html#garrow-orc-file-reader-get-field-indexes" title="garrow_orc_file_reader_get_field_indexes ()">garrow_orc_file_reader_get_field_indexes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +</td> +<td class="function_name"> +<a class="link" href="orc-file-reader.html#garrow-orc-file-reader-read-type" title="garrow_orc_file_reader_read_type ()">garrow_orc_file_reader_read_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +</td> +<td class="function_name"> +<a class="link" href="orc-file-reader.html#garrow-orc-file-reader-read-stripes" title="garrow_orc_file_reader_read_stripes ()">garrow_orc_file_reader_read_stripes</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="orc-file-reader.html#garrow-orc-file-reader-read-stripe" title="garrow_orc_file_reader_read_stripe ()">garrow_orc_file_reader_read_stripe</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="orc-file-reader.html#garrow-orc-file-reader-get-n-stripes" title="garrow_orc_file_reader_get_n_stripes ()">garrow_orc_file_reader_get_n_stripes</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="orc-file-reader.html#garrow-orc-file-reader-get-n-rows" title="garrow_orc_file_reader_get_n_rows ()">garrow_orc_file_reader_get_n_rows</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="orc-file-reader.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *</td> +<td class="property_name"><a class="link" href="orc-file-reader.html#GArrowORCFileReader--input" title="The âinputâ property">input</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="orc-file-reader.html#GArrowORCFileReader--orc-file-reader" title="The âorc-file-readerâ property">orc-file-reader</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<a name="GArrowORCFileReader"></a><div class="refsect1"> +<a name="orc-file-reader.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="orc-file-reader.html#GARROW-TYPE-ORC-FILE-READER:CAPS" title="GARROW_TYPE_ORC_FILE_READER">GARROW_TYPE_ORC_FILE_READER</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="orc-file-reader.html#GArrowORCFileReaderClass" title="struct GArrowORCFileReaderClass">GArrowORCFileReaderClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="orc-file-reader.html#GArrowORCFileReader-struct" title="GArrowORCFileReader">GArrowORCFileReader</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="orc-file-reader.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowORCFileReader +</pre> +</div> +<div class="refsect1"> +<a name="orc-file-reader.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/orc-file-reader.h> +</pre> +</div> +<div class="refsect1"> +<a name="orc-file-reader.description"></a><h2>Description</h2> +<p><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> is a class for reading stripes in ORC file +format from input.</p> +</div> +<div class="refsect1"> +<a name="orc-file-reader.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-orc-file-reader-new"></a><h3>garrow_orc_file_reader_new ()</h3> +<pre class="programlisting"><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="returnvalue">GArrowORCFileReader</span></a> * +garrow_orc_file_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>file</p></td> +<td class="parameter_description"><p>The file to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> +or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-set-field-indexes"></a><h3>garrow_orc_file_reader_set_field_indexes ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +garrow_orc_file_reader_set_field_indexes + (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>, + <em class="parameter"><code>const <GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> *field_indexes</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> n_field_indexes</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-set-field-indexes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>field_indexes</p></td> +<td class="parameter_description"><p>The field indexes to be read. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_field_indexes]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>n_field_indexes</p></td> +<td class="parameter_description"><p>The number of the specified indexes.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-get-field-indexes"></a><h3>garrow_orc_file_reader_get_field_indexes ()</h3> +<pre class="programlisting">const <GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> * +garrow_orc_file_reader_get_field_indexes + (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> *n_field_indexes</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-get-field-indexes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_field_indexes</p></td> +<td class="parameter_description"><p>The number of the specified indexes.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-get-field-indexes.returns"></a><h4>Returns</h4> +<p>The field indexes to be read. </p> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_field_indexes][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-read-type"></a><h3>garrow_orc_file_reader_read_type ()</h3> +<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +garrow_orc_file_reader_read_type (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-read-type.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-read-type.returns"></a><h4>Returns</h4> +<p>A newly read type as +<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-read-stripes"></a><h3>garrow_orc_file_reader_read_stripes ()</h3> +<pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * +garrow_orc_file_reader_read_stripes (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-read-stripes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-read-stripes.returns"></a><h4>Returns</h4> +<p>A newly read stripes as +<a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-read-stripe"></a><h3>garrow_orc_file_reader_read_stripe ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_orc_file_reader_read_stripe (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-read-stripe.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</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 stripe index to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-read-stripe.returns"></a><h4>Returns</h4> +<p>A newly read stripe as +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-get-n-stripes"></a><h3>garrow_orc_file_reader_get_n_stripes ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_orc_file_reader_get_n_stripes (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-get-n-stripes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-get-n-stripes.returns"></a><h4>Returns</h4> +<p> The number of stripes in the file.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-orc-file-reader-get-n-rows"></a><h3>garrow_orc_file_reader_get_n_rows ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_orc_file_reader_get_n_rows (<em class="parameter"><code><a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a> *reader</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-orc-file-reader-get-n-rows.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="orc-file-reader.html#GArrowORCFileReader"><span class="type">GArrowORCFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-orc-file-reader-get-n-rows.returns"></a><h4>Returns</h4> +<p> The number of rows in the file.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-10-0.html#api-index-0.10.0">0.10.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="orc-file-reader.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GARROW-TYPE-ORC-FILE-READER:CAPS"></a><h3>GARROW_TYPE_ORC_FILE_READER</h3> +<pre class="programlisting">#define GARROW_TYPE_ORC_FILE_READER (garrow_orc_file_reader_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowORCFileReaderClass"></a><h3>struct GArrowORCFileReaderClass</h3> +<pre class="programlisting">struct GArrowORCFileReaderClass { + GObjectClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowORCFileReader-struct"></a><h3>GArrowORCFileReader</h3> +<pre class="programlisting">typedef struct _GArrowORCFileReader GArrowORCFileReader;</pre> +</div> +</div> +<div class="refsect1"> +<a name="orc-file-reader.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowORCFileReader--input"></a><h3>The <code class="literal">âinputâ</code> property</h3> +<pre class="programlisting"> âinputâ <a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *</pre> +<p>The input stream.</p> +<p>Flags: Read / Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowORCFileReader--orc-file-reader"></a><h3>The <code class="literal">âorc-file-readerâ</code> property</h3> +<pre class="programlisting"> âorc-file-readerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw arrow::adapters::orc::ORCFileReader *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/output-stream-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/output-stream-classes.html b/docs/c_glib/arrow-glib/output-stream-classes.html new file mode 100644 index 0000000..5af6a8d --- /dev/null +++ b/docs/c_glib/arrow-glib/output-stream-classes.html @@ -0,0 +1,442 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Output stream classes: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="output.html" title="Output"> +<link rel="prev" href="GArrowWritableFile.html" title="GArrowWritableFile"> +<link rel="next" href="input-output.html" title="Input and output"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> + <a href="#output-stream-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#output-stream-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> + <a href="#output-stream-classes.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#output-stream-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="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowWritableFile.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="output-stream-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="output-stream-classes.top_of_page"></a>Output stream classes</span></h2> +<p>Output stream classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="output-stream-classes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-output-stream-align" title="garrow_output_stream_align ()">garrow_output_stream_align</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="output-stream-classes.html#garrow-output-stream-write-tensor" title="garrow_output_stream_write_tensor ()">garrow_output_stream_write_tensor</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="returnvalue">GArrowFileOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-file-output-stream-new" title="garrow_file_output_stream_new ()">garrow_file_output_stream_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="returnvalue">GArrowBufferOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-buffer-output-stream-new" title="garrow_buffer_output_stream_new ()">garrow_buffer_output_stream_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="returnvalue">GArrowGIOOutputStream</span></a> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-gio-output-stream-new" title="garrow_gio_output_stream_new ()">garrow_gio_output_stream_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="GOutputStream"><span class="returnvalue">GOutputStream</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="output-stream-classes.html#garrow-gio-output-stream-get-raw" title="garrow_gio_output_stream_get_raw ()">garrow_gio_output_stream_get_raw</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="output-stream-classes.html#GArrowOutputStream--output-stream" title="The âoutput-streamâ property">output-stream</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<a name="GArrowFileOutputStream"></a><a name="GArrowBufferOutputStream"></a><a name="GArrowGIOOutputStream"></a><a name="GArrowOutputStream"></a><div class="refsect1"> +<a name="output-stream-classes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GARROW-TYPE-OUTPUT-STREAM:CAPS" title="GARROW_TYPE_OUTPUT_STREAM">GARROW_TYPE_OUTPUT_STREAM</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowOutputStreamClass" title="struct GArrowOutputStreamClass">GArrowOutputStreamClass</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowFileOutputStream-struct" title="struct GArrowFileOutputStream">GArrowFileOutputStream</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowBufferOutputStream-struct" title="struct GArrowBufferOutputStream">GArrowBufferOutputStream</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream-struct" title="struct GArrowGIOOutputStream">GArrowGIOOutputStream</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="output-stream-classes.html#GArrowOutputStream-struct" title="GArrowOutputStream">GArrowOutputStream</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowOutputStream + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream">GArrowBufferOutputStream</a> + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowFileOutputStream">GArrowFileOutputStream</a> + <span class="lineart">âââ</span> <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream">GArrowGIOOutputStream</a> + <span class="lineart">âââ</span> GArrowBufferOutputStream + <span class="lineart">âââ</span> GArrowFileOutputStream + <span class="lineart">â°ââ</span> GArrowGIOOutputStream +</pre> +</div> +<div class="refsect1"> +<a name="output-stream-classes.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GArrowFileOutputStream implements + <a class="link" href="GArrowWritable.html" title="GArrowWritable">GArrowWritable</a>.</p> +<p> +GArrowBufferOutputStream implements + <a class="link" href="GArrowWritable.html" title="GArrowWritable">GArrowWritable</a>.</p> +<p> +GArrowGIOOutputStream implements + <a class="link" href="GArrowWritable.html" title="GArrowWritable">GArrowWritable</a>.</p> +<p> +GArrowOutputStream implements + <a class="link" href="GArrowWritable.html" title="GArrowWritable">GArrowWritable</a>.</p> +</div> +<div class="refsect1"> +<a name="output-stream-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="output-stream-classes.description"></a><h2>Description</h2> +<p><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> is an interface for stream output. Stream +output is file based and writable</p> +<p><a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="type">GArrowFileOutputStream</span></a> is a class for file output stream.</p> +<p><a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="type">GArrowBufferOutputStream</span></a> is a class for buffer output stream.</p> +<p><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a> is a class for <code class="literal">GOutputStream</code> based output +stream.</p> +</div> +<div class="refsect1"> +<a name="output-stream-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-output-stream-align"></a><h3>garrow_output_stream_align ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_output_stream_align (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *stream</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint32"><span class="type">gint32</span></GTKDOCLINK> alignment</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-output-stream-align.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stream</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>alignment</p></td> +<td class="parameter_description"><p>The byte multiple for the metadata prefix, usually 8 +or 64, to ensure the body starts on a multiple of that alignment.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-output-stream-align.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> on error.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-11-0.html#api-index-0.11.0">0.11.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-output-stream-write-tensor"></a><h3>garrow_output_stream_write_tensor ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_output_stream_write_tensor (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *stream</code></em>, + <em class="parameter"><code><a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> *tensor</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-output-stream-write-tensor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>stream</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tensor</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowTensor.html" title="GArrowTensor"><span class="type">GArrowTensor</span></a> to be written.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-output-stream-write-tensor.returns"></a><h4>Returns</h4> +<p> The number of written bytes on success, -1 on error.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-output-stream-new"></a><h3>garrow_file_output_stream_new ()</h3> +<pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowFileOutputStream"><span class="returnvalue">GArrowFileOutputStream</span></a> * +garrow_file_output_stream_new (<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="garrow-file-output-stream-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>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">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-file-output-stream-new.returns"></a><h4>Returns</h4> +<p>A newly opened <a class="link" href="output-stream-classes.html#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">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-buffer-output-stream-new"></a><h3>garrow_buffer_output_stream_new ()</h3> +<pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="returnvalue">GArrowBufferOutputStream</span></a> * +garrow_buffer_output_stream_new (<em class="parameter"><code><a class="link" href="buffer-classes.html#GArrowResizableBuffer"><span class="type">GArrowResizableBuffer</span></a> *buffer</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-buffer-output-stream-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p>The resizable buffer to be output.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-buffer-output-stream-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream"><span class="type">GArrowBufferOutputStream</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-gio-output-stream-new"></a><h3>garrow_gio_output_stream_new ()</h3> +<pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="returnvalue">GArrowGIOOutputStream</span></a> * +garrow_gio_output_stream_new (<em class="parameter"><code><GTKDOCLINK HREF="GOutputStream"><span class="type">GOutputStream</span></GTKDOCLINK> *gio_output_stream</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-gio-output-stream-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>gio_output_stream</p></td> +<td class="parameter_description"><p>The stream to be output.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-gio-output-stream-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-gio-output-stream-get-raw"></a><h3>garrow_gio_output_stream_get_raw ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GOutputStream"><span class="returnvalue">GOutputStream</span></GTKDOCLINK> * +garrow_gio_output_stream_get_raw (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a> *output_stream</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-gio-output-stream-get-raw.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>output_stream</p></td> +<td class="parameter_description"><p>A <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream"><span class="type">GArrowGIOOutputStream</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-gio-output-stream-get-raw.returns"></a><h4>Returns</h4> +<p>The wrapped <GTKDOCLINK HREF="GOutputStream"><span class="type">GOutputStream</span></GTKDOCLINK>. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-5-0.html#api-index-0.5.0">0.5.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GARROW-TYPE-OUTPUT-STREAM:CAPS"></a><h3>GARROW_TYPE_OUTPUT_STREAM</h3> +<pre class="programlisting">#define GARROW_TYPE_OUTPUT_STREAM (garrow_output_stream_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowOutputStreamClass"></a><h3>struct GArrowOutputStreamClass</h3> +<pre class="programlisting">struct GArrowOutputStreamClass { + GObjectClass parent_class; +}; +</pre> +</div> +<hr> +<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> +<hr> +<div class="refsect2"> +<a name="GArrowBufferOutputStream-struct"></a><h3>struct GArrowBufferOutputStream</h3> +<pre class="programlisting">struct GArrowBufferOutputStream;</pre> +<p>It wraps <code class="literal">arrow::io::BufferOutputStream</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowGIOOutputStream-struct"></a><h3>struct GArrowGIOOutputStream</h3> +<pre class="programlisting">struct GArrowGIOOutputStream;</pre> +<p>It's an output stream for <code class="literal">GOutputStream</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowOutputStream-struct"></a><h3>GArrowOutputStream</h3> +<pre class="programlisting">typedef struct _GArrowOutputStream GArrowOutputStream;</pre> +</div> +</div> +<div class="refsect1"> +<a name="output-stream-classes.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowOutputStream--output-stream"></a><h3>The <code class="literal">âoutput-streamâ</code> property</h3> +<pre class="programlisting"> âoutput-streamâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::io::OutputStream> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/output.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/output.html b/docs/c_glib/arrow-glib/output.html new file mode 100644 index 0000000..e23a7d9 --- /dev/null +++ b/docs/c_glib/arrow-glib/output.html @@ -0,0 +1,40 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Output: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="io.html" title="Part II. IO"> +<link rel="prev" href="input-stream-classes.html" title="Input stream classes"> +<link rel="next" href="GArrowWritable.html" title="GArrowWritable"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="io.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="input-stream-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowWritable.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="output"></a>Output</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="GArrowWritable.html">GArrowWritable</a></span><span class="refpurpose"> â Output interface</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GArrowWritableFile.html">GArrowWritableFile</a></span><span class="refpurpose"> â File output interface</span> +</dt> +<dt> +<span class="refentrytitle"><a href="output-stream-classes.html">Output stream classes</a></span><span class="refpurpose"></span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
