libmodulemd/modulemd/include/modulemd-2.0/modulemd-compression.h at 1c9809c73f7cfff8ea05369bc63fd52fd8501843 · fedora-modularity/libmodulemd · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * This file is part of libmodulemd
 * Copyright (C) 2019 Red Hat, Inc.
 *
 * Fedora-License-Identifier: MIT
 * SPDX-2.0-License-Identifier: MIT
 * SPDX-3.0-License-Identifier: MIT
 *
 * This program is free software.
 * For more information on the license, see COPYING.
 * For more information on free software, see <https://www.gnu.org/philosophy/free-sw.en.html>.
 */

#pragma once

#include <glib.h>
#include "modulemd-deprecated.h"

G_BEGIN_DECLS

/**
 * SECTION: modulemd-compression
 * @title: Modulemd Compression Helpers
 * @stability: unstable
 * @short_description: Utility functions for working with compressed files.
 *
 * Direct support for handling compressed YAML documents is scheduled for removal.
 * If you work with compressed documents, first uncompress them and then pass
 * the raw YAML documents to this library.
 */


/**
 * ModulemdCompressionTypeEnum:
 * @MODULEMD_COMPRESSION_TYPE_DETECTION_FAILED: Autodetection failure
 * @MODULEMD_COMPRESSION_TYPE_UNKNOWN_COMPRESSION: Unknown compression
 * @MODULEMD_COMPRESSION_TYPE_NO_COMPRESSION: No compression
 * @MODULEMD_COMPRESSION_TYPE_GZ_COMPRESSION: gzip compression
 * @MODULEMD_COMPRESSION_TYPE_BZ2_COMPRESSION: bzip2 compression
 * @MODULEMD_COMPRESSION_TYPE_XZ_COMPRESSION: LZMA compression
 * @MODULEMD_COMPRESSION_TYPE_ZCK_COMPRESSION: zchunk compression
 * @MODULEMD_COMPRESSION_TYPE_SENTINEL: Enum list terminator
 *
 * Since: 2.8
 * Deprecated: 2.14.1: Support for compressed documents is scheduled for removal.
 */
typedef enum
{
  MODULEMD_COMPRESSION_TYPE_DETECTION_FAILED = -2,
  MODULEMD_COMPRESSION_TYPE_UNKNOWN_COMPRESSION,
  MODULEMD_COMPRESSION_TYPE_NO_COMPRESSION,
  MODULEMD_COMPRESSION_TYPE_GZ_COMPRESSION,
  MODULEMD_COMPRESSION_TYPE_BZ2_COMPRESSION,
  MODULEMD_COMPRESSION_TYPE_XZ_COMPRESSION,
  MODULEMD_COMPRESSION_TYPE_ZCK_COMPRESSION,
  MODULEMD_COMPRESSION_TYPE_SENTINEL,
} ModulemdCompressionTypeEnum;


/**
 * modulemd_compression_type:
 * @name: (in): The name of the compression type. Valid options are:
 * "gz", "gzip", "bz2", "bzip2", "xz" and "zck".
 *
 * Returns: The #ModulemdCompressionTypeEnum value corresponding to the
 * provided string if available or
 * #MODULEMD_COMPRESSION_TYPE_UNKNOWN_COMPRESSION if the string does not match
 * a known type.
 *
 * Since: 2.8
 * Deprecated: 2.14.1: Support for compressed documents is scheduled for removal.
 */
MMD_DEPRECATED ModulemdCompressionTypeEnum
modulemd_compression_type (const gchar *name);


G_END_DECLS