| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GArrowWritable: 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="output.html" title="Output"> |
| <link rel="prev" href="output.html" title="Output"> |
| <link rel="next" href="GArrowWritableFile.html" title="GArrowWritableFile"> |
| <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="#GArrowWritable.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GArrowWritable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> |
| <a href="#GArrowWritable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span> |
| <a href="#GArrowWritable.implementations" class="shortcut">Known Implementations</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="output.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="GArrowWritableFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GArrowWritable"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GArrowWritable.top_of_page"></a>GArrowWritable</span></h2> |
| <p>GArrowWritable — Output interface</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowWritable.html#garrow-writable-write" title="garrow_writable_write ()">garrow_writable_write</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="GArrowWritable.html#garrow-writable-flush" title="garrow_writable_flush ()">garrow_writable_flush</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="GArrowWritable.html#GARROW-TYPE-WRITABLE:CAPS" title="GARROW_TYPE_WRITABLE">GARROW_TYPE_WRITABLE</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowWritable.html#GArrowWritable-struct" title="GArrowWritable">GArrowWritable</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowWritable.html#GArrowWritableInterface" title="GArrowWritableInterface">GArrowWritableInterface</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> |
| <span class="lineart">╰──</span> GArrowWritable |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.prerequisites"></a><h2>Prerequisites</h2> |
| <p> |
| GArrowWritable requires |
| GObject.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.implementations"></a><h2>Known Implementations</h2> |
| <p> |
| GArrowWritable is implemented by |
| <a class="link" href="output-stream-classes.html#GArrowBufferOutputStream">GArrowBufferOutputStream</a>, <a class="link" href="cuda-classes.html#GArrowCUDABufferOutputStream">GArrowCUDABufferOutputStream</a>, <a class="link" href="output-stream-classes.html#GArrowCompressedOutputStream">GArrowCompressedOutputStream</a>, <a class="link" href="output-stream-classes.html#GArrowFileOutputStream">GArrowFileOutputStream</a>, <a class="link" href="output-stream-classes.html#GArrowGIOOutputStream">GArrowGIOOutputStream</a> and <a class="link" href="output-stream-classes.html#GArrowOutputStream">GArrowOutputStream</a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.description"></a><h2>Description</h2> |
| <p><a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</span></a> is an interface for output. Output must be |
| writable.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-writable-write"></a><h3>garrow_writable_write ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_writable_write (<em class="parameter"><code><a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</span></a> *writable</code></em>, |
| <em class="parameter"><code>const <span class="type">guint8</span> *data</code></em>, |
| <em class="parameter"><code><span class="type">gint64</span> n_bytes</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-writable-write.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>writable</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>data</p></td> |
| <td class="parameter_description"><p>The data to be written. </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_bytes]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_bytes</p></td> |
| <td class="parameter_description"><p>The number of bytes to be written.</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-writable-write.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if there was an error.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-writable-flush"></a><h3>garrow_writable_flush ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_writable_flush (<em class="parameter"><code><a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</span></a> *writable</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <p>It ensures writing all data on memory to storage.</p> |
| <div class="refsect3"> |
| <a name="garrow-writable-flush.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>writable</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowWritable.html" title="GArrowWritable"><span class="type">GArrowWritable</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-writable-flush.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if there was an error.</p> |
| </div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowWritable.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-WRITABLE:CAPS"></a><h3>GARROW_TYPE_WRITABLE</h3> |
| <pre class="programlisting">#define GARROW_TYPE_WRITABLE (garrow_writable_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWritable-struct"></a><h3>GArrowWritable</h3> |
| <pre class="programlisting">typedef struct _GArrowWritable GArrowWritable;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowWritableInterface"></a><h3>GArrowWritableInterface</h3> |
| <pre class="programlisting">typedef struct _GArrowWritableInterface GArrowWritableInterface;</pre> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
