ZlibArchive

public final class ZlibArchive: Archive

Provides unarchive function for Zlib archives.

  • Unarchives Zlib archive stored in archiveData.

    If data passed is not actually a zlib archive, ZlibError will be thrown.

    If data inside the archive is not actually compressed with DEFLATE algorithm, DeflateError will be thrown.

    Note

    This function is specification compliant.

    Throws

    DeflateError or ZlibError depending on the type of inconsistency in data. It may indicate that either the data is damaged or it might not be compressed with zlib or DEFLATE at all.

    Declaration

    Swift

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

    Parameters

    archiveData

    Data compressed with zlib.

    Return Value

    Unarchived data.

    Show on GitHub

  • Archives data into Zlib archive. Data will be also compressed with DEFLTATE algorithm. It will be specified in archive’s header that the compressor used slowest DEFLATE algorithm.

    If during compression something goes wrong DeflateError will be thrown.

    Note

    This function is specification compliant.

    Throws

    DeflateError if an error was encountered during compression.

    Declaration

    Swift

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

    Parameters

    data

    Data to compress and archive.

    Return Value

    Data object with resulting archive.

    Show on GitHub