| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GArrowFile: 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-output.html" title="Input and output"> |
| <link rel="prev" href="input-output.html" title="Input and output"> |
| <link rel="next" href="ipc.html" title="Part IV. IPC"> |
| <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="#GArrowFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GArrowFile.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> |
| <a href="#GArrowFile.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span> |
| <a href="#GArrowFile.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-output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="input-output.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="ipc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GArrowFile"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GArrowFile.top_of_page"></a>GArrowFile</span></h2> |
| <p>GArrowFile — File interface</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GArrowFile.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowFile.html#garrow-file-close" title="garrow_file_close ()">garrow_file_close</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowFile.html#garrow-file-is-closed" title="garrow_file_is_closed ()">garrow_file_is_closed</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gint64</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowFile.html#garrow-file-tell" title="garrow_file_tell ()">garrow_file_tell</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="returnvalue">GArrowFileMode</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowFile.html#garrow-file-get-mode" title="garrow_file_get_mode ()">garrow_file_get_mode</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table 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="GArrowFile.html#GARROW-TYPE-FILE:CAPS" title="GARROW_TYPE_FILE">GARROW_TYPE_FILE</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowFile.html#GArrowFile-struct" title="GArrowFile">GArrowFile</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowFile.html#GArrowFileInterface" title="GArrowFileInterface">GArrowFileInterface</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> |
| <span class="lineart">╰──</span> GArrowFile |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.prerequisites"></a><h2>Prerequisites</h2> |
| <p> |
| GArrowFile requires |
| GObject.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.implementations"></a><h2>Known Implementations</h2> |
| <p> |
| GArrowFile is implemented by |
| <a class="link" href="input-stream-classes.html#GArrowBufferInputStream">GArrowBufferInputStream</a>, <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream">GArrowBufferOutputStream</a>, <a class="link" href="cuda-classes.html#GArrowCUDABufferInputStream">GArrowCUDABufferInputStream</a>, <a class="link" href="cuda-classes.html#GArrowCUDABufferOutputStream">GArrowCUDABufferOutputStream</a>, <a class="link" href="input-stream-classes.html#GArrowCompressedInputStream">GArrowCompressedInputStream</a>, <a class="link" href="output-stream-classes.html#GArrowCompressedOutputStream">GArrowCompressedOutputStream</a>, <a class="link" href="output-stream-classes.html#GArrowFileOutputStream">GArrowFileOutputStream</a>, <a class="link" href="input-stream-classes.html#GArrowGIOInputStream">GArrowGIOInputStream</a>, <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream">GArrowGIOOutputStream</a>, <a class="link" href="input-stream-classes.html#GArrowInputStream">GArrowInputStream</a>, <a class="link" href="input-stream-classes.html#GArrowMemoryMappedInputStream">GArrowMemoryMappedInputStream</a>, <a class="link" href="output-stream-classes.html#GArrowOutputStream">GArrowOutputStream</a> and <a class="link" href="input-stream-classes.html#GArrowSeekableInputStream">GArrowSeekableInputStream</a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.description"></a><h2>Description</h2> |
| <p><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> is an interface for file.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-file-close"></a><h3>garrow_file_close ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_close (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-close.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>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </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-close.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if there was an error.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-is-closed"></a><h3>garrow_file_is_closed ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_is_closed (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-is-closed.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>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-is-closed.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> if the <em class="parameter"><code>file</code></em> |
| is already closed, <code class="literal">FALSE</code> otherwise.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-13-0.html#api-index-0.13.0">0.13.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-tell"></a><h3>garrow_file_tell ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gint64</span> |
| garrow_file_tell (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-tell.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>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </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-tell.returns"></a><h4>Returns</h4> |
| <p> The current offset on success, -1 if there was an error.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-get-mode"></a><h3>garrow_file_get_mode ()</h3> |
| <pre class="programlisting"><a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="returnvalue">GArrowFileMode</span></a> |
| garrow_file_get_mode (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-get-mode.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>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-get-mode.returns"></a><h4>Returns</h4> |
| <p> The mode of the file.</p> |
| </div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowFile.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-FILE:CAPS"></a><h3>GARROW_TYPE_FILE</h3> |
| <pre class="programlisting">#define GARROW_TYPE_FILE (garrow_file_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFile-struct"></a><h3>GArrowFile</h3> |
| <pre class="programlisting">typedef struct _GArrowFile GArrowFile;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInterface"></a><h3>GArrowFileInterface</h3> |
| <pre class="programlisting">typedef struct _GArrowFileInterface GArrowFileInterface;</pre> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
