Codec related type and class

Codec related type and class

Functions

GArrowCodec * garrow_codec_new ()
const gchar * garrow_codec_get_name ()
GArrowCompressionType garrow_codec_get_compression_type ()
gint garrow_codec_get_compression_level ()

Properties

gpointer codec Write / Construct Only

Types and Values

enum GArrowCompressionType
#define GARROW_TYPE_CODEC
struct GArrowCodecClass
  GArrowCodec

Object Hierarchy

    GEnum
    ╰── GArrowCompressionType
    GObject
    ╰── GArrowCodec

Includes

#include <arrow-glib/arrow-glib.h>

Description

GArrowCompressionType provides compression types corresponding to arrow::Compression::type.

GArrowCodec is a class for compressing and decompressing data.

Functions

garrow_codec_new ()

GArrowCodec *
garrow_codec_new (GArrowCompressionType type,
                  GError **error);

Parameters

type

A GArrowCompressionType.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowCodec on success, NULL on error.

Since: 0.12.0

garrow_codec_get_name ()

const gchar *
garrow_codec_get_name (GArrowCodec *codec);

Parameters

codec

A GArrowCodec.

  

Returns

The name of the codec.

Since: 0.12.0

garrow_codec_get_compression_type ()

GArrowCompressionType
garrow_codec_get_compression_type (GArrowCodec *codec);

Parameters

codec

A GArrowCodec.

  

Returns

The compression type of the codec.

Since: 2.0.0

garrow_codec_get_compression_level ()

gint
garrow_codec_get_compression_level (GArrowCodec *codec);

Parameters

codec

A GArrowCodec.

  

Returns

The compression level of the codec.

Since: 2.0.0

Types and Values

enum GArrowCompressionType

They are corresponding to arrow::Compression::type values.

Members

GARROW_COMPRESSION_TYPE_UNCOMPRESSED

Not compressed.

  

GARROW_COMPRESSION_TYPE_SNAPPY

Snappy compression.

  

GARROW_COMPRESSION_TYPE_GZIP

gzip compression.

  

GARROW_COMPRESSION_TYPE_BROTLI

Brotli compression.

  

GARROW_COMPRESSION_TYPE_ZSTD

Zstandard compression.

  

GARROW_COMPRESSION_TYPE_LZ4

LZ4 compression.

  

GARROW_COMPRESSION_TYPE_LZO

LZO compression.

  

GARROW_COMPRESSION_TYPE_BZ2

bzip2 compression.

  

GARROW_TYPE_CODEC

#define GARROW_TYPE_CODEC (garrow_codec_get_type())

struct GArrowCodecClass

struct GArrowCodecClass {
  GObjectClass parent_class;
};

GArrowCodec

typedef struct _GArrowCodec GArrowCodec;

Property Details

The “codec” property

  “codec”                    gpointer

The raw std::shared_ptr<arrow::util::Codec> *.

Flags: Write / Construct Only

Generated by GTK-Doc V1.27