blob: 5606aed057b7d9060d93043afad8facc6b06bb7d [file] [log] [blame]
<!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: Apache Arrow GLib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Apache 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.32 (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><span id="nav_prerequisites">  <span class="dim">|</span> 
<a href="#GArrowReadable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
<a href="#GArrowReadable.implementations" class="shortcut">Known Implementations</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_proto_type">
<col class="functions_proto_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>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> *
</td>
<td class="function_name">
<a class="link" href="GArrowReadable.html#garrow-readable-read-bytes" title="garrow_readable_read_bytes ()">garrow_readable_read_bytes</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="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GArrowReadable.html#GARROW-TYPE-READABLE:CAPS" title="GARROW_TYPE_READABLE">GARROW_TYPE_READABLE</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GArrowReadable.html#GArrowReadable-struct" title="GArrowReadable">GArrowReadable</a></td>
</tr>
<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"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> GArrowReadable
</pre>
</div>
<div class="refsect1">
<a name="GArrowReadable.prerequisites"></a><h2>Prerequisites</h2>
<p>
GArrowReadable requires
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="GArrowReadable.implementations"></a><h2>Known Implementations</h2>
<p>
GArrowReadable is implemented by
<a class="link" href="input-stream-classes.html#GArrowBufferInputStream">GArrowBufferInputStream</a>, <a class="link" href="cuda-classes.html#GArrowCUDABufferInputStream">GArrowCUDABufferInputStream</a>, <a class="link" href="input-stream-classes.html#GArrowCompressedInputStream">GArrowCompressedInputStream</a>, <a class="link" href="input-stream-classes.html#GArrowFileInputStream">GArrowFileInputStream</a>, <a class="link" href="input-stream-classes.html#GArrowGIOInputStream">GArrowGIOInputStream</a>, <a class="link" href="input-stream-classes.html#GArrowInputStream">GArrowInputStream</a>, <a class="link" href="input-stream-classes.html#GArrowMemoryMappedInputStream">GArrowMemoryMappedInputStream</a> and <a class="link" href="input-stream-classes.html#GArrowSeekableInputStream">GArrowSeekableInputStream</a>.</p>
</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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> n_bytes</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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>
<hr>
<div class="refsect2">
<a name="garrow-readable-read-bytes"></a><h3>garrow_readable_read_bytes ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GBytes"><span class="returnvalue">GBytes</span></a> *
garrow_readable_read_bytes (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> n_bytes</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="refsect3">
<a name="garrow-readable-read-bytes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-bytes.returns"></a><h4>Returns</h4>
<p><a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> that has read data on
success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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>
<p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GArrowReadable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GARROW-TYPE-READABLE:CAPS"></a><h3>GARROW_TYPE_READABLE</h3>
<pre class="programlisting">#define GARROW_TYPE_READABLE (garrow_readable_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GArrowReadable-struct"></a><h3>GArrowReadable</h3>
<pre class="programlisting">typedef struct _GArrowReadable GArrowReadable;</pre>
</div>
<hr>
<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.32</div>
<script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body>
</html>