| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Codec related type and class: 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="codec.html" title="Codec"> |
| <link rel="prev" href="codec.html" title="Codec"> |
| <link rel="next" href="error.html" title="Error"> |
| <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="#GArrowCodec.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GArrowCodec.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#GArrowCodec.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="codec.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="codec.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="error.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GArrowCodec"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GArrowCodec.top_of_page"></a>Codec related type and class</span></h2> |
| <p>Codec related type and class</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.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="GArrowCodec.html" title="Codec related type and class"><span class="returnvalue">GArrowCodec</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowCodec.html#garrow-codec-new" title="garrow_codec_new ()">garrow_codec_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type">const <span class="returnvalue">gchar</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GArrowCodec.html#garrow-codec-get-name" title="garrow_codec_get_name ()">garrow_codec_get_name</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.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">gpointer</span></td> |
| <td class="property_name"><a class="link" href="GArrowCodec.html#GArrowCodec--codec" title="The “codec” property">codec</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.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="datatype_keyword">enum</td> |
| <td class="function_name"><a class="link" href="GArrowCodec.html#GArrowCompressionType" title="enum GArrowCompressionType">GArrowCompressionType</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="GArrowCodec.html#GARROW-TYPE-CODEC:CAPS" title="GARROW_TYPE_CODEC">GARROW_TYPE_CODEC</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="GArrowCodec.html#GArrowCodecClass" title="struct GArrowCodecClass">GArrowCodecClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowCodec.html#GArrowCodec-struct" title="GArrowCodec">GArrowCodec</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.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> GArrowCompressionType |
| GObject |
| <span class="lineart">╰──</span> GArrowCodec |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.description"></a><h2>Description</h2> |
| <p><a class="link" href="GArrowCodec.html#GArrowCompressionType" title="enum GArrowCompressionType"><span class="type">GArrowCompressionType</span></a> provides compression types corresponding to |
| <code class="literal">arrow::Compression::type</code>.</p> |
| <p><a class="link" href="GArrowCodec.html" title="Codec related type and class"><span class="type">GArrowCodec</span></a> is a class for compressing and decompressing data.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-codec-new"></a><h3>garrow_codec_new ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowCodec.html" title="Codec related type and class"><span class="returnvalue">GArrowCodec</span></a> * |
| garrow_codec_new (<em class="parameter"><code><a class="link" href="GArrowCodec.html#GArrowCompressionType" title="enum GArrowCompressionType"><span class="type">GArrowCompressionType</span></a> type</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-codec-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>type</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowCodec.html#GArrowCompressionType" title="enum GArrowCompressionType"><span class="type">GArrowCompressionType</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-codec-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="GArrowCodec.html" title="Codec related type and class"><span class="type">GArrowCodec</span></a> on success, <code class="literal">NULL</code> on error.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-codec-get-name"></a><h3>garrow_codec_get_name ()</h3> |
| <pre class="programlisting">const <span class="returnvalue">gchar</span> * |
| garrow_codec_get_name (<em class="parameter"><code><a class="link" href="GArrowCodec.html" title="Codec related type and class"><span class="type">GArrowCodec</span></a> *codec</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-codec-get-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>codec</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowCodec.html" title="Codec related type and class"><span class="type">GArrowCodec</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-codec-get-name.returns"></a><h4>Returns</h4> |
| <p> The name of the codec.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GArrowCompressionType"></a><h3>enum GArrowCompressionType</h3> |
| <p>They are corresponding to <code class="literal">arrow::Compression::type</code> values.</p> |
| <div class="refsect3"> |
| <a name="GArrowCompressionType.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-COMPRESSION-TYPE-UNCOMPRESSED:CAPS"></a>GARROW_COMPRESSION_TYPE_UNCOMPRESSED</p></td> |
| <td class="enum_member_description"> |
| <p>Not compressed.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-SNAPPY:CAPS"></a>GARROW_COMPRESSION_TYPE_SNAPPY</p></td> |
| <td class="enum_member_description"> |
| <p>Snappy compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-GZIP:CAPS"></a>GARROW_COMPRESSION_TYPE_GZIP</p></td> |
| <td class="enum_member_description"> |
| <p>gzip compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-BROTLI:CAPS"></a>GARROW_COMPRESSION_TYPE_BROTLI</p></td> |
| <td class="enum_member_description"> |
| <p>Brotli compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-ZSTD:CAPS"></a>GARROW_COMPRESSION_TYPE_ZSTD</p></td> |
| <td class="enum_member_description"> |
| <p>Zstandard compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-LZ4:CAPS"></a>GARROW_COMPRESSION_TYPE_LZ4</p></td> |
| <td class="enum_member_description"> |
| <p>LZ4 compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-LZO:CAPS"></a>GARROW_COMPRESSION_TYPE_LZO</p></td> |
| <td class="enum_member_description"> |
| <p>LZO compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-COMPRESSION-TYPE-BZ2:CAPS"></a>GARROW_COMPRESSION_TYPE_BZ2</p></td> |
| <td class="enum_member_description"> |
| <p>bzip2 compression.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-CODEC:CAPS"></a><h3>GARROW_TYPE_CODEC</h3> |
| <pre class="programlisting">#define GARROW_TYPE_CODEC (garrow_codec_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCodecClass"></a><h3>struct GArrowCodecClass</h3> |
| <pre class="programlisting">struct GArrowCodecClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCodec-struct"></a><h3>GArrowCodec</h3> |
| <pre class="programlisting">typedef struct _GArrowCodec GArrowCodec;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowCodec.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowCodec--codec"></a><h3>The <code class="literal">“codec”</code> property</h3> |
| <pre class="programlisting"> “codec” <span class="type">gpointer</span></pre> |
| <p>The raw arrow::util::Codec *.</p> |
| <p>Flags: 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> |