GzipArchive

public class GzipArchive : Archive

Provides unarchive and archive functions for GZip archives.

Show on GitHub

  • Represents the member of a multi-member GZip archive.

    See more

    Declaration

    Swift

    public struct Member
    Show on GitHub

  • Unarchives GZip archive.

    Note

    This function is specification compliant.

    Throws

    DeflateError or GzipError depending on the type of the problem. It may indicate that either archive is damaged or it might not be archived with GZip or compressed with Deflate at all.

    Declaration

    Swift

    public static func unarchive(archive data: Data) throws -> Data

    Parameters

    archive

    Data archived with GZip.

    Return Value

    Unarchived data.

    Show on GitHub

  • Unarchives multi-member GZip archive. Multi-member GZip archives are essentially several GZip archives following each other in a single file.

    Throws

    DeflateError or GzipError depending on the type of the problem. It may indicate that one of the members of archive is damaged or it might not be archived with GZip or compressed with Deflate at all.

    Declaration

    Swift

    public static func multiUnarchive(archive data: Data) throws -> [Member]

    Parameters

    archive

    GZip archive with one or more members.

    Return Value

    Unarchived data.

    Show on GitHub

  • Archives data into GZip archive, using various specified options. Data will be also compressed with Deflate algorithm. It will be also specified in archive’s header that the compressor used the slowest Deflate algorithm.

    Note

    This function is specification compliant.

    Throws

    GzipError.cannotEncodeISOLatin1 if a file name or a comment cannot be encoded with ISO-Latin-1 encoding or if the total sum of the binary content length of all extra fields plus 4 for each field exceeds UInt16.max.

    Declaration

    Swift

    public static func archive(data: Data, comment: String? = nil, fileName: String? = nil,
                           writeHeaderCRC: Bool = false, isTextFile: Bool = false,
                           osType: FileSystemType? = nil, modificationTime: Date? = nil,
                           extraFields: [GzipHeader.ExtraField] = []) throws -> Data

    Parameters

    data

    Data to compress and archive.
    comment

    Additional comment, which will be stored as a separate field in archive.
    fileName

    Name of the file which will be archived.
    writeHeaderCRC

    Set to true, if you want to store consistency check for archive’s header.
    isTextFile

    Set to true, if the file which will be archived is text file or ASCII-file.
    osType

    Type of the system on which this archive will be created.
    modificationTime

    Last time the file was modified.
    extraFields

    Any extra fields. Note that no extra field is allowed to have second byte of the extra field (subfield) ID equal to zero. In addition, the length of a field’s binary content must be less than UInt16.max, while the total sum of the binary content length of all extra fields plus 4 for each field must also not exceed UInt16.max. See GZip format specification for more details.

    Return Value

    Resulting archive’s data.

    Show on GitHub