blob: 7cffdbe361da787d5ac6286df248f90c66917a82 [file] [log] [blame]
<!--
SPDX-FileCopyrightText: The Apache Software Foundation
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Arrow.File</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="Arrow.File"/>
<meta property="og:description" content="Reference for Arrow.File"/>
<meta name="twitter:title" content="Arrow.File"/>
<meta name="twitter:description" content="Reference for Arrow.File"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Arrow</a></h3>
<p>API Version: 1.0</p>
<p>Library Version: 22.0.0.dev</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="iface.File.html#description">File</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.File.close.html">close</a>
<a class="method" href="method.File.get_mode.html">get_mode</a>
<a class="method" href="method.File.is_closed.html">is_closed</a>
<a class="method" href="method.File.tell.html">tell</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Interface</h3>
<h1><a href="index.html">Arrow</a><span class="sep"></span>File</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
</h4>
<pre><code>interface Arrow.File : GObject.Object</code></pre>
<div class="docblock">
No description available.
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper prerequisite">
<h4 id="prerequisite">
Prerequisite
<a href="#prerequisite" class="anchor"></a>
</h4>
<div class="docblock">
<p>In order to implement File, your type must inherit from<a data-namespace="GObject" data-link="class.Object.html" href="javascript:void(0)" class="external"><code>GObject</code></a>.</p>
</div>
</div>
<div class="implementations toggle-wrapper default-hide">
<h4 id="implementations">Implementations<a href="#implementations" class="anchor"></a></h4>
<div class="docblock">
<ul>
<li><a href="class.BufferInputStream.html">GArrowBufferInputStream</a></li>
<li><a href="class.BufferOutputStream.html">GArrowBufferOutputStream</a></li>
<li><a href="class.CompressedInputStream.html">GArrowCompressedInputStream</a></li>
<li><a href="class.CompressedOutputStream.html">GArrowCompressedOutputStream</a></li>
<li><a href="class.FileInputStream.html">GArrowFileInputStream</a></li>
<li><a href="class.FileOutputStream.html">GArrowFileOutputStream</a></li>
<li><a href="class.GIOInputStream.html">GArrowGIOInputStream</a></li>
<li><a href="class.GIOOutputStream.html">GArrowGIOOutputStream</a></li>
<li><a href="class.InputStream.html">GArrowInputStream</a></li>
<li><a href="class.MemoryMappedInputStream.html">GArrowMemoryMappedInputStream</a></li>
<li><a href="class.OutputStream.html">GArrowOutputStream</a></li>
<li><a href="class.SeekableInputStream.html">GArrowSeekableInputStream</a></li>
</ul>
</div>
</div>
<div class="methods toggle-wrapper">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.File.close.html">garrow_file_close</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.File.get_mode.html">garrow_file_get_mode</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.File.is_closed.html">garrow_file_is_closed</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.13.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.File.tell.html">garrow_file_tell</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="interface toggle-wrapper default-hide">
<h4 style="display:flex;" id="interface-struct">
Interface structure
<a href="#interface-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ArrowFileInterface {
/* no available fields */
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>