### Namespace

# GnomeAutoar – 0.1

gnome-autoar provides functions for GNOME applications which want to use archives

Version | 0.5.0
Authors | The GNOME Project
License | LGPL2.1+
Website | https://gnome.pages.gitlab.gnome.org/gnome-autoar/
Source | https://gitlab.gnome.org/GNOME/gnome-autoar/

#### Build

C headers | `gnome-autoar/gnome-autoar.h`
pkg-config files | `GnomeAutoar-0.1`

#### Dependencies

GLib—2.0 | The base type system library
| Browse documentation
GObject—2.0 | The base type system library
| Browse documentation
Gio—2.0 | GObject Interfaces and Objects, Networking, IPC, and I/O
| Browse documentation

#### Additional documentation

- Classes Hierarchy

#### Classes

Compressor |
Extractor |

#### Enumerations

ConflictAction |
Filter | This is a non-negative number which represents filters supported by libarchive. A libarchive filter is a filter which can convert a regular file into a compressed file.
Format | This is a non-negative number which represents formats supported by libarchive. A libarchive format is a file format which can store many files as a archive file.

#### Callbacks

FilterFunc |
FormatFunc |

#### Functions

check_mime_type_supported | Checks whether a mime type is supported by autoar. This function does no blocking IO.
filter_get_description | Gets description of the filter from the internal static data.
filter_get_description_libarchive | Gets description of the filter from libarchive. This function creates and destroys an archive object in order to get the description string.
filter_get_extension | Gets the file name extension of the filter from the internal static data.
filter_get_filter_libarchive | Gets the filter code used by libarchive. You can use the return value as the argument for archive_write_add_filter().
filter_get_libarchive_read | Gets the function used to add filter on the object returned by archive_read_new().
filter_get_libarchive_write | Gets the function used to add filter on the object returned by archive_write_new().
filter_get_mime_type | Gets the MIME type of the filter from the internal static data.
filter_is_valid | Checks whether an `AutoarFilter` is valid.
filter_last | Gets the maximal allowed values of `AutoarFilter`.
format_filter_get_description | Gets the description for an archive `format` compressed by `filter` using `GContentType` and autoar_format_filter_get_mime_type().
format_filter_get_extension | Gets the file name extension for an archive `format` compressed by `filter`. The first character of the returned string is always ‘.’.
format_filter_get_mime_type | Gets the MIME type for an archive `format` compressed by `filter`. This function always succeed, but it is not guaranteed that the returned MIME type exists and can be recognized by applications. Some combination of format and filter seldom exists in application, so this function can only generate the string based on some non-standard rules.
format_get_description | Gets description of the format from the internal static data.
format_get_description_libarchive | Gets description of the format from libarchive. This function creates and destroys an archive object in order to get the description string.
format_get_extension | Gets the file name extension of the format from the internal static data.
format_get_format_libarchive | Gets the format code used by libarchive. You can use the return value as the argument for `archive_read_support_format_by_code()` and archive_write_set_format(). However, some format cannot be set using these two functions because of problems inside libarchive. Use `autoar_format_get_libarchive_read()` and `autoar_format_get_libarchive_write()` to get the function pointer is the more reliable way to set format on the archive object.
format_get_libarchive_read | Gets the function used to set format on the object returned by archive_read_new().
format_get_libarchive_write | Gets the function used to set format on the object returned by archive_write_new().
format_get_mime_type | Gets the MIME type of the format from the internal static data.
format_is_valid | Checks whether an `AutoarFormat` is valid.
format_last | Gets the maximal allowed values of `AutoarFormat`.
libarchive_quark | Gets the libarchive Error Quark.
query_mime_type_supported | This function will query the file’s mime type and then call autoar_check_mime_type_supported(), so it does blocking IO.

#### Constants

EMPTY_ARCHIVE_ERRNO |
NOT_AN_ARCHIVE_ERRNO |
PASSPHRASE_REQUIRED_ERRNO |