ZipContainer

public class ZipContainer : Container

Provides functions for work with ZIP containers.

Show on GitHub

  • Contains user-defined extra fields. When either ZipContainer.info(container:) or ZipContainer.open(container:) function encounters extra field without built-in support, it uses this dictionary and tries to find a corresponding user-defined extra field. If an approriate custom extra field is found and successfully processed, then the result is stored in ZipEntryInfo.customExtraFields.

    To enable support of custom extra field one must add a new entry to this dictionary. The value of this entry must be a user-defined type which conforms to ZipExtraField protocol. The key must be equal to the ID of user-defined extra field and type’s id property.

    Warning

    Modifying this dictionary while either info(container:) or open(container:) function is being executed may cause undefined behavior.

    Declaration

    Swift

    public static var customExtraFields: [UInt16 : ZipExtraField.Type]
    Show on GitHub

  • Processes ZIP container and returns an array of ZipEntry with information and data for all entries.

    Important

    The order of entries is defined by ZIP container and, particularly, by the creator of a given ZIP container. It is likely that directories will be encountered earlier than files stored in those directories, but no particular order is guaranteed.

    Throws

    ZipError or any other error associated with compression type, depending on the type of the problem. It may indicate that either container is damaged or it might not be ZIP container at all.

    Declaration

    Swift

    public static func open(container data: Data) throws -> [ZipEntry]

    Parameters

    container

    ZIP container’s data.

    Return Value

    Array of ZipEntry.

    Show on GitHub

  • Processes ZIP container and returns an array of ZipEntryInfo with information about entries in this container.

    Important

    The order of entries is defined by ZIP container and, particularly, by the creator of a given ZIP container. It is likely that directories will be encountered earlier than files stored in those directories, but no particular order is guaranteed.

    Throws

    ZipError, which may indicate that either container is damaged or it might not be ZIP container at all.

    Declaration

    Swift

    public static func info(container data: Data) throws -> [ZipEntryInfo]

    Parameters

    container

    ZIP container’s data.

    Return Value

    Array of ZipEntryInfo.

    Show on GitHub