| <!-- |
| SPDX-FileCopyrightText: The Apache Software Foundation |
| |
| SPDX-License-Identifier: Apache-2.0 |
| --> |
| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>Arrow.SeekableInputStream</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.SeekableInputStream"/> |
| <meta property="og:description" content="Reference for Arrow.SeekableInputStream"/> |
| <meta name="twitter:title" content="Arrow.SeekableInputStream"/> |
| <meta name="twitter:description" content="Reference for Arrow.SeekableInputStream"/> |
| |
| |
| |
| <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="class.SeekableInputStream.html#description">SeekableInputStream</a> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="section"> |
| <h5>Instance methods</h5> |
| <div class="links"> |
| |
| <a class="method" href="method.SeekableInputStream.get_size.html">get_size</a> |
| |
| <a class="method" href="method.SeekableInputStream.get_support_zero_copy.html">get_support_zero_copy</a> |
| |
| <a class="method" href="method.SeekableInputStream.peek.html">peek</a> |
| |
| <a class="method" href="method.SeekableInputStream.read_at.html">read_at</a> |
| |
| <a class="method" href="method.SeekableInputStream.read_at_bytes.html">read_at_bytes</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>Class</h3> |
| <h1 aria-label="Name"><a href="index.html">Arrow</a><span class="sep" role="presentation"></span>SeekableInputStream</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>class Arrow.SeekableInputStream : Arrow.InputStream { |
| parent_instance: GArrowInputStream |
| }</pre></code> |
| |
| <div class="docblock"> |
| No description available. |
| </div> |
| |
| <div class="docblock"> |
| |
| |
| |
| </div> |
| |
| |
| </div> |
| </summary> |
| |
| |
| |
| |
| <div class="toggle-wrapper ancestors"> |
| <h4 id="ancestors"> |
| Ancestors |
| <a href="#ancestors" class="anchor"></a> |
| </h4> |
| |
| <div class="docblock"> |
| <ul> |
| |
| |
| <li class="class"><a href="class.InputStream.html" title="InputStream">GArrowInputStream</a></li> |
| |
| |
| |
| <li class="class"><a class="external" href="javascript:void(0)" data-link="class.InputStream.html" data-namespace="Gio">GInputStream</a></li> |
| |
| |
| |
| <li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li> |
| |
| |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| <div class="descendants toggle-wrapper default-hide"> |
| <h4 id="descendants">Descendants <a href="#descendants" class="anchor"></a></h4> |
| <div class="docblock"> |
| <ul> |
| <li class="class"><a href="class.BufferInputStream.html" title="BufferInputStream">GArrowBufferInputStream</a></li> |
| |
| <li class="class"><a href="class.FileInputStream.html" title="FileInputStream">GArrowFileInputStream</a></li> |
| |
| <li class="class"><a href="class.GIOInputStream.html" title="GIOInputStream">GArrowGIOInputStream</a></li> |
| |
| <li class="class"><a href="class.MemoryMappedInputStream.html" title="MemoryMappedInputStream">GArrowMemoryMappedInputStream</a></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| <div class="toggle-wrapper implements"> |
| <h4 id="implements"> |
| Implements |
| <a href="#implements" class="anchor"></a> |
| </h4> |
| |
| <div class="docblock"> |
| <ul> |
| |
| |
| <li class="interface"><a href="iface.File.html" title="File">GArrowFile</a></li> |
| |
| |
| |
| <li class="interface"><a href="iface.Readable.html" title="Readable">GArrowReadable</a></li> |
| |
| |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <div class="toggle-wrapper methods"> |
| <h4 id="methods"> |
| Instance methods |
| <a href="#methods" class="anchor"></a> |
| </h4> |
| |
| <div class="docblock"> |
| |
| <div class=""> |
| <h6><a href="method.SeekableInputStream.get_size.html">garrow_seekable_input_stream_get_size</a></h6> |
| <div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| </div> |
| |
| <div class=""> |
| <h6><a href="method.SeekableInputStream.get_support_zero_copy.html">garrow_seekable_input_stream_get_support_zero_copy</a></h6> |
| <div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| </div> |
| |
| <div class=""> |
| <h6><a href="method.SeekableInputStream.peek.html">garrow_seekable_input_stream_peek</a></h6> |
| <div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 0.12.0</span></p> |
| </div> |
| </div> |
| |
| <div class=""> |
| <h6><a href="method.SeekableInputStream.read_at.html">garrow_seekable_input_stream_read_at</a></h6> |
| <div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| </div> |
| |
| <div class=""> |
| <h6><a href="method.SeekableInputStream.read_at_bytes.html">garrow_seekable_input_stream_read_at_bytes</a></h6> |
| <div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 0.15.0</span></p> |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="toggle-wrapper default-hide ancestor-methods"> |
| <h5 style="display:block;">Methods inherited from <a href="class.InputStream.html">GArrowInputStream</a> (4)</h5><div class="docblock"> |
| |
| <h6><a href="method.InputStream.advance.html">garrow_input_stream_advance</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 0.11.0</span></p> |
| </div> |
| |
| <h6><a href="method.InputStream.align.html">garrow_input_stream_align</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 0.11.0</span></p> |
| </div> |
| |
| <h6><a href="method.InputStream.read_record_batch.html">garrow_input_stream_read_record_batch</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 1.0.0</span></p> |
| </div> |
| |
| <h6><a href="method.InputStream.read_tensor.html">garrow_input_stream_read_tensor</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 0.11.0</span></p> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| <div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.InputStream.html" data-namespace="Gio">GInputStream</a> (19)</h5> |
| <div class="docblock"> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.clear_pending.html">g_input_stream_clear_pending</a></h6> |
| <div class="docblock"> |
| <p>Clears the pending flag on <code>stream</code>.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.close.html">g_input_stream_close</a></h6> |
| <div class="docblock"> |
| <p>Closes the stream, releasing resources related to it.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.close_async.html">g_input_stream_close_async</a></h6> |
| <div class="docblock"> |
| <p>Requests an asynchronous closes of the stream, releasing resources related to it. |
| When the operation is finished <code>callback</code> will be called. |
| You can then call <code>g_input_stream_close_finish()</code> to get the result of the operation.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.close_finish.html">g_input_stream_close_finish</a></h6> |
| <div class="docblock"> |
| <p>Finishes closing a stream asynchronously, started from g_input_stream_close_async().</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.has_pending.html">g_input_stream_has_pending</a></h6> |
| <div class="docblock"> |
| <p>Checks if an input stream has pending actions.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.is_closed.html">g_input_stream_is_closed</a></h6> |
| <div class="docblock"> |
| <p>Checks if an input stream is closed.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read.html">g_input_stream_read</a></h6> |
| <div class="docblock"> |
| <p>Tries to read <code>count</code> bytes from the stream into the buffer starting at |
| <code>buffer</code>. Will block during this read.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_all.html">g_input_stream_read_all</a></h6> |
| <div class="docblock"> |
| <p>Tries to read <code>count</code> bytes from the stream into the buffer starting at |
| <code>buffer</code>. Will block during this read.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_all_async.html">g_input_stream_read_all_async</a></h6> |
| <div class="docblock"> |
| <p>Request an asynchronous read of <code>count</code> bytes from the stream into the |
| buffer starting at <code>buffer</code>.</p> |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 2.44</span></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_all_finish.html">g_input_stream_read_all_finish</a></h6> |
| <div class="docblock"> |
| <p>Finishes an asynchronous stream read operation started with g_input_stream_read_all_async().</p> |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 2.44</span></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_async.html">g_input_stream_read_async</a></h6> |
| <div class="docblock"> |
| <p>Request an asynchronous read of <code>count</code> bytes from the stream into the buffer |
| starting at <code>buffer</code>. When the operation is finished <code>callback</code> will be called. |
| You can then call <code>g_input_stream_read_finish()</code> to get the result of the operation.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_bytes.html">g_input_stream_read_bytes</a></h6> |
| <div class="docblock"> |
| <p>Like g_input_stream_read(), this tries to read <code>count</code> bytes from |
| the stream in a blocking fashion. However, rather than reading into |
| a user-supplied buffer, this will create a new <code>GBytes</code> containing |
| the data that was read. This may be easier to use from language bindings.</p> |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 2.34</span></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_bytes_async.html">g_input_stream_read_bytes_async</a></h6> |
| <div class="docblock"> |
| <p>Request an asynchronous read of <code>count</code> bytes from the stream into a |
| new <code>GBytes</code>. When the operation is finished <code>callback</code> will be |
| called. You can then call <code>g_input_stream_read_bytes_finish()</code> to get the |
| result of the operation.</p> |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 2.34</span></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_bytes_finish.html">g_input_stream_read_bytes_finish</a></h6> |
| <div class="docblock"> |
| <p>Finishes an asynchronous stream read-into-<code>GBytes</code> operation.</p> |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 2.34</span></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.read_finish.html">g_input_stream_read_finish</a></h6> |
| <div class="docblock"> |
| <p>Finishes an asynchronous stream read operation.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.set_pending.html">g_input_stream_set_pending</a></h6> |
| <div class="docblock"> |
| <p>Sets <code>stream</code> to have actions pending. If the pending flag is |
| already set or <code>stream</code> is closed, it will return <code>FALSE</code> and set |
| <code>error</code>.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.skip.html">g_input_stream_skip</a></h6> |
| <div class="docblock"> |
| <p>Tries to skip <code>count</code> bytes from the stream. Will block during the operation.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.skip_async.html">g_input_stream_skip_async</a></h6> |
| <div class="docblock"> |
| <p>Request an asynchronous skip of <code>count</code> bytes from the stream. |
| When the operation is finished <code>callback</code> will be called. |
| You can then call <code>g_input_stream_skip_finish()</code> to get the result |
| of the operation.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.InputStream.skip_finish.html">g_input_stream_skip_finish</a></h6> |
| <div class="docblock"> |
| <p>Finishes a stream skip operation.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| <div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5> |
| <div class="docblock"> |
| |
| <div class="docblock"> |
| <p>Please see <a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a> for a full list of methods.</em></p> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| <div class="toggle-wrapper default-hide ancestor-methods"> |
| <h5 style="display:block;">Methods inherited from <a href="iface.File.html">GArrowFile</a> (4)</h5><div class="docblock"> |
| |
| <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> |
| |
| <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> |
| |
| <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> |
| |
| <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 class="toggle-wrapper default-hide ancestor-methods"> |
| <h5 style="display:block;">Methods inherited from <a href="iface.Readable.html">GArrowReadable</a> (2)</h5><div class="docblock"> |
| |
| <h6><a href="method.Readable.read.html">garrow_readable_read</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| |
| <h6><a href="method.Readable.read_bytes.html">garrow_readable_read_bytes</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p><span class="emblem available">since: 0.17.0</span></p> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| <div class="toggle-wrapper properties"> |
| <h4 id="properties"> |
| Properties |
| <a href="#properties" class="anchor"></a> |
| </h4> |
| |
| |
| |
| |
| |
| <div class="toggle-wrapper default-hide ancestor-properties"> |
| <h5 style="display:block;">Properties inherited from <a href="class.InputStream.html">GArrowInputStream</a> (1)</h5><div class="docblock"> |
| |
| <h6><a href="property.InputStream.input-stream.html">Arrow.InputStream:input-stream</a></h6><div class="docblock"> |
| No description available. |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| <div class="signals toggle-wrapper"> |
| <h4 id="signals"> |
| Signals |
| <a href="#signals" class="anchor"></a> |
| </h4> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5> |
| <div class="docblock"> |
| <h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6> |
| <div class="docblock"> |
| <p>The notify signal is emitted on an object when one of its properties has |
| its value set through g_object_set_property(), g_object_set(), et al.</p> |
| </div> |
| <div class="docblock"> |
| <p></p> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| <div class="class toggle-wrapper default-hide"> |
| <h4 id="class-struct"> |
| Class structure |
| <a href="#class-struct" class="anchor"></a> |
| </h4> |
| |
| <div class="docblock"> |
| <pre><code>struct ArrowSeekableInputStreamClass { |
| GArrowInputStreamClass parent_class; |
| |
| }</code></pre> |
| </div> |
| |
| <div class="docblock"> |
| No description available. |
| </div> |
| |
| |
| <div class="docblock"> |
| <h6>Class members</h6> |
| |
| <dl class="members"> |
| |
| <dt><code>parent_class: GArrowInputStreamClass</code></dt> |
| <dd>No description available.</dd> |
| |
| </dd> |
| </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="#ancestors"><span class="link-text">Ancestors</span></a></li> |
| |
| |
| <li class="toc-list-item"><a href="#implements"><span class="link-text">Implements</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> |
