| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Local file system classes: 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="local-file-system.html" title="Local file system"> |
| <link rel="prev" href="local-file-system.html" title="Local file system"> |
| <link rel="next" href="io.html" title="Part III. IO"> |
| <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="#local-file-system-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#local-file-system-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#local-file-system-classes.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="local-file-system.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="local-file-system.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="io.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="local-file-system-classes"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="local-file-system-classes.top_of_page"></a>Local file system classes</span></h2> |
| <p>Local file system classes</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions"><span class="returnvalue">GArrowLocalFileSystemOptions</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="local-file-system-classes.html#garrow-local-file-system-options-new" title="garrow_local_file_system_options_new ()">garrow_local_file_system_options_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem"><span class="returnvalue">GArrowLocalFileSystem</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="local-file-system-classes.html#garrow-local-file-system-new" title="garrow_local_file_system_new ()">garrow_local_file_system_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody><tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions--use-mmap" title="The “use-mmap” property">use-mmap</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <a name="GArrowLocalFileSystem"></a><a name="GArrowLocalFileSystemOptions"></a><div class="refsect1"> |
| <a name="local-file-system-classes.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="local-file-system-classes.html#GARROW-TYPE-LOCAL-FILE-SYSTEM-OPTIONS:CAPS" title="GARROW_TYPE_LOCAL_FILE_SYSTEM_OPTIONS">GARROW_TYPE_LOCAL_FILE_SYSTEM_OPTIONS</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptionsClass" title="struct GArrowLocalFileSystemOptionsClass">GArrowLocalFileSystemOptionsClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="local-file-system-classes.html#GARROW-TYPE-LOCAL-FILE-SYSTEM:CAPS" title="GARROW_TYPE_LOCAL_FILE_SYSTEM">GARROW_TYPE_LOCAL_FILE_SYSTEM</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemClass" title="struct GArrowLocalFileSystemClass">GArrowLocalFileSystemClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem-struct" title="GArrowLocalFileSystem">GArrowLocalFileSystem</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions-struct" title="GArrowLocalFileSystemOptions">GArrowLocalFileSystemOptions</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> GObject |
| <span class="lineart">├──</span> <a class="link" href="file-system-classes.html#GArrowFileSystem">GArrowFileSystem</a> |
| <span class="lineart">│</span> <span class="lineart">╰──</span> GArrowLocalFileSystem |
| <span class="lineart">╰──</span> GArrowLocalFileSystemOptions |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.description"></a><h2>Description</h2> |
| <p><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions"><span class="type">GArrowLocalFileSystemOptions</span></a> is a class for specifyiing options of |
| an instance of <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem"><span class="type">GArrowLocalFileSystem</span></a>.</p> |
| <p><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem"><span class="type">GArrowLocalFileSystem</span></a> is a class for an implementation of a file system |
| that accesses files on the local machine.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-local-file-system-options-new"></a><h3>garrow_local_file_system_options_new ()</h3> |
| <pre class="programlisting"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions"><span class="returnvalue">GArrowLocalFileSystemOptions</span></a> * |
| garrow_local_file_system_options_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-local-file-system-options-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions"><span class="type">GArrowLocalFileSystemOptions</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <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> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-local-file-system-new"></a><h3>garrow_local_file_system_new ()</h3> |
| <pre class="programlisting"><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem"><span class="returnvalue">GArrowLocalFileSystem</span></a> * |
| garrow_local_file_system_new (<em class="parameter"><code><a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions"><span class="type">GArrowLocalFileSystemOptions</span></a> *options</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-local-file-system-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystemOptions"><span class="type">GArrowLocalFileSystemOptions</span></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-local-file-system-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem"><span class="type">GArrowLocalFileSystem</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <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="local-file-system-classes.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-LOCAL-FILE-SYSTEM-OPTIONS:CAPS"></a><h3>GARROW_TYPE_LOCAL_FILE_SYSTEM_OPTIONS</h3> |
| <pre class="programlisting">#define GARROW_TYPE_LOCAL_FILE_SYSTEM_OPTIONS (garrow_local_file_system_options_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowLocalFileSystemOptionsClass"></a><h3>struct GArrowLocalFileSystemOptionsClass</h3> |
| <pre class="programlisting">struct GArrowLocalFileSystemOptionsClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-LOCAL-FILE-SYSTEM:CAPS"></a><h3>GARROW_TYPE_LOCAL_FILE_SYSTEM</h3> |
| <pre class="programlisting">#define GARROW_TYPE_LOCAL_FILE_SYSTEM (garrow_local_file_system_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowLocalFileSystemClass"></a><h3>struct GArrowLocalFileSystemClass</h3> |
| <pre class="programlisting">struct GArrowLocalFileSystemClass { |
| GArrowFileSystemClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowLocalFileSystem-struct"></a><h3>GArrowLocalFileSystem</h3> |
| <pre class="programlisting">typedef struct _GArrowLocalFileSystem GArrowLocalFileSystem;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowLocalFileSystemOptions-struct"></a><h3>GArrowLocalFileSystemOptions</h3> |
| <pre class="programlisting">typedef struct _GArrowLocalFileSystemOptions GArrowLocalFileSystemOptions;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="local-file-system-classes.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowLocalFileSystemOptions--use-mmap"></a><h3>The <code class="literal">“use-mmap”</code> property</h3> |
| <pre class="programlisting"> “use-mmap” <span class="type">gboolean</span></pre> |
| <p>Whether open_input_stream and open_input_file return a mmap'ed file, |
| or a regular one.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <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> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
