GZlibCompressor

GZlibCompressor — Zlib compressor

Synopsis

#include <gio/gio.h>

                    GZlibCompressor;
enum                GZlibCompressorFormat;
GZlibCompressor *   g_zlib_compressor_new               (GZlibCompressorFormat format,
                                                         int level);
GFileInfo *         g_zlib_compressor_get_file_info     (GZlibCompressor *compressor);
void                g_zlib_compressor_set_file_info     (GZlibCompressor *compressor,
                                                         GFileInfo *file_info);

Object Hierarchy

  GObject
   +----GZlibCompressor
  GEnum
   +----GZlibCompressorFormat

Implemented Interfaces

GZlibCompressor implements GConverter.

Properties

  "file-info"                GFileInfo*            : Read / Write
  "format"                   GZlibCompressorFormat  : Read / Write / Construct Only
  "level"                    gint                  : Read / Write / Construct Only

Description

GZlibCompressor is an implementation of GConverter that compresses data using zlib.

Details

GZlibCompressor

typedef struct _GZlibCompressor GZlibCompressor;

Zlib decompression


enum GZlibCompressorFormat

typedef enum {
  G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
  G_ZLIB_COMPRESSOR_FORMAT_GZIP,
  G_ZLIB_COMPRESSOR_FORMAT_RAW
} GZlibCompressorFormat;

Used to select the type of data format to use for GZlibDecompressor and GZlibCompressor.

G_ZLIB_COMPRESSOR_FORMAT_ZLIB

deflate compression with zlib header

G_ZLIB_COMPRESSOR_FORMAT_GZIP

gzip file format

G_ZLIB_COMPRESSOR_FORMAT_RAW

deflate compression with no header

Since 2.24


g_zlib_compressor_new ()

GZlibCompressor *   g_zlib_compressor_new               (GZlibCompressorFormat format,
                                                         int level);

Creates a new GZlibCompressor.

format :

The format to use for the compressed data

level :

compression level (0-9), -1 for default

Returns :

a new GZlibCompressor

Since 2.24


g_zlib_compressor_get_file_info ()

GFileInfo *         g_zlib_compressor_get_file_info     (GZlibCompressor *compressor);

Returns the "file-info" property.

compressor :

a GZlibCompressor

Returns :

a GFileInfo, or NULL. [transfer none]

Since 2.26


g_zlib_compressor_set_file_info ()

void                g_zlib_compressor_set_file_info     (GZlibCompressor *compressor,
                                                         GFileInfo *file_info);

Sets file_info in compressor. If non-NULL, and compressor's "format" property is G_ZLIB_COMPRESSOR_FORMAT_GZIP, it will be used to set the file name and modification time in the GZIP header of the compressed data.

Note: it is an error to call this function while a compression is in progress; it may only be called immediately after creation of compressor, or after resetting it with g_converter_reset().

compressor :

a GZlibCompressor

file_info :

a GFileInfo. [allow-none]

Since 2.26

Property Details

The "file-info" property

  "file-info"                GFileInfo*            : Read / Write

If set to a non-NULL GFileInfo object, and "format" is G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name and modification time from the file info to the the GZIP header.

Since 2.26


The "format" property

  "format"                   GZlibCompressorFormat  : Read / Write / Construct Only

The format of the compressed data.

Default value: G_ZLIB_COMPRESSOR_FORMAT_ZLIB


The "level" property

  "level"                    gint                  : Read / Write / Construct Only

The level of compression from 0 (no compression) to 9 (most compression), -1 for the default level.

Allowed values: [G_MAXULONG,9]

Default value: -1