http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/GArrowFileOutputStream.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowFileOutputStream.html b/build/docs/c_glib/GArrowFileOutputStream.html new file mode 100644 index 0000000..d3155f3 --- /dev/null +++ b/build/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>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/3cd84682/build/docs/c_glib/GArrowFileReader.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowFileReader.html b/build/docs/c_glib/GArrowFileReader.html new file mode 100644 index 0000000..1f1007e --- /dev/null +++ b/build/docs/c_glib/GArrowFileReader.html @@ -0,0 +1,303 @@ +<!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: GArrowFileReader</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="reader.html" title="Reader"> +<link rel="prev" href="reader.html" title="Reader"> +<link rel="next" href="GArrowStreamReader.html" title="GArrowStreamReader"> +<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="#GArrowFileReader.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowFileReader.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GArrowFileReader.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.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowStreamReader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowFileReader"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowFileReader.top_of_page"></a>GArrowFileReader</span></h2> +<p>GArrowFileReader â File reader class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowFileReader.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="GArrowFileReader.html" title="GArrowFileReader"><span class="returnvalue">GArrowFileReader</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowFileReader.html#garrow-file-reader-open" title="garrow_file_reader_open ()">garrow_file_reader_open</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowFileReader.html#garrow-file-reader-get-schema" title="garrow_file_reader_get_schema ()">garrow_file_reader_get_schema</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="GArrowFileReader.html#garrow-file-reader-get-n-record-batches" title="garrow_file_reader_get_n_record_batches ()">garrow_file_reader_get_n_record_batches</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="arrow-glib-GArrowMetadataVersion.html#GArrowMetadataVersion" title="enum GArrowMetadataVersion"><span class="returnvalue">GArrowMetadataVersion</span></a> +</td> +<td class="function_name"> +<a class="link" href="GArrowFileReader.html#garrow-file-reader-get-version" title="garrow_file_reader_get_version ()">garrow_file_reader_get_version</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="GArrowFileReader.html#garrow-file-reader-get-record-batch" title="garrow_file_reader_get_record_batch ()">garrow_file_reader_get_record_batch</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileReader.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="GArrowFileReader.html#GArrowFileReader--file-reader" title="The âfile-readerâ property">file-reader</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileReader.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="GArrowFileReader.html#GArrowFileReader-struct" title="struct GArrowFileReader">GArrowFileReader</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileReader.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowFileReader +</pre> +</div> +<div class="refsect1"> +<a name="GArrowFileReader.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a> is a class for receiving data by file based IPC.</p> +</div> +<div class="refsect1"> +<a name="GArrowFileReader.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-file-reader-open"></a><h3>garrow_file_reader_open ()</h3> +<pre class="programlisting"><a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="returnvalue">GArrowFileReader</span></a> * +garrow_file_reader_open (<em class="parameter"><code><a class="link" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</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.4.3.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>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">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.8.2.5"></a><h4>Returns</h4> +<p> A newly opened +<a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-reader-get-schema"></a><h3>garrow_file_reader_get_schema ()</h3> +<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +garrow_file_reader_get_schema (<em class="parameter"><code><a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a> *file_reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.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>file_reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.8.3.5"></a><h4>Returns</h4> +<p> The schema in the file. </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-file-reader-get-n-record-batches"></a><h3>garrow_file_reader_get_n_record_batches ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +garrow_file_reader_get_n_record_batches + (<em class="parameter"><code><a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a> *file_reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.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>file_reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.8.4.5"></a><h4>Returns</h4> +<p> The number of record batches in the file.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-reader-get-version"></a><h3>garrow_file_reader_get_version ()</h3> +<pre class="programlisting"><a class="link" href="arrow-glib-GArrowMetadataVersion.html#GArrowMetadataVersion" title="enum GArrowMetadataVersion"><span class="returnvalue">GArrowMetadataVersion</span></a> +garrow_file_reader_get_version (<em class="parameter"><code><a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a> *file_reader</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.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>file_reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.8.5.5"></a><h4>Returns</h4> +<p> The format version in the file.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-reader-get-record-batch"></a><h3>garrow_file_reader_get_record_batch ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_file_reader_get_record_batch (<em class="parameter"><code><a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</span></a> *file_reader</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.3.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>file_reader</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFileReader.html" title="GArrowFileReader"><span class="type">GArrowFileReader</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 record batch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.2.8.6.5"></a><h4>Returns</h4> +<p> The i-th record batch in the file 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="GArrowFileReader.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowFileReader-struct"></a><h3>struct GArrowFileReader</h3> +<pre class="programlisting">struct GArrowFileReader;</pre> +<p>It wraps <code class="literal">arrow::ipc::FileReader</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowFileReader.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowFileReader--file-reader"></a><h3>The <code class="literal">âfile-readerâ</code> property</h3> +<pre class="programlisting"> âfile-readerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ipc::FileReader> *.</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/3cd84682/build/docs/c_glib/GArrowFileWriter.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowFileWriter.html b/build/docs/c_glib/GArrowFileWriter.html new file mode 100644 index 0000000..75ba8ce --- /dev/null +++ b/build/docs/c_glib/GArrowFileWriter.html @@ -0,0 +1,224 @@ +<!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: GArrowFileWriter</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Reference Manual"> +<link rel="up" href="writer.html" title="Writer"> +<link rel="prev" href="writer.html" title="Writer"> +<link rel="next" href="GArrowStreamWriter.html" title="GArrowStreamWriter"> +<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="#GArrowFileWriter.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowFileWriter.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="writer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="writer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowStreamWriter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowFileWriter"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowFileWriter.top_of_page"></a>GArrowFileWriter</span></h2> +<p>GArrowFileWriter â File writer class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowFileWriter.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="GArrowFileWriter.html" title="GArrowFileWriter"><span class="returnvalue">GArrowFileWriter</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowFileWriter.html#garrow-file-writer-open" title="garrow_file_writer_open ()">garrow_file_writer_open</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="GArrowFileWriter.html#garrow-file-writer-write-record-batch" title="garrow_file_writer_write_record_batch ()">garrow_file_writer_write_record_batch</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="GArrowFileWriter.html#garrow-file-writer-close" title="garrow_file_writer_close ()">garrow_file_writer_close</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileWriter.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="GArrowFileWriter.html#GArrowFileWriter-struct" title="struct GArrowFileWriter">GArrowFileWriter</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFileWriter.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> <a class="link" href="GArrowStreamWriter.html" title="GArrowStreamWriter">GArrowStreamWriter</a> + <span class="lineart">â°ââ</span> GArrowFileWriter +</pre> +</div> +<div class="refsect1"> +<a name="GArrowFileWriter.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="type">GArrowFileWriter</span></a> is a class for sending data by file based IPC.</p> +</div> +<div class="refsect1"> +<a name="GArrowFileWriter.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-file-writer-open"></a><h3>garrow_file_writer_open ()</h3> +<pre class="programlisting"><a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="returnvalue">GArrowFileWriter</span></a> * +garrow_file_writer_open (<em class="parameter"><code><a class="link" href="GArrowOutputStream.html" title="GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *sink</code></em>, + <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.4.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>sink</p></td> +<td class="parameter_description"><p>The output of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>schema</p></td> +<td class="parameter_description"><p>The schema of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.4.2.7.2.5"></a><h4>Returns</h4> +<p> A newly opened +<a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="type">GArrowFileWriter</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </p> +<p><span class="annotation">[nullable][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-writer-write-record-batch"></a><h3>garrow_file_writer_write_record_batch ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_file_writer_write_record_batch (<em class="parameter"><code><a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="type">GArrowFileWriter</span></a> *file_writer</code></em>, + <em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.4.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_writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="type">GArrowFileWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>record_batch</p></td> +<td class="parameter_description"><p>The record batch 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 locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.4.2.7.3.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-writer-close"></a><h3>garrow_file_writer_close ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_file_writer_close (<em class="parameter"><code><a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="type">GArrowFileWriter</span></a> *file_writer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.4.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_writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFileWriter.html" title="GArrowFileWriter"><span class="type">GArrowFileWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return locatipcn for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.4.2.7.4.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> +</div> +<div class="refsect1"> +<a name="GArrowFileWriter.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowFileWriter-struct"></a><h3>struct GArrowFileWriter</h3> +<pre class="programlisting">struct GArrowFileWriter;</pre> +<p>It wraps <code class="literal">arrow::ipc::FileWriter</code>.</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/3cd84682/build/docs/c_glib/GArrowInputStream.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowInputStream.html b/build/docs/c_glib/GArrowInputStream.html new file mode 100644 index 0000000..7e116f4 --- /dev/null +++ b/build/docs/c_glib/GArrowInputStream.html @@ -0,0 +1,76 @@ +<!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: GArrowInputStream</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.html" title="Input"> +<link rel="prev" href="GArrowReadable.html" title="GArrowReadable"> +<link rel="next" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"> +<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="#GArrowInputStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowInputStream.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.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowReadable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowRandomAccessFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowInputStream"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowInputStream.top_of_page"></a>GArrowInputStream</span></h2> +<p>GArrowInputStream â Stream input interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowInputStream.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="GArrowInputStream.html#GArrowInputStreamInterface" title="GArrowInputStreamInterface">GArrowInputStreamInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowInputStream.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowInputStream +</pre> +</div> +<div class="refsect1"> +<a name="GArrowInputStream.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowInputStream.html" title="GArrowInputStream"><span class="type">GArrowInputStream</span></a> is an interface for stream input. Stream input +is file based and readable.</p> +</div> +<div class="refsect1"> +<a name="GArrowInputStream.functions_details"></a><h2>Functions</h2> +</div> +<div class="refsect1"> +<a name="GArrowInputStream.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowInputStreamInterface"></a><h3>GArrowInputStreamInterface</h3> +<pre class="programlisting">typedef struct _GArrowInputStreamInterface GArrowInputStreamInterface;</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/3cd84682/build/docs/c_glib/GArrowMemoryMappedFile.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowMemoryMappedFile.html b/build/docs/c_glib/GArrowMemoryMappedFile.html new file mode 100644 index 0000000..65e975d --- /dev/null +++ b/build/docs/c_glib/GArrowMemoryMappedFile.html @@ -0,0 +1,164 @@ +<!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: GArrowMemoryMappedFile</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="GArrowFile.html" title="GArrowFile"> +<link rel="next" href="ipc.html" title="Part III. IPC"> +<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="#GArrowMemoryMappedFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowMemoryMappedFile.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#GArrowMemoryMappedFile.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GArrowMemoryMappedFile.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="input-output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowFile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ipc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowMemoryMappedFile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowMemoryMappedFile.top_of_page"></a>GArrowMemoryMappedFile</span></h2> +<p>GArrowMemoryMappedFile â Memory mapped file class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.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="GArrowMemoryMappedFile.html" title="GArrowMemoryMappedFile"><span class="returnvalue">GArrowMemoryMappedFile</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowMemoryMappedFile.html#garrow-memory-mapped-file-open" title="garrow_memory_mapped_file_open ()">garrow_memory_mapped_file_open</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.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="GArrowMemoryMappedFile.html#GArrowMemoryMappedFile--memory-mapped-file" title="The âmemory-mapped-fileâ property">memory-mapped-file</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.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="GArrowMemoryMappedFile.html#GArrowMemoryMappedFile-struct" title="struct GArrowMemoryMappedFile">GArrowMemoryMappedFile</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowMemoryMappedFile +</pre> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GArrowMemoryMappedFile implements +</p> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowMemoryMappedFile.html" title="GArrowMemoryMappedFile"><span class="type">GArrowMemoryMappedFile</span></a> is a class for memory mapped file. It's +readable and writeable. It supports zero copy.</p> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-memory-mapped-file-open"></a><h3>garrow_memory_mapped_file_open ()</h3> +<pre class="programlisting"><a class="link" href="GArrowMemoryMappedFile.html" title="GArrowMemoryMappedFile"><span class="returnvalue">GArrowMemoryMappedFile</span></a> * +garrow_memory_mapped_file_open (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *path</code></em>, + <em class="parameter"><code><a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="type">GArrowFileMode</span></a> mode</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.3.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 memory mapped file.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>mode</p></td> +<td class="parameter_description"><p>The mode of the memory mapped file.</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.3.9.2.5"></a><h4>Returns</h4> +<p> A newly opened +<a class="link" href="GArrowMemoryMappedFile.html" title="GArrowMemoryMappedFile"><span class="type">GArrowMemoryMappedFile</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="GArrowMemoryMappedFile.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowMemoryMappedFile-struct"></a><h3>struct GArrowMemoryMappedFile</h3> +<pre class="programlisting">struct GArrowMemoryMappedFile;</pre> +<p>It wraps <code class="literal">arrow::io::MemoryMappedFile</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowMemoryMappedFile.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowMemoryMappedFile--memory-mapped-file"></a><h3>The <code class="literal">âmemory-mapped-fileâ</code> property</h3> +<pre class="programlisting"> âmemory-mapped-fileâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::io::MemoryMappedFile> *.</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/3cd84682/build/docs/c_glib/GArrowOutputStream.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowOutputStream.html b/build/docs/c_glib/GArrowOutputStream.html new file mode 100644 index 0000000..cee7ea5 --- /dev/null +++ b/build/docs/c_glib/GArrowOutputStream.html @@ -0,0 +1,76 @@ +<!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: GArrowOutputStream</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="GArrowWriteable.html" title="GArrowWriteable"> +<link rel="next" href="GArrowWriteableFile.html" title="GArrowWriteableFile"> +<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="#GArrowOutputStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowOutputStream.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="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowWriteable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowWriteableFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowOutputStream"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowOutputStream.top_of_page"></a>GArrowOutputStream</span></h2> +<p>GArrowOutputStream â Stream output interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowOutputStream.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="GArrowOutputStream.html#GArrowOutputStreamInterface" title="GArrowOutputStreamInterface">GArrowOutputStreamInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowOutputStream.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowOutputStream +</pre> +</div> +<div class="refsect1"> +<a name="GArrowOutputStream.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowOutputStream.html" title="GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> is an interface for stream output. Stream +output is file based and writeable</p> +</div> +<div class="refsect1"> +<a name="GArrowOutputStream.functions_details"></a><h2>Functions</h2> +</div> +<div class="refsect1"> +<a name="GArrowOutputStream.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowOutputStreamInterface"></a><h3>GArrowOutputStreamInterface</h3> +<pre class="programlisting">typedef struct _GArrowOutputStreamInterface GArrowOutputStreamInterface;</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/3cd84682/build/docs/c_glib/GArrowRandomAccessFile.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowRandomAccessFile.html b/build/docs/c_glib/GArrowRandomAccessFile.html new file mode 100644 index 0000000..e23ec93 --- /dev/null +++ b/build/docs/c_glib/GArrowRandomAccessFile.html @@ -0,0 +1,228 @@ +<!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: GArrowRandomAccessFile</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.html" title="Input"> +<link rel="prev" href="GArrowInputStream.html" title="GArrowInputStream"> +<link rel="next" href="output.html" title="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="#GArrowRandomAccessFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GArrowRandomAccessFile.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.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowInputStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="output.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowRandomAccessFile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowRandomAccessFile.top_of_page"></a>GArrowRandomAccessFile</span></h2> +<p>GArrowRandomAccessFile â File input interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowRandomAccessFile.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="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowRandomAccessFile.html#garrow-random-access-file-get-size" title="garrow_random_access_file_get_size ()">garrow_random_access_file_get_size</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="GArrowRandomAccessFile.html#garrow-random-access-file-get-support-zero-copy" title="garrow_random_access_file_get_support_zero_copy ()">garrow_random_access_file_get_support_zero_copy</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="GArrowRandomAccessFile.html#garrow-random-access-file-read-at" title="garrow_random_access_file_read_at ()">garrow_random_access_file_read_at</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowRandomAccessFile.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="GArrowRandomAccessFile.html#GArrowRandomAccessFileInterface" title="GArrowRandomAccessFileInterface">GArrowRandomAccessFileInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowRandomAccessFile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowRandomAccessFile +</pre> +</div> +<div class="refsect1"> +<a name="GArrowRandomAccessFile.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</span></a> is an interface for file input.</p> +</div> +<div class="refsect1"> +<a name="GArrowRandomAccessFile.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-random-access-file-get-size"></a><h3>garrow_random_access_file_get_size ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="guint64"><span class="returnvalue">guint64</span></GTKDOCLINK> +garrow_random_access_file_get_size (<em class="parameter"><code><a class="link" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</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.3.4.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="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</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.3.4.7.2.5"></a><h4>Returns</h4> +<p> The size of the file.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-random-access-file-get-support-zero-copy"></a><h3>garrow_random_access_file_get_support_zero_copy ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_random_access_file_get_support_zero_copy + (<em class="parameter"><code><a class="link" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</span></a> *file</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.3.3.4.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="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.3.4.7.3.5"></a><h4>Returns</h4> +<p> Whether zero copy read is supported or not.</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-random-access-file-read-at"></a><h3>garrow_random_access_file_read_at ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_random_access_file_read_at (<em class="parameter"><code><a class="link" href="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> position</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_bytes</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> *n_read_bytes</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint8"><span class="type">guint8</span></GTKDOCLINK> *buffer</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.3.4.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="GArrowRandomAccessFile.html" title="GArrowRandomAccessFile"><span class="type">GArrowRandomAccessFile</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The read start position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of bytes to be read.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_read_bytes</p></td> +<td class="parameter_description"><p> The read number of bytes. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p> The buffer to be read data. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_bytes]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p> Return location for a <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </p></td> +<td class="parameter_annotations"><span class="annotation">[nullable]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.3.4.7.4.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> +</div> +<div class="refsect1"> +<a name="GArrowRandomAccessFile.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowRandomAccessFileInterface"></a><h3>GArrowRandomAccessFileInterface</h3> +<pre class="programlisting">typedef struct _GArrowRandomAccessFileInterface GArrowRandomAccessFileInterface;</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/3cd84682/build/docs/c_glib/GArrowReadable.html ---------------------------------------------------------------------- diff --git a/build/docs/c_glib/GArrowReadable.html b/build/docs/c_glib/GArrowReadable.html new file mode 100644 index 0000000..865bf90 --- /dev/null +++ b/build/docs/c_glib/GArrowReadable.html @@ -0,0 +1,130 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowReadable: 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="input.html" title="Input"> +<link rel="prev" href="input.html" title="Input"> +<link rel="next" href="input-stream-classes.html" title="Input stream classes"> +<meta name="generator" content="GTK-Doc V1.25 (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="#GArrowReadable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowReadable.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.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="input.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="input-stream-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowReadable"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowReadable.top_of_page"></a>GArrowReadable</span></h2> +<p>GArrowReadable â Input interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowReadable.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowReadable.html#garrow-readable-read" title="garrow_readable_read ()">garrow_readable_read</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowReadable.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GArrowReadable.html#GArrowReadableInterface" title="GArrowReadableInterface">GArrowReadableInterface</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowReadable.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowReadable +</pre> +</div> +<div class="refsect1"> +<a name="GArrowReadable.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowReadable.html" title="GArrowReadable"><span class="type">GArrowReadable</span></a> is an interface for input. Input must be +readable.</p> +</div> +<div class="refsect1"> +<a name="GArrowReadable.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-readable-read"></a><h3>garrow_readable_read ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_readable_read (<em class="parameter"><code><a class="link" href="GArrowReadable.html" title="GArrowReadable"><span class="type">GArrowReadable</span></a> *readable</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_bytes</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-readable-read.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>readable</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowReadable.html" title="GArrowReadable"><span class="type">GArrowReadable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of bytes 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 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-readable-read.returns"></a><h4>Returns</h4> +<p> <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> that has read +data on success, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> if there was an error. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowReadable.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowReadableInterface"></a><h3>GArrowReadableInterface</h3> +<pre class="programlisting">typedef struct _GArrowReadableInterface GArrowReadableInterface;</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25</div> +</body> +</html>
