| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>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="file-system.html" title="File system"> |
| <link rel="prev" href="file-system.html" title="File system"> |
| <link rel="next" href="local-file-system.html" title="Local file system"> |
| <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="#file-system-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#file-system-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#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="file-system.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="file-system.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="local-file-system.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="file-system-classes"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="file-system-classes.top_of_page"></a>File system classes</span></h2> |
| <p>File system classes</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="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="file-system-classes.html#GArrowFileInfo"><span class="returnvalue">GArrowFileInfo</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-info-new" title="garrow_file_info_new ()">garrow_file_info_new</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="file-system-classes.html#garrow-file-info-equal" title="garrow_file_info_equal ()">garrow_file_info_equal</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="file-system-classes.html#garrow-file-info-is-file" title="garrow_file_info_is_file ()">garrow_file_info_is_file</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="file-system-classes.html#garrow-file-info-is-dir" title="garrow_file_info_is_dir ()">garrow_file_info_is_dir</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-info-to-string" title="garrow_file_info_to_string ()">garrow_file_info_to_string</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-get-type-name" title="garrow_file_system_get_type_name ()">garrow_file_system_get_type_name</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="returnvalue">GArrowFileInfo</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-get-file-info" title="garrow_file_system_get_file_info ()">garrow_file_system_get_file_info</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">GList</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-get-file-infos-paths" title="garrow_file_system_get_file_infos_paths ()">garrow_file_system_get_file_infos_paths</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">GList</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-get-file-infos-selector" title="garrow_file_system_get_file_infos_selector ()">garrow_file_system_get_file_infos_selector</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="file-system-classes.html#garrow-file-system-create-dir" title="garrow_file_system_create_dir ()">garrow_file_system_create_dir</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="file-system-classes.html#garrow-file-system-delete-dir" title="garrow_file_system_delete_dir ()">garrow_file_system_delete_dir</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="file-system-classes.html#garrow-file-system-delete-dir-contents" title="garrow_file_system_delete_dir_contents ()">garrow_file_system_delete_dir_contents</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="file-system-classes.html#garrow-file-system-delete-file" title="garrow_file_system_delete_file ()">garrow_file_system_delete_file</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="file-system-classes.html#garrow-file-system-delete-files" title="garrow_file_system_delete_files ()">garrow_file_system_delete_files</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="file-system-classes.html#garrow-file-system-move" title="garrow_file_system_move ()">garrow_file_system_move</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="file-system-classes.html#garrow-file-system-copy-file" title="garrow_file_system_copy_file ()">garrow_file_system_copy_file</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="returnvalue">GArrowInputStream</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-open-input-stream" title="garrow_file_system_open_input_stream ()">garrow_file_system_open_input_stream</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="returnvalue">GArrowSeekableInputStream</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-open-input-file" title="garrow_file_system_open_input_file ()">garrow_file_system_open_input_file</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="returnvalue">GArrowOutputStream</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-open-output-stream" title="garrow_file_system_open_output_stream ()">garrow_file_system_open_output_stream</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="returnvalue">GArrowOutputStream</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-file-system-open-append-stream" title="garrow_file_system_open_append_stream ()">garrow_file_system_open_append_stream</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="file-system-classes.html#GArrowSubTreeFileSystem"><span class="returnvalue">GArrowSubTreeFileSystem</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-sub-tree-file-system-new" title="garrow_sub_tree_file_system_new ()">garrow_sub_tree_file_system_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="returnvalue">GArrowSlowFileSystem</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-slow-file-system-new-average-latency" title="garrow_slow_file_system_new_average_latency ()">garrow_slow_file_system_new_average_latency</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="returnvalue">GArrowSlowFileSystem</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="file-system-classes.html#garrow-slow-file-system-new-average-latency-and-seed" title="garrow_slow_file_system_new_average_latency_and_seed ()">garrow_slow_file_system_new_average_latency_and_seed</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="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">gchar</span> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--base-name" title="The “base-name” property">base-name</a></td> |
| <td class="property_flags">Read</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <span class="type">gchar</span> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--dir-name" title="The “dir-name” property">dir-name</a></td> |
| <td class="property_flags">Read</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <span class="type">gchar</span> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--extension" title="The “extension” property">extension</a></td> |
| <td class="property_flags">Read</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint64</span></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--mtime" title="The “mtime” property">mtime</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <span class="type">gchar</span> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--path" title="The “path” property">path</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint64</span></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--size" title="The “size” property">size</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a class="link" href="file-system-classes.html#GArrowFileType" title="enum GArrowFileType"><span class="type">GArrowFileType</span></a></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileInfo--type" title="The “type” property">type</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileSelector--allow-not-found" title="The “allow-not-found” property">allow-not-found</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <span class="type">gchar</span> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileSelector--base-dir" title="The “base-dir” property">base-dir</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileSelector--max-recursion" title="The “max-recursion” property">max-recursion</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileSelector--recursive" title="The “recursive” property">recursive</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowFileSystem--file-system" title="The “file-system” property">file-system</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowSlowFileSystem--base-file-system" title="The “base-file-system” property">base-file-system</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *</td> |
| <td class="property_name"><a class="link" href="file-system-classes.html#GArrowSubTreeFileSystem--base-file-system" title="The “base-file-system” property">base-file-system</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <a name="GArrowFileInfo"></a><a name="GArrowFileSelector"></a><a name="GArrowFileSystem"></a><a name="GArrowSlowFileSystem"></a><a name="GArrowSubTreeFileSystem"></a><div class="refsect1"> |
| <a name="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="typedef_keyword">typedef</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowTimePoint" title="GArrowTimePoint">GArrowTimePoint</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">enum</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileType" title="enum GArrowFileType">GArrowFileType</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GARROW-TYPE-FILE-INFO:CAPS" title="GARROW_TYPE_FILE_INFO">GARROW_TYPE_FILE_INFO</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileInfoClass" title="struct GArrowFileInfoClass">GArrowFileInfoClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GARROW-TYPE-FILE-SELECTOR:CAPS" title="GARROW_TYPE_FILE_SELECTOR">GARROW_TYPE_FILE_SELECTOR</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileSelectorClass" title="struct GArrowFileSelectorClass">GArrowFileSelectorClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GARROW-TYPE-FILE-SYSTEM:CAPS" title="GARROW_TYPE_FILE_SYSTEM">GARROW_TYPE_FILE_SYSTEM</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileSystemClass" title="struct GArrowFileSystemClass">GArrowFileSystemClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GARROW-TYPE-SUB-TREE-FILE-SYSTEM:CAPS" title="GARROW_TYPE_SUB_TREE_FILE_SYSTEM">GARROW_TYPE_SUB_TREE_FILE_SYSTEM</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowSubTreeFileSystemClass" title="struct GArrowSubTreeFileSystemClass">GArrowSubTreeFileSystemClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GARROW-TYPE-SLOW-FILE-SYSTEM:CAPS" title="GARROW_TYPE_SLOW_FILE_SYSTEM">GARROW_TYPE_SLOW_FILE_SYSTEM</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowSlowFileSystemClass" title="struct GArrowSlowFileSystemClass">GArrowSlowFileSystemClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileInfo-struct" title="GArrowFileInfo">GArrowFileInfo</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileSelector-struct" title="GArrowFileSelector">GArrowFileSelector</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowFileSystem-struct" title="GArrowFileSystem">GArrowFileSystem</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowSlowFileSystem-struct" title="GArrowSlowFileSystem">GArrowSlowFileSystem</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="file-system-classes.html#GArrowSubTreeFileSystem-struct" title="GArrowSubTreeFileSystem">GArrowSubTreeFileSystem</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="file-system-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> |
| <span class="lineart">╰──</span> GArrowFileType |
| GObject |
| <span class="lineart">├──</span> GArrowFileInfo |
| <span class="lineart">├──</span> GArrowFileSelector |
| <span class="lineart">╰──</span> GArrowFileSystem |
| <span class="lineart">├──</span> <a class="link" href="local-file-system-classes.html#GArrowLocalFileSystem">GArrowLocalFileSystem</a> |
| <span class="lineart">├──</span> GArrowSlowFileSystem |
| <span class="lineart">╰──</span> GArrowSubTreeFileSystem |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="file-system-classes.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="file-system-classes.description"></a><h2>Description</h2> |
| <p><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> is a class for information for a file system entry.</p> |
| <p><a class="link" href="file-system-classes.html#GArrowFileSelector"><span class="type">GArrowFileSelector</span></a> is a class for a selector for file system APIs.</p> |
| <p><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> is an interface for file system.</p> |
| <p><a class="link" href="file-system-classes.html#GArrowSubTreeFileSystem"><span class="type">GArrowSubTreeFileSystem</span></a> is a delegator to another file system that is |
| a logical view of a subtree of a file system, such as a directory in |
| a local file system.</p> |
| <p><a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="type">GArrowSlowFileSystem</span></a> is a delegator to another file system. |
| This inserts latencies at various points.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="file-system-classes.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-file-info-new"></a><h3>garrow_file_info_new ()</h3> |
| <pre class="programlisting"><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="returnvalue">GArrowFileInfo</span></a> * |
| garrow_file_info_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-info-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>.</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-file-info-equal"></a><h3>garrow_file_info_equal ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_info_equal (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> *file_info</code></em>, |
| <em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> *other_file_info</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-info-equal.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_info</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>other_file_info</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> to be compared.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-info-equal.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> if both of them have the same data, <code class="literal">FALSE</code> |
| otherwise.</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-file-info-is-file"></a><h3>garrow_file_info_is_file ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_info_is_file (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> *file_info</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-info-is-file.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_info</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-info-is-file.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> if the entry is a file, <code class="literal">FALSE</code> otherwise.</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-file-info-is-dir"></a><h3>garrow_file_info_is_dir ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_info_is_dir (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> *file_info</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-info-is-dir.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_info</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-info-is-dir.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> if the entry is a directory, <code class="literal">FALSE</code> otherwise.</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-file-info-to-string"></a><h3>garrow_file_info_to_string ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> * |
| garrow_file_info_to_string (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a> *file_info</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-info-to-string.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_info</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-info-to-string.returns"></a><h4>Returns</h4> |
| <p> The string representation of the file statistics.</p> |
| <p> It should be freed with <code class="function">g_free()</code> when no longer needed.</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-file-system-get-type-name"></a><h3>garrow_file_system_get_type_name ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> * |
| garrow_file_system_get_type_name (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-file-system-get-type-name.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-file-system-get-type-name.returns"></a><h4>Returns</h4> |
| <p> The name of file system type.</p> |
| <p> It should be freed with <code class="function">g_free()</code> when no longer needed.</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-file-system-get-file-info"></a><h3>garrow_file_system_get_file_info ()</h3> |
| <pre class="programlisting"><a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="returnvalue">GArrowFileInfo</span></a> * |
| garrow_file_system_get_file_info (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Get information for the given target.</p> |
| <p>Any symlink is automatically dereferenced, recursively. |
| A non-existing or unreachable file returns an OK status and has |
| a <a class="link" href="file-system-classes.html#GArrowFileType" title="enum GArrowFileType"><span class="type">GArrowFileType</span></a> of value <a class="link" href="file-system-classes.html#GARROW-FILE-TYPE-NOT-FOUND:CAPS"><code class="literal">GARROW_FILE_TYPE_NOT_FOUND</code></a>. |
| An error status indicates a truly exceptional condition |
| (low-level I/O error, etc.).</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-get-file-info.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The path of the target.</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-system-get-file-info.returns"></a><h4>Returns</h4> |
| <p>A <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-system-get-file-infos-paths"></a><h3>garrow_file_system_get_file_infos_paths ()</h3> |
| <pre class="programlisting"><span class="returnvalue">GList</span> * |
| garrow_file_system_get_file_infos_paths |
| (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **paths</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_paths</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Get information same as <a class="link" href="file-system-classes.html#garrow-file-system-get-file-info" title="garrow_file_system_get_file_info ()"><code class="function">garrow_file_system_get_file_info()</code></a> |
| for the given many targets at once.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-get-file-infos-paths.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>paths</p></td> |
| <td class="parameter_description"><p>The paths of the targets. </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_paths]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_paths</p></td> |
| <td class="parameter_description"><p>The number of items in <em class="parameter"><code>paths</code></em> |
| .</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-system-get-file-infos-paths.returns"></a><h4>Returns</h4> |
| <p>A list of <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowFileInfo][<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-file-system-get-file-infos-selector"></a><h3>garrow_file_system_get_file_infos_selector ()</h3> |
| <pre class="programlisting"><span class="returnvalue">GList</span> * |
| garrow_file_system_get_file_infos_selector |
| (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSelector"><span class="type">GArrowFileSelector</span></a> *file_selector</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Get information same as <a class="link" href="file-system-classes.html#garrow-file-system-get-file-info" title="garrow_file_system_get_file_info ()"><code class="function">garrow_file_system_get_file_info()</code></a> |
| according to a selector.</p> |
| <p>The selector's base directory will not be part of the results, |
| even if it exists.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-get-file-infos-selector.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>file_selector</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSelector"><span class="type">GArrowFileSelector</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-system-get-file-infos-selector.returns"></a><h4>Returns</h4> |
| <p>A list of <a class="link" href="file-system-classes.html#GArrowFileInfo"><span class="type">GArrowFileInfo</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowFileInfo][<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-file-system-create-dir"></a><h3>garrow_file_system_create_dir ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_create_dir (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">gboolean</span> recursive</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Create a directory and subdirectories. |
| This function succeeds if the directory already exists.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-create-dir.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The paths of the directory.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>recursive</p></td> |
| <td class="parameter_description"><p>Whether creating directory recursively or not.</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-system-create-dir.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> |
| <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-file-system-delete-dir"></a><h3>garrow_file_system_delete_dir ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_delete_dir (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Delete a directory and its contents, recursively.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-delete-dir.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The paths of the directory.</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-system-delete-dir.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> |
| <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-file-system-delete-dir-contents"></a><h3>garrow_file_system_delete_dir_contents ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_delete_dir_contents |
| (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Delete a directory's contents, recursively. Like |
| <a class="link" href="file-system-classes.html#garrow-file-system-delete-dir" title="garrow_file_system_delete_dir ()"><code class="function">garrow_file_system_delete_dir()</code></a>, but doesn't delete the directory |
| itself. Passing an empty path (<code class="literal">""</code>) will wipe the entire file |
| system tree.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-delete-dir-contents.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The paths of the directory.</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-system-delete-dir-contents.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> |
| <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-file-system-delete-file"></a><h3>garrow_file_system_delete_file ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_delete_file (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Delete a file.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-delete-file.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The paths of the file to be delete.</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-system-delete-file.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> |
| <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-file-system-delete-files"></a><h3>garrow_file_system_delete_files ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_delete_files (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **paths</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_paths</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Delete many files.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-delete-files.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>paths</p></td> |
| <td class="parameter_description"><p>The paths of the files to be delete. </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_paths]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_paths</p></td> |
| <td class="parameter_description"><p>The number of items in <em class="parameter"><code>paths</code></em> |
| .</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-system-delete-files.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> |
| <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-file-system-move"></a><h3>garrow_file_system_move ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_move (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *src</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *dest</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Move / rename a file or a directory. |
| If the destination exists:</p> |
| <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| <li class="listitem"><p>if it is a non-empty directory, an error is returned</p></li> |
| <li class="listitem"><p>otherwise, if it has the same type as the source, it is replaced</p></li> |
| <li class="listitem"><p>otherwise, behavior is unspecified (implementation-dependent).</p></li> |
| </ul></div> |
| <div class="refsect3"> |
| <a name="garrow-file-system-move.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>src</p></td> |
| <td class="parameter_description"><p>The path of the source file.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>dest</p></td> |
| <td class="parameter_description"><p>The path of the destination.</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-system-move.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> |
| <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-file-system-copy-file"></a><h3>garrow_file_system_copy_file ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_file_system_copy_file (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *src</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *dest</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Copy a file. |
| If the destination exists and is a directory, an error is returned. |
| Otherwise, it is replaced.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-copy-file.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>src</p></td> |
| <td class="parameter_description"><p>The path of the source file.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>dest</p></td> |
| <td class="parameter_description"><p>The path of the destination.</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-system-copy-file.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> |
| <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-file-system-open-input-stream"></a><h3>garrow_file_system_open_input_stream ()</h3> |
| <pre class="programlisting"><a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="returnvalue">GArrowInputStream</span></a> * |
| garrow_file_system_open_input_stream (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Open an input stream for sequential reading.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-open-input-stream.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The path of the input stream.</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-system-open-input-stream.returns"></a><h4>Returns</h4> |
| <p>A newly created |
| <a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="type">GArrowInputStream</span></a>. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-system-open-input-file"></a><h3>garrow_file_system_open_input_file ()</h3> |
| <pre class="programlisting"><a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="returnvalue">GArrowSeekableInputStream</span></a> * |
| garrow_file_system_open_input_file (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Open an input file for random access reading.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-open-input-file.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The path of the input 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 <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-system-open-input-file.returns"></a><h4>Returns</h4> |
| <p>A newly created |
| <a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a>. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-system-open-output-stream"></a><h3>garrow_file_system_open_output_stream ()</h3> |
| <pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="returnvalue">GArrowOutputStream</span></a> * |
| garrow_file_system_open_output_stream (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Open an output stream for sequential writing. |
| If the target already exists, the existing data is truncated.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-open-output-stream.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The path of the output stream.</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-system-open-output-stream.returns"></a><h4>Returns</h4> |
| <p>A newly created |
| <a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a>. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-file-system-open-append-stream"></a><h3>garrow_file_system_open_append_stream ()</h3> |
| <pre class="programlisting"><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="returnvalue">GArrowOutputStream</span></a> * |
| garrow_file_system_open_append_stream (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *file_system</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>Open an output stream for appending. |
| If the target doesn't exist, a new empty file is created.</p> |
| <div class="refsect3"> |
| <a name="garrow-file-system-open-append-stream.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_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>path</p></td> |
| <td class="parameter_description"><p>The path of the output stream.</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-system-open-append-stream.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> |
| for appending. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-sub-tree-file-system-new"></a><h3>garrow_sub_tree_file_system_new ()</h3> |
| <pre class="programlisting"><a class="link" href="file-system-classes.html#GArrowSubTreeFileSystem"><span class="returnvalue">GArrowSubTreeFileSystem</span></a> * |
| garrow_sub_tree_file_system_new (<em class="parameter"><code>const <span class="type">gchar</span> *base_path</code></em>, |
| <em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *base_file_system</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-sub-tree-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>base_path</p></td> |
| <td class="parameter_description"><p>A base path of the sub tree file system.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>base_file_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> as the base file system.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-sub-tree-file-system-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="file-system-classes.html#GArrowSubTreeFileSystem"><span class="type">GArrowSubTreeFileSystem</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-slow-file-system-new-average-latency"></a><h3>garrow_slow_file_system_new_average_latency ()</h3> |
| <pre class="programlisting"><a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="returnvalue">GArrowSlowFileSystem</span></a> * |
| garrow_slow_file_system_new_average_latency |
| (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *base_file_system</code></em>, |
| <em class="parameter"><code><span class="type">gdouble</span> average_latency</code></em>);</pre> |
| <p>The latency is normally distributed with a standard deviation of |
| <em class="parameter"><code>average_latency</code></em> |
| * 0.1.</p> |
| <p>The random seed is given by the default random device.</p> |
| <div class="refsect3"> |
| <a name="garrow-slow-file-system-new-average-latency.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>base_file_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> as the base file system.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>average_latency</p></td> |
| <td class="parameter_description"><p>The average value of the latency.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-slow-file-system-new-average-latency.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="type">GArrowSlowFileSystem</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-slow-file-system-new-average-latency-and-seed"></a><h3>garrow_slow_file_system_new_average_latency_and_seed ()</h3> |
| <pre class="programlisting"><a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="returnvalue">GArrowSlowFileSystem</span></a> * |
| garrow_slow_file_system_new_average_latency_and_seed |
| (<em class="parameter"><code><a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *base_file_system</code></em>, |
| <em class="parameter"><code><span class="type">gdouble</span> average_latency</code></em>, |
| <em class="parameter"><code><span class="type">gint32</span> seed</code></em>);</pre> |
| <p>The latency is normally distributed with a standard deviation of |
| <em class="parameter"><code>average_latency</code></em> |
| * 0.1.</p> |
| <div class="refsect3"> |
| <a name="garrow-slow-file-system-new-average-latency-and-seed.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>base_file_system</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> as the base file system.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>average_latency</p></td> |
| <td class="parameter_description"><p>The average value of the latency.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>seed</p></td> |
| <td class="parameter_description"><p>A random seed.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-slow-file-system-new-average-latency-and-seed.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="file-system-classes.html#GArrowSlowFileSystem"><span class="type">GArrowSlowFileSystem</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="file-system-classes.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GArrowTimePoint"></a><h3>GArrowTimePoint</h3> |
| <pre class="programlisting">typedef gint64 GArrowTimePoint; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileType"></a><h3>enum GArrowFileType</h3> |
| <p>They are corresponding to <code class="literal">arrow::fs::FileType</code> values.</p> |
| <div class="refsect3"> |
| <a name="GArrowFileType.members"></a><h4>Members</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="300px" class="enum_members_name"> |
| <col class="enum_members_description"> |
| <col width="200px" class="enum_members_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-FILE-TYPE-NOT-FOUND:CAPS"></a>GARROW_FILE_TYPE_NOT_FOUND</p></td> |
| <td class="enum_member_description"> |
| <p>Entry is not found</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-FILE-TYPE-UNKNOWN:CAPS"></a>GARROW_FILE_TYPE_UNKNOWN</p></td> |
| <td class="enum_member_description"> |
| <p>Entry exists but its type is unknown</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-FILE-TYPE-FILE:CAPS"></a>GARROW_FILE_TYPE_FILE</p></td> |
| <td class="enum_member_description"> |
| <p>Entry is a regular file</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-FILE-TYPE-DIR:CAPS"></a>GARROW_FILE_TYPE_DIR</p></td> |
| <td class="enum_member_description"> |
| <p>Entry is a directory</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-FILE-INFO:CAPS"></a><h3>GARROW_TYPE_FILE_INFO</h3> |
| <pre class="programlisting">#define GARROW_TYPE_FILE_INFO (garrow_file_info_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfoClass"></a><h3>struct GArrowFileInfoClass</h3> |
| <pre class="programlisting">struct GArrowFileInfoClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-FILE-SELECTOR:CAPS"></a><h3>GARROW_TYPE_FILE_SELECTOR</h3> |
| <pre class="programlisting">#define GARROW_TYPE_FILE_SELECTOR (garrow_file_selector_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSelectorClass"></a><h3>struct GArrowFileSelectorClass</h3> |
| <pre class="programlisting">struct GArrowFileSelectorClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-FILE-SYSTEM:CAPS"></a><h3>GARROW_TYPE_FILE_SYSTEM</h3> |
| <pre class="programlisting">#define GARROW_TYPE_FILE_SYSTEM (garrow_file_system_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSystemClass"></a><h3>struct GArrowFileSystemClass</h3> |
| <pre class="programlisting">struct GArrowFileSystemClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-SUB-TREE-FILE-SYSTEM:CAPS"></a><h3>GARROW_TYPE_SUB_TREE_FILE_SYSTEM</h3> |
| <pre class="programlisting">#define GARROW_TYPE_SUB_TREE_FILE_SYSTEM (garrow_sub_tree_file_system_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowSubTreeFileSystemClass"></a><h3>struct GArrowSubTreeFileSystemClass</h3> |
| <pre class="programlisting">struct GArrowSubTreeFileSystemClass { |
| GArrowFileSystemClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-SLOW-FILE-SYSTEM:CAPS"></a><h3>GARROW_TYPE_SLOW_FILE_SYSTEM</h3> |
| <pre class="programlisting">#define GARROW_TYPE_SLOW_FILE_SYSTEM (garrow_slow_file_system_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowSlowFileSystemClass"></a><h3>struct GArrowSlowFileSystemClass</h3> |
| <pre class="programlisting">struct GArrowSlowFileSystemClass { |
| GArrowFileSystemClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo-struct"></a><h3>GArrowFileInfo</h3> |
| <pre class="programlisting">typedef struct _GArrowFileInfo GArrowFileInfo;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSelector-struct"></a><h3>GArrowFileSelector</h3> |
| <pre class="programlisting">typedef struct _GArrowFileSelector GArrowFileSelector;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSystem-struct"></a><h3>GArrowFileSystem</h3> |
| <pre class="programlisting">typedef struct _GArrowFileSystem GArrowFileSystem;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowSlowFileSystem-struct"></a><h3>GArrowSlowFileSystem</h3> |
| <pre class="programlisting">typedef struct _GArrowSlowFileSystem GArrowSlowFileSystem;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowSubTreeFileSystem-struct"></a><h3>GArrowSubTreeFileSystem</h3> |
| <pre class="programlisting">typedef struct _GArrowSubTreeFileSystem GArrowSubTreeFileSystem;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="file-system-classes.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--base-name"></a><h3>The <code class="literal">“base-name”</code> property</h3> |
| <pre class="programlisting"> “base-name” <span class="type">gchar</span> *</pre> |
| <p>The file base name (component after the last directory separator).</p> |
| <p>Flags: Read</p> |
| <p>Default value: ""</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--dir-name"></a><h3>The <code class="literal">“dir-name”</code> property</h3> |
| <pre class="programlisting"> “dir-name” <span class="type">gchar</span> *</pre> |
| <p>The directory base name (component before the file base name).</p> |
| <p>Flags: Read</p> |
| <p>Default value: ""</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--extension"></a><h3>The <code class="literal">“extension”</code> property</h3> |
| <pre class="programlisting"> “extension” <span class="type">gchar</span> *</pre> |
| <p>The file extension (excluding the dot).</p> |
| <p>Flags: Read</p> |
| <p>Default value: ""</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--mtime"></a><h3>The <code class="literal">“mtime”</code> property</h3> |
| <pre class="programlisting"> “mtime” <span class="type">gint64</span></pre> |
| <p>The time of last modification, if available.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= -1</p> |
| <p>Default value: -1</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--path"></a><h3>The <code class="literal">“path”</code> property</h3> |
| <pre class="programlisting"> “path” <span class="type">gchar</span> *</pre> |
| <p>The full file path in the file system.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: ""</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--size"></a><h3>The <code class="literal">“size”</code> property</h3> |
| <pre class="programlisting"> “size” <span class="type">gint64</span></pre> |
| <p>The size in bytes, if available |
| Only regular files are guaranteed to have a size.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= -1</p> |
| <p>Default value: -1</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileInfo--type"></a><h3>The <code class="literal">“type”</code> property</h3> |
| <pre class="programlisting"> “type” <a class="link" href="file-system-classes.html#GArrowFileType" title="enum GArrowFileType"><span class="type">GArrowFileType</span></a></pre> |
| <p>The type of the entry.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: GARROW_FILE_TYPE_UNKNOWN</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSelector--allow-not-found"></a><h3>The <code class="literal">“allow-not-found”</code> property</h3> |
| <pre class="programlisting"> “allow-not-found” <span class="type">gboolean</span></pre> |
| <p>The behavior if <code class="literal">base_dir</code> isn't found in the file system. |
| If false, an error is returned. If true, an empty selection is returned.</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSelector--base-dir"></a><h3>The <code class="literal">“base-dir”</code> property</h3> |
| <pre class="programlisting"> “base-dir” <span class="type">gchar</span> *</pre> |
| <p>The directory in which to select files. |
| If the path exists but doesn't point to a directory, this should |
| be an error.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: ""</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSelector--max-recursion"></a><h3>The <code class="literal">“max-recursion”</code> property</h3> |
| <pre class="programlisting"> “max-recursion” <span class="type">gint</span></pre> |
| <p>The maximum number of subdirectories to recurse into.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 2147483647</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSelector--recursive"></a><h3>The <code class="literal">“recursive”</code> property</h3> |
| <pre class="programlisting"> “recursive” <span class="type">gboolean</span></pre> |
| <p>Whether to recurse into subdirectories.</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> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFileSystem--file-system"></a><h3>The <code class="literal">“file-system”</code> property</h3> |
| <pre class="programlisting"> “file-system” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::fs::FileSystem> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowSlowFileSystem--base-file-system"></a><h3>The <code class="literal">“base-file-system”</code> property</h3> |
| <pre class="programlisting"> “base-file-system” <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *</pre> |
| <p>The base GArrowFileSystem.</p> |
| <p>Flags: Read / Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowSubTreeFileSystem--base-file-system"></a><h3>The <code class="literal">“base-file-system”</code> property</h3> |
| <pre class="programlisting"> “base-file-system” <a class="link" href="file-system-classes.html#GArrowFileSystem"><span class="type">GArrowFileSystem</span></a> *</pre> |
| <p>The base GArrowFileSystem.</p> |
| <p>Flags: Read / Write / Construct Only</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> |
