diff --git a/.jazzy.yaml b/.jazzy.yaml index f48e98ac..36362ae1 100644 --- a/.jazzy.yaml +++ b/.jazzy.yaml @@ -3,9 +3,9 @@ clean: true exclude: Tests/ author: Timofey Solomko module: SWCompression -module_version: 3.0.0-test2 +module_version: 3.0.0 copyright: '© 2017 Timofey Solomko' readme: README.md github_url: https://github.com/tsolomko/SWCompression -github_file_prefix: https://github.com/tsolomko/SWCompression/tree/v3.0.0-test2 +github_file_prefix: https://github.com/tsolomko/SWCompression/tree/v3.0.0 theme: fullwidth diff --git a/CHANGELOG.md b/CHANGELOG.md index 60c8c480..10a9cd46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,24 +1,29 @@ # Changelog v3.0.0 ---------------- -#### test2 -- Added support for TAR containers. - - Various standards are supported (pre-POSIX, POSIX-1988, pax). - - Added subspec for TAR features. -- Added Container protocol. - - Reworked ZipContainer to conform to new protocol. -- All Errors cases renamed to conform Swift naming convetions (lowerCamelCase). -- Removed LZMAOutWindow. -- Test results combined into single document. -- Reduced tests sizes. -- Included 2.4.1 and 2.4.2 changes. - -#### test1 -- BZip2 decompression now checks CRC32. -- GZipHeader.modificationTime is now Optional. -- Enabled support for bzip2 and lzma compressed files in zip containers. - - In CocoaPods configurations availability of such support depends on - the presence of corresponding podspecs. +- All errors have been renamed, so they conform to Swift Naming Conventions (lowerCamelCase). +- Added `Container` and `ContainerEntry` protocols. +- Most methods have their arguments' labels renamed to make usage shorter. +- Most documentation have been edited to improve readability. +- Multiple files with results of performance tests replaced with consolidated one. +- Enabled support for LZMA and BZip2 compression algorithms. +- `ZipEntry` now conforms to `ContainerEntry` protocol. +- This also means that entry's data is now provided through `ZipEntry.data()` instead of `ZipContainer`'s function. +- Improved detection of directories if ZIP container was created on MS-DOS or UNIX-like systems. +- `ZipError.wrongCRC32` now contains entry's data as associated value. +- Fixed a problem where Zip64 sized fields weren't used during processing of Data Descriptor. +- Added some measures to prevent crashes when it is impossible to read ZIP text fields (file name or comment) in UTF-8 encoding +- Added support for TAR containers in various format versions. +- Now `GzipArchive.unarchive` function unarchives only first 'member' of archive. +- Added support for GZip archive's option in `archive` function. +- `GzipHeader.modificationTime` is now Optional. +- `GzipHeader.originalFileName` renamed to `GzipHeader.fileName`. +- Added `GzipHeader.isTextFile` property which corresponds to same named flag in archive's header. +- Now `XZArchive.unarchive` function unarchives only first stream of archive. +- Check for xz archive's footer's 'magic' bytes is now performed at the beginning of processing. +- XZ header's checksum is now checked before parsing reserved flags. +- BZip2 now performs CRC32 check for decompressed data. +- Removed internal `LZMAOutWindow` auxiliary class. v2.4.3 ---------------- diff --git a/SWCompression.podspec b/SWCompression.podspec index 707a68c2..bfbcb622 100644 --- a/SWCompression.podspec +++ b/SWCompression.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = "SWCompression" - s.version = "3.0.0-test2" + s.version = "3.0.0" s.summary = "Framework with implementations in Swift of different (de)compression algorithms" s.description = <<-DESC diff --git a/Sources/Service/Info-iOS.plist b/Sources/Service/Info-iOS.plist index 5e0b9206..ee73227e 100644 --- a/Sources/Service/Info-iOS.plist +++ b/Sources/Service/Info-iOS.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 3.0.0-dev + 3.0.0 CFBundleVersion $(CURRENT_PROJECT_VERSION) NSPrincipalClass diff --git a/Sources/Service/Info-tvOS.plist b/Sources/Service/Info-tvOS.plist index 5e0b9206..ee73227e 100644 --- a/Sources/Service/Info-tvOS.plist +++ b/Sources/Service/Info-tvOS.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 3.0.0-dev + 3.0.0 CFBundleVersion $(CURRENT_PROJECT_VERSION) NSPrincipalClass diff --git a/Sources/Service/Info-watchOS.plist b/Sources/Service/Info-watchOS.plist index 5e0b9206..ee73227e 100644 --- a/Sources/Service/Info-watchOS.plist +++ b/Sources/Service/Info-watchOS.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 3.0.0-dev + 3.0.0 CFBundleVersion $(CURRENT_PROJECT_VERSION) NSPrincipalClass diff --git a/Sources/Service/Info.plist b/Sources/Service/Info.plist index f8316a6b..11286145 100644 --- a/Sources/Service/Info.plist +++ b/Sources/Service/Info.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 3.0.0-dev + 3.0.0 CFBundleVersion $(CURRENT_PROJECT_VERSION) NSHumanReadableCopyright diff --git a/docs/Classes.html b/docs/Classes.html index 7fa3b6d8..e2240f7e 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

@@ -191,7 +191,7 @@

-

Provides function to decompress data, which were compressed with LZMA2

+

Provides decompression function for LZMA2 algorithm.

See more
@@ -199,12 +199,12 @@

Declaration

Swift

- 
public final class LZMA2: DecompressionAlgorithm
+ 
public class LZMA2: DecompressionAlgorithm
- Show on GitHub + Show on GitHub
@@ -226,7 +226,7 @@
-

Provides unarchive function for GZip archives.

+

Provides unarchive and archive functions for GZip archives.

See more
@@ -234,12 +234,12 @@

Declaration

Swift

- 
public final class GzipArchive: Archive
+ 
public class GzipArchive: Archive
- Show on GitHub + Show on GitHub
@@ -261,7 +261,7 @@
-

Represents either a file or directory entry inside ZIP archive.

+

Represents either a file or directory entry in ZIP container.

See more
@@ -274,7 +274,7 @@
- Show on GitHub + Show on GitHub
@@ -292,7 +292,7 @@
-

Provides function which opens ZIP archives (containers).

+

Provides open function for ZIP containers.

See more
@@ -305,7 +305,7 @@
- Show on GitHub + Show on GitHub
@@ -327,7 +327,7 @@
-

Provides function to decompress data, which were compressed with LZMA

+

Provides decompression function for LZMA algorithm.

See more
@@ -335,12 +335,12 @@

Declaration

Swift

- 
public final class LZMA: DecompressionAlgorithm
+ 
public class LZMA: DecompressionAlgorithm
- Show on GitHub + Show on GitHub
@@ -362,7 +362,7 @@
-

Provides unarchive function for Zlib archives.

+

Provides unarchive and archive functions for Zlib archives.

See more
@@ -370,12 +370,12 @@

Declaration

Swift

- 
public final class ZlibArchive: Archive
+ 
public class ZlibArchive: Archive
- Show on GitHub + Show on GitHub
@@ -397,7 +397,7 @@
-

Provides function to decompress data, which were compressed with DEFLATE.

+

Provides compression and decompression functions for Deflate algorithm.

See more
@@ -405,12 +405,12 @@

Declaration

Swift

- 
public final class Deflate: DecompressionAlgorithm
+ 
public class Deflate: DecompressionAlgorithm
- Show on GitHub + Show on GitHub
@@ -432,7 +432,7 @@
-

Provides function to decompress data, which were compressed using BZip2.

+

Provides decompression function for BZip2 algorithm.

See more
@@ -440,12 +440,12 @@

Declaration

Swift

- 
public final class BZip2: DecompressionAlgorithm
+ 
public class BZip2: DecompressionAlgorithm
- Show on GitHub + Show on GitHub
@@ -467,7 +467,7 @@
-

Represents either a file or directory entry inside TAR archive.

+

Represents either a file or directory entry in TAR container.

See more
@@ -480,7 +480,7 @@
- Show on GitHub + Show on GitHub
@@ -498,7 +498,7 @@
-

Provides function which opens TAR archives (containers).

+

Provides open function for TAR containers.

See more
@@ -511,7 +511,7 @@
- Show on GitHub + Show on GitHub
@@ -541,12 +541,12 @@

Declaration

Swift

- 
public final class XZArchive: Archive
+ 
public class XZArchive: Archive
- Show on GitHub + Show on GitHub
diff --git a/docs/Classes/BZip2.html b/docs/Classes/BZip2.html index 391621e7..4d7dd421 100644 --- a/docs/Classes/BZip2.html +++ b/docs/Classes/BZip2.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

@@ -172,11 +172,11 @@

BZip2

- 
public final class BZip2: DecompressionAlgorithm
+ 
public class BZip2: DecompressionAlgorithm
-

Provides function to decompress data, which were compressed using BZip2.

+

Provides decompression function for BZip2 algorithm.

@@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,13 @@
    -

    Decompresses compressedData with BZip2 algortihm.

    +

    Decompresses data using BZip2 algortihm.

    -

    If data passed is not actually compressed with BZip2, BZip2Error will be thrown.

    +

    If data is not actually compressed with BZip2, BZip2Error will be thrown.

    Throws

    -

    BZip2Error if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with BZip2 at all.

    +

    BZip2Error if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with BZip2 at all.

    @@ -213,7 +213,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,7 +224,7 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data @@ -241,7 +241,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/Deflate.html b/docs/Classes/Deflate.html index 48b672aa..50211aec 100644 --- a/docs/Classes/Deflate.html +++ b/docs/Classes/Deflate.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    Deflate

    - 
    public final class Deflate: DecompressionAlgorithm
    + 
    public class Deflate: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed with DEFLATE.

    +

    Provides compression and decompression functions for Deflate algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,18 @@
    -

    Decompresses compressedData with DEFLATE algortihm.

    +

    Decompresses data using Deflate algortihm.

    -

    If data passed is not actually compressed with DEFLATE, DeflateError will be thrown.

    +

    If data is not actually compressed with Deflate, DeflateError will be thrown.

    +
    +

    Note

    +

    This function is specification compliant.

    + +

    Throws

    -

    DeflateError if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.

    +

    DeflateError if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with Deflate at all.

    @@ -213,7 +218,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,12 +229,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data
    -

    Data compressed with DEFLATE.

    +

    Data compressed with Deflate.

    @@ -241,7 +246,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -259,15 +264,16 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Compresses data with DEFLATE algortihm.

    +

    Compresses data with Deflate algortihm.

    If during compression something goes wrong DeflateError will be thrown.

    Note

    - Currently, SWCompression creates only one block for all data +

    Currently, SWCompression creates only one block for all data and the block can either be uncompressed or compressed with static Huffman encoding. -Uncompressed block is created if amount of data provided is less than 3 bytes and -static Huffman is used in all other cases. +Choice of one block type or the other depends on bytes’ statistics of data. +However, if data size is greater than 65535 (the maximum value stored in 2 bytes), +then static Huffman block will be created.

    @@ -280,8 +286,27 @@ static Huffman is used in all other cases.
    +
    +

    Parameters

    + + + + + + + +
    + + data + + +
    +

    Data to compress.

    +
    +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/GzipArchive.html b/docs/Classes/GzipArchive.html index dd78db7f..ff5cc651 100644 --- a/docs/Classes/GzipArchive.html +++ b/docs/Classes/GzipArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    GzipArchive

    - 
    public final class GzipArchive: Archive
    + 
    public class GzipArchive: Archive
    -

    Provides unarchive function for GZip archives.

    +

    Provides unarchive and archive functions for GZip archives.

    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,11 +198,11 @@
    -

    Unarchives gzip archive stored in archiveData.

    +

    Unarchives GZip archive.

    -

    If data passed is not actually a gzip archive, GzipError will be thrown.

    +

    If data passed is not actually a GZip archive, GzipError will be thrown.

    -

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

    +

    If data in archive is not actually compressed with Deflate algorithm, DeflateError will be thrown.

    Note

    This function is specification compliant.

    @@ -210,8 +210,9 @@

    Throws

    -

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

    +

    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.

    @@ -220,7 +221,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func unarchive(archiveData data: Data) throws -> Data
    + 
    public static func unarchive(archive data: Data) throws -> Data
    @@ -231,12 +232,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - archiveData + archive
    -

    Data compressed with gzip.

    +

    Data archived with GZip.

    @@ -248,7 +249,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Unarchived data.

    - Show on GitHub + Show on GitHub
    @@ -256,9 +257,9 @@ It may indicate that either the data is damaged or it might not be compressed wi
  • - - - archive(data:) + + + archive(data:comment:fileName:writeHeaderCRC:isTextFile:osType:modificationTime:)
    @@ -266,12 +267,13 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Archives data into GZip archive. Data will be also compressed with DEFLTATE algorithm. -Fields in the header of the resulting archive will be set to default values -(i.e. no mtime, no flags, no file name, unknown OS type). -It will be also specified that the compressor used slowest DEFLATE algorithm.

    +

    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.

    -

    If during compression something goes wrong DeflateError will be thrown.

    +

    If during compression something goes wrong DeflateError will be thrown. +If either fileName or comment cannot be encoded with ISO Latin-1 encoding, +then GzipError.cannotEncodeISOLatin1 will be thrown.

    Note

    This function is specification compliant.

    @@ -279,7 +281,7 @@ It will be also specified that the compressor used slowest DEFLATE algorithm.

    Throws

    -

    DeflateError if an error was encountered during compression.

    +

    DeflateError or GzipError.cannotEncodeISOLatin1 depending on the type of of the problem.

    @@ -288,7 +290,9 @@ It will be also specified that the compressor used slowest DEFLATE algorithm.

    Declaration

    Swift

    - 
    public static func archive(data: Data) throws -> Data
    + 
    public static func archive(data: Data, comment: String? = nil, fileName: String? = nil,
+                               writeHeaderCRC: Bool = false, isTextFile: Bool = false,
+                               osType: GzipHeader.FileSystemType? = nil, modificationTime: Date? = nil) throws -> Data
    @@ -308,15 +312,87 @@ It will be also specified that the compressor used slowest DEFLATE algorithm.

    + + + + 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.

    +
    + +

    Return Value

    -

    Data object with resulting archive.

    +

    Resulting archive’s data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/LZMA.html b/docs/Classes/LZMA.html index 7810dc32..ef6a5d44 100644 --- a/docs/Classes/LZMA.html +++ b/docs/Classes/LZMA.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    LZMA

    - 
    public final class LZMA: DecompressionAlgorithm
    + 
    public class LZMA: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed with LZMA

    +

    Provides decompression function for LZMA algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,13 @@
    -

    Decompresses compressedData with LZMA algortihm.

    +

    Decompresses data using LZMA algortihm.

    -

    If data passed is not actually compressed with LZMA, LZMAError will be thrown.

    +

    If data is not actually compressed with LZMA, LZMAError will be thrown.

    Throws

    -

    LZMAError if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with LZMA at all.

    +

    LZMAError if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with LZMA at all.

    @@ -213,7 +213,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,7 +224,7 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data @@ -241,7 +241,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/LZMA2.html b/docs/Classes/LZMA2.html index 644475ed..3b9cce92 100644 --- a/docs/Classes/LZMA2.html +++ b/docs/Classes/LZMA2.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    LZMA2

    - 
    public final class LZMA2: DecompressionAlgorithm
    + 
    public class LZMA2: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed with LZMA2

    +

    Provides decompression function for LZMA2 algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,13 @@
    -

    Decompresses compressedData with LZMA2 algortihm. LZMA2 is a modification of LZMA.

    +

    Decompresses data using LZMA2 algortihm.

    -

    If data passed is not actually compressed with LZMA2, LZMA2Error or LZMAError will be thrown.

    +

    If data is not actually compressed with LZMA2, LZMAError or LZMA2Error will be thrown.

    Throws

    -

    LZMA2Error or LZMAError if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with LZMA2 at all.

    +

    LZMAError or LZMA2Error if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with LZMA2 at all.

    @@ -213,7 +213,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,7 +224,7 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data @@ -241,7 +241,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/TarContainer.html b/docs/Classes/TarContainer.html index bbf3179b..32af50ed 100644 --- a/docs/Classes/TarContainer.html +++ b/docs/Classes/TarContainer.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Provides function which opens TAR archives (containers).

    +

    Provides open function for TAR containers.

    @@ -188,9 +188,9 @@
  • - - - open(containerData:) + + + open(container:)
    @@ -198,19 +198,55 @@
    -

    Undocumented

    +

    Processes TAR container and returns an array of ContainerEntries (which are actually TarEntries).

    +
    +

    Important

    +

    The order of entries is defined by TAR container and, +particularly, by a creator of a given TAR container. +It is likely that directories will be encountered earlier than files stored in those directories, +but one SHOULD NOT rely on any particular order.

    + +
    +
    +

    Throws

    +

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

    + +

    Declaration

    Swift

    - 
    public class TarContainer: Container
    + 
    public static func open(container data: Data) throws -> [ContainerEntry]
    +
    +

    Parameters

    + + + + + + + +
    + + container + + +
    +

    TAR container’s data.

    +
    +
    +
    +
    +

    Return Value

    +

    Array of TarEntry as an array of ContainerEntry.

    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/TarEntry.html b/docs/Classes/TarEntry.html index 89fdeeba..5977bab6 100644 --- a/docs/Classes/TarEntry.html +++ b/docs/Classes/TarEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Represents either a file or directory entry inside TAR archive.

    +

    Represents either a file or directory entry in TAR container.

    @@ -198,7 +198,7 @@
    -

    Undocumented

    +

    Represents a type of an entry.

    See more
    @@ -206,12 +206,12 @@

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public enum EntryType: String
    - Show on GitHub + Show on GitHub
    @@ -241,7 +241,7 @@
    - Show on GitHub + Show on GitHub
    @@ -259,109 +259,19 @@
    -

    Undocumented

    +

    True, if an entry is a directory.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public var isDirectory: Bool
    - Show on GitHub -
    -
    - -
    • -
  • -
    - - - - mode - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class TarEntry: ContainerEntry
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
    • -
  • -
    - - - - ownerID - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class TarEntry: ContainerEntry
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
    • -
  • -
    - - - - groupID - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class TarEntry: ContainerEntry
    - -
    -
    -
    - Show on GitHub + Show on GitHub
    @@ -379,19 +289,109 @@
    -

    Undocumented

    +

    Size of the data associated with the entry.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var size: Int
    - Show on GitHub + Show on GitHub +
    +
    + +
    • +
  • +
    + + + + mode + +
    +
    +
    +
    +
    +
    +

    File mode.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let mode: Int?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ownerID + +
    +
    +
    +
    +
    +
    +

    Owner’s ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var ownerID: Int?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + groupID + +
    +
    +
    +
    +
    +
    +

    Owner’s group ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var groupID: Int?
    + +
    +
    +
    + Show on GitHub
    @@ -409,19 +409,19 @@
    -

    Undocumented

    +

    The most recent modification time of the original file or directory.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var modificationTime: Date
    - Show on GitHub + Show on GitHub
    @@ -439,19 +439,19 @@
    -

    Undocumented

    +

    Type of entry.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public let type: EntryType
    - Show on GitHub + Show on GitHub
    @@ -469,19 +469,19 @@
    -

    Undocumented

    +

    Owner’s user name.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var ownerUserName: String?
    - Show on GitHub + Show on GitHub
    @@ -499,19 +499,19 @@
    -

    Undocumented

    +

    Owner’s group name.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var ownerGroupName: String?
    - Show on GitHub + Show on GitHub
    @@ -529,19 +529,19 @@
    -

    Undocumented

    +

    The most recent access time of the original file or directory (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var accessTime: Date?
    - Show on GitHub + Show on GitHub
    @@ -559,19 +559,19 @@
    -

    Undocumented

    +

    Name of the character set used to encode entry’s data (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var charset: String?
    - Show on GitHub + Show on GitHub
    @@ -589,19 +589,19 @@
    -

    Undocumented

    +

    Comment associated with the entry (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var comment: String?
    - Show on GitHub + Show on GitHub
    @@ -619,19 +619,19 @@
    -

    Undocumented

    +

    Path to linked entry (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var linkPath: String?
    - Show on GitHub + Show on GitHub
    @@ -649,19 +649,19 @@
    -

    Undocumented

    +

    Other entries from PAX extended headers.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var unknownExtendedHeaderEntries: [String: String] = [:]
    - Show on GitHub + Show on GitHub
    @@ -680,12 +680,6 @@

    Returns data associated with this entry.

    -
    -

    Note

    - Returned Data object with the size of 0 can either indicate that the entry is an empty file -or it is a directory. - -
    @@ -697,7 +691,7 @@ or it is a directory.
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/TarEntry/EntryType.html b/docs/Classes/TarEntry/EntryType.html index 5a40df63..cfc0eb1e 100644 --- a/docs/Classes/TarEntry/EntryType.html +++ b/docs/Classes/TarEntry/EntryType.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -170,7 +170,13 @@

    EntryType

    -

    Undocumented

    +
    +
    + 
    public enum EntryType: String
    + +
    +
    +

    Represents a type of an entry.

    @@ -192,11 +198,19 @@
    -

    Undocumented

    +

    Normal file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case normal = "0"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -218,11 +232,19 @@
    -

    Undocumented

    +

    Hard linked entry.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case hardLink = "1"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -244,11 +266,19 @@
    -

    Undocumented

    +

    Symbolically linked entry.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case symbolicLink = "2"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -270,11 +300,19 @@
    -

    Undocumented

    +

    Character special file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case characterSpecial = "3"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -296,11 +334,19 @@
    -

    Undocumented

    +

    Block special file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case blockSpecial = "4"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -322,11 +368,19 @@
    -

    Undocumented

    +

    Directory.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case directory = "5"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -348,11 +402,19 @@
    -

    Undocumented

    +

    FIFO special file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fifo = "6"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -374,11 +436,19 @@
    -

    Undocumented

    +

    Contiguous file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case contiguous = "7"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -400,11 +470,19 @@
    -

    Undocumented

    +

    PAX global extended header. (Should not be encountered separately).

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case globalExtendedHeader = "g"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -426,11 +504,19 @@
    -

    Undocumented

    +

    PAX local extended header. (Should not be encountered separately).

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case localExtendedHeader = "x"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -452,11 +538,19 @@
    -

    Undocumented

    +

    Either unknown type, vendor specific or reserved value.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case vendorUnknownOrReserved
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/XZArchive.html b/docs/Classes/XZArchive.html index 34de8365..6e80d6a7 100644 --- a/docs/Classes/XZArchive.html +++ b/docs/Classes/XZArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,7 +172,7 @@

    XZArchive

    - 
    public final class XZArchive: Archive
    + 
    public class XZArchive: Archive
    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,17 +198,18 @@
    -

    Unarchives xz archive stored in archiveData.

    +

    Unarchives XZ archive.

    -

    If data passed is not actually a xz archive, XZError will be thrown. -If filters other than LZMA2 are used in archive then XZError.wrongFilterID will be thrown.

    +

    If data passed is not actually XZ archive, XZError will be thrown. +Particularly, if filters other than LZMA2 are used in archive, +then XZError.wrongFilter will be thrown.

    -

    If data inside the archive is not actually compressed with LZMA2, -LZMAError or LZMA2Error will be thrown.

    +

    If an error happens during LZMA2 decompression, +then LZMAError or LZMA2Error will be thrown.

    Throws

    -

    LZMAError, LZMA2Error or XZError depending on the type of inconsistency in data. -It may indicate that either the data is damaged or it might not be compressed with xz or LZMA(2) at all.

    +

    LZMAError, LZMA2Error or XZError depending on the type of the problem. +It may indicate that either the archive is damaged or it might not be compressed with XZ or LZMA(2) at all.

    @@ -217,7 +218,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func unarchive(archiveData data: Data) throws -> Data
    + 
    public static func unarchive(archive data: Data) throws -> Data
    @@ -228,12 +229,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - archiveData + archive
    -

    Data compressed with xz.

    +

    Data archived using XZ format.

    @@ -245,7 +246,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Unarchived data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/ZipContainer.html b/docs/Classes/ZipContainer.html index cd31f8ff..0fa4556b 100644 --- a/docs/Classes/ZipContainer.html +++ b/docs/Classes/ZipContainer.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Provides function which opens ZIP archives (containers).

    +

    Provides open function for ZIP containers.

    @@ -188,9 +188,9 @@
  • - - - open(containerData:) + + + open(container:)
    @@ -198,27 +198,20 @@
    -

    Processes ZIP archive (container) and returns an array of ContainerEntries (which are actually ZipEntries). -First member of a tuple is entry’s name, second member is entry’s data.

    +

    Processes ZIP container and returns an array of ContainerEntries (which are actually ZipEntries).

    Important

    -

    The order of entries is defined by ZIP archive and, particularly, creator of given ZIP container. +

    The order of entries is defined by ZIP container and, +particularly, by a creator of a given ZIP container. It is likely that directories will be encountered earlier than files stored in those directories, -but one SHOULD NOT assume that this is the case.

    - -
    -
    -

    Note

    -

    Currently, there is no universal (platform and file system independent) method to determine if entry is a directory. -One can check this by looking at the size of entry’s data (it should be 0 for directory) AND -the last character of entry’s name (it should be ‘/’). If all of these is true then entry is likely to be a directory.

    +but one SHOULD NOT rely on any particular order.

    Throws

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

    +depending on the type of the problem. +It may indicate that either container is damaged or it might not be ZIP container at all.

    @@ -227,7 +220,7 @@ It may indicate that either the container is damaged or it might not be ZIP cont

    Declaration

    Swift

    - 
    public static func open(containerData: Data) throws -> [ContainerEntry]
    + 
    public static func open(container data: Data) throws -> [ContainerEntry]
    @@ -238,12 +231,12 @@ It may indicate that either the container is damaged or it might not be ZIP cont - containerData + container
    -

    Data of ZIP container.

    +

    ZIP container’s data.

    @@ -252,10 +245,10 @@ It may indicate that either the container is damaged or it might not be ZIP cont

    Return Value

    -

    Array of pairs ZipEntries as an array of ContainerEntries.

    +

    Array of ZipEntry as an array of ContainerEntry.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/ZipEntry.html b/docs/Classes/ZipEntry.html index a0976478..0ec16e22 100644 --- a/docs/Classes/ZipEntry.html +++ b/docs/Classes/ZipEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Represents either a file or directory entry inside ZIP archive.

    +

    Represents either a file or directory entry in ZIP container.

    @@ -210,7 +210,7 @@
    - Show on GitHub + Show on GitHub
    @@ -240,7 +240,7 @@
    - Show on GitHub + Show on GitHub
    @@ -258,7 +258,7 @@
    -

    File or directory attributes related to the file system of archive’s creator.

    +

    File or directory attributes related to the file system of the container’s creator.

    @@ -270,7 +270,7 @@
    - Show on GitHub + Show on GitHub
    @@ -288,19 +288,19 @@
    -

    Undocumented

    +

    Size of the data associated with the entry.

    Declaration

    Swift

    - 
    public class ZipEntry: ContainerEntry
    + 
    public var size: Int
    - Show on GitHub + Show on GitHub
    @@ -318,8 +318,9 @@
    -

    True, if an entry is likely to be a directory. -Particularly, it is true if size of data is 0 and last character of entry’s name is ‘/’.

    +

    True, if an entry is a directory. +For MS-DOS and UNIX-like container creator’s OS, the result is based on ‘external file attributes’. +Otherwise, it is true if size of data is 0 AND last character of entry’s name is ‘/’.

    @@ -331,7 +332,7 @@ Particularly, it is true if size of data is 0 and last character of entry’
    - Show on GitHub + Show on GitHub
    @@ -350,17 +351,10 @@ Particularly, it is true if size of data is 0 and last character of entry’

    Returns data associated with this entry.

    -
    -

    Note

    -

    Returned Data object with the size of 0 can either indicate that the entry is an empty file -or it is a directory.

    - -

    Throws

    -

    ZipError or any other error associated with compression type, -depending on the type of inconsistency in data. -An error can indicate that the container is damaged.

    + ZipError or any other error associated with compression type, +depending on the type of the problem. An error can indicate that container is damaged.
    @@ -374,7 +368,7 @@ An error can indicate that the container is damaged.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/ZlibArchive.html b/docs/Classes/ZlibArchive.html index c703621d..f6e07165 100644 --- a/docs/Classes/ZlibArchive.html +++ b/docs/Classes/ZlibArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    ZlibArchive

    - 
    public final class ZlibArchive: Archive
    + 
    public class ZlibArchive: Archive
    -

    Provides unarchive function for Zlib archives.

    +

    Provides unarchive and archive functions for Zlib archives.

    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,11 +198,11 @@
    -

    Unarchives Zlib archive stored in archiveData.

    +

    Unarchives Zlib archive.

    -

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

    +

    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.

    +

    If data in archive is not actually compressed with Deflate algorithm, DeflateError will be thrown.

    Note

    This function is specification compliant.

    @@ -210,8 +210,9 @@

    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.

    +

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

    @@ -220,7 +221,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func unarchive(archiveData data: Data) throws -> Data
    + 
    public static func unarchive(archive data: Data) throws -> Data
    @@ -231,12 +232,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - archiveData + archive
    -

    Data compressed with zlib.

    +

    Data archived with Zlib.

    @@ -248,7 +249,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Unarchived data.

    - Show on GitHub + Show on GitHub
    @@ -266,8 +267,9 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    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.

    +

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

    If during compression something goes wrong DeflateError will be thrown.

    @@ -311,10 +313,10 @@ It will be specified in archive’s header that the compressor used slowest

    Return Value

    -

    Data object with resulting archive.

    +

    Resulting archive’s data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums.html b/docs/Enums.html index 6766e027..816aaf55 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,16 +191,8 @@

    -

    Error happened during LZMA2 decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA2 at all.

    - -
      -
    • wrongProperties: reserved bits of LZMA2 properties byte weren’t zero.
      • -
    • wrongDictionarySize: dictionary size was greater than 2^32.
      • -
    • wrongControlByte: unsupported value of LZMA2 packet’s control byte.
      • -
    • wrongReset: unsupported ‘reset’ value of LZMA2 packet’s.
      • -
    • wrongSizes: size of compressed or decompressed data wasn’t the same as specified in LZMA2 packet.
      • -
    +

    Represents an error, which happened during LZMA2 decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA2 at all.

    See more
    @@ -213,7 +205,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -235,19 +227,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during unarchiving gzip archive. -It may indicate that either the data is damaged or it might not be gzip archive at all.

    - -
      -
    • wrongMagic: first two bytes of archive were not 31 and 139.
      • -
    • wrongCompressionMethod: unsupported compression method (not 8 aka Deflate).
      • -
    • wrongFlags: unsupported flags (reserved flags weren’t 0).
      • -
    • wrongHeaderCRC: computed Cyclic Redundancy Check of archive’s header - didn’t match the archive’s value.
      • -
    • wrongCRC: computed Cyclic Redundancy Check of uncompressed data didn’t match the archive’s value. -Associated value contains already decompressed data.
      • -
    • wrongISize: size of uncompressed data modulo 2^32 didn’t match the archive’s value.
      • -
    +

    Represents an error, which happened during processing GZip archive. +It may indicate that either archive is damaged or it might not be GZip archive at all.

    See more
    @@ -260,7 +241,7 @@ Associated value contains already decompressed data.
    • - Show on GitHub + Show on GitHub
    @@ -282,22 +263,8 @@ Associated value contains already decompressed data.
    -

    Error happened during processing ZIP archive (container). -It may indicate that either the data is damaged or it might not be ZIP archive (container) at all.

    - - +

    Represents an error, which happened during processing ZIP container. +It may indicate that either container is damaged or it might not be ZIP container at all.

    See more
    @@ -310,7 +277,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -332,21 +299,8 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Error happened during LZMA decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA at all.

    - - +

    Represents an error, which happened during LZMA decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA at all.

    See more
    @@ -359,7 +313,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -381,17 +335,8 @@ than the repeat length.
    -

    Error happened during unarchiving Zlib archive. -It may indicate that either the data is damaged or it might not be Zlib archive at all.

    - - +

    Represents an error, which happened during processing Zlib archive. +It may indicate that either archive is damaged or it might not be Zlib archive at all.

    See more
    @@ -404,7 +349,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -426,15 +371,8 @@ Associated value contains already decompressed data.
    -

    Error happened during deflate decompression. -It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.

    - - +

    Represents an error, which happened during Deflate compression or decompression. +It may indicate that either the data is damaged or it might not be compressed with Deflate at all.

    See more
    @@ -447,7 +385,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -469,21 +407,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during bzip2 decompression. -It may indicate that either the data is damaged or it might not be compressed with BZip2 at all.

    - - +

    Represents an error, which happened during BZip2 decompression. +It may indicate that either data is damaged or it might not be compressed with BZip2 at all.

    See more
    @@ -496,7 +421,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -518,12 +443,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during processing TAR archive (container). -It may indicate that either the data is damaged or it might not be TAR archive (container) at all.

    - - +

    Represents an error, which happened during processing TAR container. +It may indicate that either container is damaged or it might not be TAR container at all.

    See more
    @@ -536,7 +457,7 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    - Show on GitHub + Show on GitHub
    @@ -558,23 +479,8 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Error happened during unarchiving XZ archive. -It may indicate that either the data is damaged or it might not be XZ archive at all.

    - - +

    Represents an error, which happened during unarchiving XZ archive. +It may indicate that either archive is damaged or it might not be XZ archive at all.

    See more
    @@ -587,7 +493,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums/BZip2Error.html b/docs/Enums/BZip2Error.html index 319fa64d..a5bfdd2f 100644 --- a/docs/Enums/BZip2Error.html +++ b/docs/Enums/BZip2Error.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,21 +176,8 @@ -

    Error happened during bzip2 decompression. -It may indicate that either the data is damaged or it might not be compressed with BZip2 at all.

    - - +

    Represents an error, which happened during BZip2 decompression. +It may indicate that either data is damaged or it might not be compressed with BZip2 at all.

    @@ -212,7 +199,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Magic number was not 0x425a.

    +

    ‘Magic’ number is not 0x425a.

    @@ -224,7 +211,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -246,7 +233,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Compression method was not type ‘h’ (not Huffman).

    +

    Compression method is not type ‘h’ (not Huffman).

    @@ -258,7 +245,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -280,7 +267,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown block size (not from ‘0’ to ‘9’).

    +

    Unsupported block size (not from ‘0’ to ‘9’).

    @@ -292,7 +279,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -314,7 +301,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown block type (was neither ‘pi’ nor ‘sqrt(pi)’).

    +

    Unsupported block type (is neither ‘pi’ nor ‘sqrt(pi)’).

    @@ -326,7 +313,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -360,7 +347,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -394,7 +381,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -416,7 +403,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Selector was greater than total number of Huffman tables/groups.

    +

    Selector is greater than the total number of Huffman tables/groups.

    @@ -428,7 +415,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -462,7 +449,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -484,7 +471,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Symbol was not found in Huffman tree.

    +

    Symbol wasn’t found in Huffman tree.

    @@ -496,7 +483,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -518,8 +505,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Computed CRC of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in archive. +Associated value of the error contains already decompressed data.

    @@ -531,7 +518,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums/DeflateError.html b/docs/Enums/DeflateError.html index e7ebdcf9..ad715075 100644 --- a/docs/Enums/DeflateError.html +++ b/docs/Enums/DeflateError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,15 +176,8 @@ -

    Error happened during deflate decompression. -It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.

    - - +

    Represents an error, which happened during Deflate compression or decompression. +It may indicate that either the data is damaged or it might not be compressed with Deflate at all.

    @@ -206,7 +199,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Uncompressed block’ length and nlength bytes were not compatible.

    +

    Uncompressed block’s length and nlength bytes isn’t consistent with each other.

    @@ -218,7 +211,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -240,7 +233,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown block type (not from 0 to 2).

    +

    Unknown block type (not 0, 1 or 2).

    @@ -252,7 +245,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -286,7 +279,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -308,7 +301,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Symbol was not found in Huffman tree.

    +

    Symbol wasn’t found in Huffman tree.

    @@ -320,7 +313,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums/GzipError.html b/docs/Enums/GzipError.html index 54abc734..0db3728c 100644 --- a/docs/Enums/GzipError.html +++ b/docs/Enums/GzipError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,19 +176,8 @@ -

    Error happened during unarchiving gzip archive. -It may indicate that either the data is damaged or it might not be gzip archive at all.

    - - +

    Represents an error, which happened during processing GZip archive. +It may indicate that either archive is damaged or it might not be GZip archive at all.

    @@ -210,7 +199,7 @@ Associated value contains already decompressed data.
    -

    First two bytes of archive were not 31 and 139.

    +

    First two bytes (‘magic’ number) of archive isn’t 31 and 139.

    @@ -222,7 +211,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -244,7 +233,7 @@ Associated value contains already decompressed data.
    -

    Compression method was other than 8 which is the only supported one.

    +

    Compression method used in archive is different from Deflate, which is the only supported one.

    @@ -256,7 +245,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -278,7 +267,8 @@ Associated value contains already decompressed data.
    -

    Reserved flags bits were not equal to 0.

    +

    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive), +that archive uses a newer version of GZip format.

    @@ -290,7 +280,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -312,7 +302,7 @@ Associated value contains already decompressed data.
    -

    Computed CRC of header didn’t match the value stored in the archive.

    +

    Computed CRC of archive’s header doesn’t match the value stored in archive.

    @@ -324,7 +314,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -346,8 +336,8 @@ Associated value contains already decompressed data.
    -

    Computed CRC of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in archive. +Associated value of the error contains already decompressed data.

    @@ -359,7 +349,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -381,7 +371,7 @@ Associated value contains already decompressed data.

    -

    Computed isize didn’t match the value stored in the archive.

    +

    Computed ‘isize’ didn’t match the value stored in the archive.

    @@ -393,7 +383,41 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub +
    +
    + + + + +
    +
    -

    Error happened during LZMA2 decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA2 at all.

    - - +

    Represents an error, which happened during LZMA2 decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA2 at all.

    @@ -207,7 +199,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Reserved bits of LZMA2 properties byte were not equal to zero.

    +

    Reserved bits of LZMA2 properties’ byte aren’t equal to zero.

    @@ -219,7 +211,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -241,7 +233,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Dictionary size was too big.

    +

    Dictionary size is too big.

    @@ -253,7 +245,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -287,7 +279,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -309,7 +301,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown reset instruction encounetered in LZMA2 packet.

    +

    Unknown reset instruction encountered in LZMA2 packet.

    @@ -321,7 +313,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -343,8 +335,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Either size of decompressed data was not equal to specified one in LZMA2 packet or -amount of compressed data read was different from the one stored in LZMA2 packet.

    +

    Either size of decompressed data isn’t equal to the one specified in LZMA2 packet or +amount of compressed data read is different from the one stored in LZMA2 packet.

    @@ -356,7 +348,7 @@ amount of compressed data read was different from the one stored in LZMA2 packet
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums/LZMAError.html b/docs/Enums/LZMAError.html index 3aed164a..645625fe 100644 --- a/docs/Enums/LZMAError.html +++ b/docs/Enums/LZMAError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,21 +176,8 @@ -

    Error happened during LZMA decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA at all.

    - - +

    Represents an error, which happened during LZMA decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA at all.

    @@ -212,7 +199,7 @@ than the repeat length.
    -

    Properties byte was greater than 225.

    +

    Properties’ byte is greater than 225.

    @@ -224,7 +211,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -258,7 +245,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -280,7 +267,7 @@ than the repeat length.
    -

    The number of uncompressed bytes hit limit in the middle of decoding.

    +

    Size of uncompressed data hit specified limit in the middle of decoding.

    @@ -292,7 +279,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -326,7 +313,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -360,7 +347,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -394,7 +381,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -428,7 +415,41 @@ than the repeat length.
    - Show on GitHub + Show on GitHub +
    + + + + + +
    +
    -

    Error happened during processing TAR archive (container). -It may indicate that either the data is damaged or it might not be TAR archive (container) at all.

    - - +

    Represents an error, which happened during processing TAR container. +It may indicate that either container is damaged or it might not be TAR container at all.

    @@ -203,19 +199,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Size of data is too small, even to contain only one header.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case tooSmallFileIsPassed
    - Show on GitHub + Show on GitHub
    @@ -237,19 +233,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Failed to process a field as a number.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case fieldIsNotNumber
    - Show on GitHub + Show on GitHub
    @@ -271,19 +267,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Computed checksum of a header doesn’t match the value stored in container.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case wrongHeaderChecksum
    - Show on GitHub + Show on GitHub
    @@ -305,19 +301,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Unsupported version of USTAR format.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case wrongUstarVersion
    - Show on GitHub + Show on GitHub
    @@ -339,19 +335,53 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Entry from PAX extended header is in incorrect format.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case wrongPaxHeaderEntry
    - Show on GitHub + Show on GitHub +
    +
    + + + + +
    +
    -

    Error happened during unarchiving XZ archive. -It may indicate that either the data is damaged or it might not be XZ archive at all.

    - - +

    Represents an error, which happened during unarchiving XZ archive. +It may indicate that either archive is damaged or it might not be XZ archive at all.

    @@ -214,7 +199,7 @@ Associated value contains already decompressed data.
    -

    Either magic number in header or footer was not equal to predefined value.

    +

    Either ‘magic’ number in header or footer isn’t equal to a predefined value.

    @@ -226,7 +211,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -238,9 +223,9 @@ Associated value contains already decompressed data.
  • - - - wrongArchiveInfo + + + wrongFieldValue
    @@ -248,19 +233,19 @@ Associated value contains already decompressed data.
    • -

    One of special fields of archive had an incorrect value.

    +

    One of the fields in archive has an incorrect value.

    Declaration

    Swift

    - 
    case wrongArchiveInfo
    + 
    case wrongFieldValue
    - Show on GitHub + Show on GitHub
    @@ -282,7 +267,8 @@ Associated value contains already decompressed data.
    -

    One of special fields of archive had a reserved value.

    +

    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive), +that archive uses a newer version of XZ format.

    @@ -294,7 +280,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -316,7 +302,7 @@ Associated value contains already decompressed data.
    -

    Checksum of one of special fields of archive was incorrect.

    +

    Checksum of one of the fields of archive doesn’t match the value stored in archive.

    @@ -328,7 +314,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -350,7 +336,7 @@ Associated value contains already decompressed data.
    -

    ID of filter(s) used in archvie was unsupported.

    +

    Filter used in archvie is unsupported.

    @@ -362,7 +348,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -384,7 +370,7 @@ Associated value contains already decompressed data.
    -

    Type of checksum of archive was SHA-256.

    +

    Archive uses SHA-256 checksum which is unsupported.

    @@ -396,7 +382,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -418,8 +404,8 @@ Associated value contains already decompressed data.
    -

    Either size of decompressed data was not equal to specified one in block header or -amount of compressed data read was different from the one stored in block header.

    +

    Either size of decompressed data isn’t equal to the one specified in archive or +amount of compressed data read is different from the one stored in archive.

    @@ -431,7 +417,7 @@ amount of compressed data read was different from the one stored in block header
    - Show on GitHub + Show on GitHub
    @@ -453,8 +439,8 @@ amount of compressed data read was different from the one stored in block header
    -

    Computed checksum of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in the archive. +Associated value of the error contains already decompressed data.

    @@ -466,7 +452,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -488,7 +474,7 @@ Associated value contains already decompressed data.

    -

    Unsupported padding of a structure in the archive.

    +

    Padding (null-bytes appended to an archive’s structure) is incorrect.

    @@ -500,7 +486,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -534,7 +520,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums/ZipError.html b/docs/Enums/ZipError.html index 047dfc95..e74bfd4e 100644 --- a/docs/Enums/ZipError.html +++ b/docs/Enums/ZipError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,22 +176,8 @@ -

    Error happened during processing ZIP archive (container). -It may indicate that either the data is damaged or it might not be ZIP archive (container) at all.

    - - +

    Represents an error, which happened during processing ZIP container. +It may indicate that either container is damaged or it might not be ZIP container at all.

    @@ -213,7 +199,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    End of Central Directoty record was not found.

    +

    End of Central Directoty record wasn’t found.

    @@ -225,7 +211,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -247,7 +233,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong signature of one of ZIP container’s structures.

    +

    Wrong signature of one of container’s structures.

    @@ -259,7 +245,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -281,7 +267,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong either compressed or uncompressed size of a ZIP container’s entry.

    +

    Wrong either compressed or uncompressed size of a container’s entry.

    @@ -293,7 +279,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -315,7 +301,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong number of version needed to extract ZIP container.

    +

    Version needed to process container is unsupported.

    @@ -327,7 +313,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -349,7 +335,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Archive either spanned or consists of several volumes. This feature is not supported.

    +

    Container is either spanned or consists of several volumes. These features aren’t supported.

    @@ -361,7 +347,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -383,7 +369,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Entry or record is encrypted. This feature is not supported.

    +

    Entry or record is encrypted. This feature isn’t supported.

    @@ -395,7 +381,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -417,7 +403,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Entry contains patched data. This feature is not supported.

    +

    Entry contains patched data. This feature isn’t supported.

    @@ -429,7 +415,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -451,7 +437,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong compression method of an entry.

    +

    Entry is compressed using unsupported compression method.

    @@ -463,7 +449,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -485,7 +471,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong local header of an entry.

    +

    Local header of an entry is inconsistent with Central Directory.

    @@ -497,7 +483,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -519,8 +505,8 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Computed CRC32 of entry’s data didn’t match the value stored in the container. -Associated value contains extracted data.

    +

    Computed checksum of entry’s data doesn’t match the value stored in container. +Associated value of the error contains entry’s data.

    @@ -532,7 +518,7 @@ Associated value contains extracted data.

    - Show on GitHub + Show on GitHub
    @@ -554,19 +540,19 @@ Associated value contains extracted data.

    -

    Undocumented

    +

    Either entry’s comment or file name cannot be processed using UTF-8 encoding.

    Declaration

    Swift

    - 
    public enum ZipError: Error
    + 
    case wrongTextField
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Enums/ZlibError.html b/docs/Enums/ZlibError.html index 665a6523..61f3e13f 100644 --- a/docs/Enums/ZlibError.html +++ b/docs/Enums/ZlibError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,17 +176,8 @@ -

    Error happened during unarchiving Zlib archive. -It may indicate that either the data is damaged or it might not be Zlib archive at all.

    - - +

    Represents an error, which happened during processing Zlib archive. +It may indicate that either archive is damaged or it might not be Zlib archive at all.

    @@ -208,7 +199,7 @@ Associated value contains already decompressed data.
    -

    Compression method was other than 8 which is the only supported one.

    +

    Compression method used in archive is different from Deflate, which is the only supported one.

    @@ -220,7 +211,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -242,7 +233,7 @@ Associated value contains already decompressed data.
    -

    Compression info was greater than 7 which is uncompatible number 8 compression method.

    +

    Compression info has value incompatible with Deflate compression method.

    @@ -254,7 +245,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -276,7 +267,7 @@ Associated value contains already decompressed data.
    -

    First two bytes were inconsistent with each other.

    +

    First two bytes of archive’s flags are inconsistent with each other.

    @@ -288,7 +279,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -310,7 +301,7 @@ Associated value contains already decompressed data.
    -

    Compression level was other than 0, 1, 2, 3.

    +

    Compression level has value, which is different from the supported ones.

    @@ -322,7 +313,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -344,8 +335,8 @@ Associated value contains already decompressed data.
    -

    Computed Adler-32 sum of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in archive. +Associated value of the error contains already decompressed data.

    @@ -357,7 +348,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Protocols.html b/docs/Protocols.html index 6375a356..b49937fe 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,7 +191,7 @@

    -

    Abstract archive class which supports unarchiving.

    +

    A type that represents an archive.

    See more
    @@ -204,7 +204,7 @@
    - Show on GitHub + Show on GitHub
    @@ -222,7 +222,7 @@
    -

    Abstract decompression algorithm class which supports decompression.

    +

    A type that provides an implementation of a particular decompression algorithm.

    See more
    @@ -235,7 +235,7 @@
    - Show on GitHub + Show on GitHub
    @@ -253,12 +253,20 @@
    -

    Undocumented

    +

    A type that represents a container of files, directories and/or other data.

    See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol Container
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -276,12 +284,20 @@
    -

    Undocumented

    +

    A type that represents an entry from a container (file or directory) with attributes.

    See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol ContainerEntry
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Protocols/Archive.html b/docs/Protocols/Archive.html index 04d2e675..3b330cb5 100644 --- a/docs/Protocols/Archive.html +++ b/docs/Protocols/Archive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Abstract archive class which supports unarchiving.

    +

    A type that represents an archive.

    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,19 +198,19 @@
    -

    Abstract unarchive function.

    +

    Unarchive data from the archive.

    Declaration

    Swift

    - 
    static func unarchive(archiveData: Data) throws -> Data
    + 
    static func unarchive(archive: Data) throws -> Data
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Protocols/Container.html b/docs/Protocols/Container.html index 51bedd79..70158a29 100644 --- a/docs/Protocols/Container.html +++ b/docs/Protocols/Container.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -170,7 +170,13 @@

    Container

    -

    Undocumented

    +
    +
    + 
    public protocol Container
    + +
    +
    +

    A type that represents a container of files, directories and/or other data.

    @@ -182,9 +188,9 @@
  • - - - open(containerData:) + + + open(container:)
    @@ -192,11 +198,19 @@
    -

    Undocumented

    +

    Retrieve all the entries from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    static func open(container: Data) throws -> [ContainerEntry]
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Protocols/ContainerEntry.html b/docs/Protocols/ContainerEntry.html index 83d16939..b7e9942d 100644 --- a/docs/Protocols/ContainerEntry.html +++ b/docs/Protocols/ContainerEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -170,7 +170,13 @@

    ContainerEntry

    -

    Undocumented

    +
    +
    + 
    public protocol ContainerEntry
    + +
    +
    +

    A type that represents an entry from a container (file or directory) with attributes.

    @@ -192,11 +198,19 @@
    -

    Undocumented

    +

    Retrieve name of the entry from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    var name: String
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -214,11 +228,19 @@
    -

    Undocumented

    +

    Retrieve size of the entry’s data from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    var size: Int
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -236,11 +258,19 @@
    -

    Undocumented

    +

    Check if entry is a directory.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    var isDirectory: Bool
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -258,11 +288,19 @@
    -

    Undocumented

    +

    Retrieve entry’s data from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    func data() throws -> Data
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Protocols/DecompressionAlgorithm.html b/docs/Protocols/DecompressionAlgorithm.html index d9edaa85..3191ec43 100644 --- a/docs/Protocols/DecompressionAlgorithm.html +++ b/docs/Protocols/DecompressionAlgorithm.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Abstract decompression algorithm class which supports decompression.

    +

    A type that provides an implementation of a particular decompression algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,19 +198,19 @@
    -

    Abstract decompress function.

    +

    Decompress data compressed with particular algorithm.

    Declaration

    Swift

    - 
    static func decompress(compressedData: Data) throws -> Data
    + 
    static func decompress(data: Data) throws -> Data
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs.html b/docs/Structs.html index 755e680d..b6d2ee06 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,7 +191,7 @@

    -

    A structure which provides information about gzip archive.

    +

    Represents a GZip archive’s header.

    See more
    @@ -204,7 +204,7 @@
    - Show on GitHub + Show on GitHub
    @@ -226,7 +226,7 @@
    -

    A structure which provides information about zlib archive.

    +

    Represents a Zlib archive’s header.

    See more
    @@ -239,7 +239,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs/GzipHeader.html b/docs/Structs/GzipHeader.html index 80379478..9031ee75 100644 --- a/docs/Structs/GzipHeader.html +++ b/docs/Structs/GzipHeader.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    A structure which provides information about gzip archive.

    +

    Represents a GZip archive’s header.

    @@ -198,7 +198,7 @@
    -

    Supported compression methods in gzip archive.

    +

    Supported compression methods in GZip archive.

    See more
    @@ -211,7 +211,7 @@
    - Show on GitHub + Show on GitHub
    @@ -229,7 +229,7 @@
    -

    Type of file system on which gzip archive was created.

    +

    Type of file system on which GZip archive was created.

    See more
    @@ -242,7 +242,7 @@
    - Show on GitHub + Show on GitHub
    @@ -260,7 +260,7 @@
    -

    Compression method of archive. Always equals to .deflate.

    +

    Compression method of archive. Currently, always equals to .deflate.

    @@ -272,7 +272,7 @@
    - Show on GitHub + Show on GitHub
    @@ -290,7 +290,9 @@
    -

    The most recent modification time of the original file. If set to 0 (default value == unset), then nil.

    +

    The most recent modification time of the original file. +If corresponding archive’s field is set to 0, which means that no time was specified, +then this property is nil.

    @@ -302,7 +304,7 @@
    - Show on GitHub + Show on GitHub
    @@ -320,7 +322,7 @@
    -

    Type of file system on which compression took place.

    +

    Type of file system on which archivation took place.

    @@ -332,7 +334,7 @@
    - Show on GitHub + Show on GitHub
    @@ -340,9 +342,9 @@
  • - - - originalFileName + + + fileName
    @@ -350,19 +352,19 @@
    -

    Name of the original file.

    +

    Name of the original file. If archive doesn’t contain file’s name, then nil.

    Declaration

    Swift

    - 
    public let originalFileName: String?
    + 
    public let fileName: String?
    - Show on GitHub + Show on GitHub
    @@ -380,7 +382,7 @@
    -

    Comment inside the archive.

    +

    Comment stored in archive. If archive doesn’t contain any comment, then nil.

    @@ -392,7 +394,7 @@
    - Show on GitHub + Show on GitHub
    @@ -400,9 +402,9 @@
  • - - - init(archiveData:) + + + isTextFile
    @@ -410,13 +412,43 @@
    -

    Initializes the structure with the values of first ‘member’ in gzip archive presented in archiveData.

    +

    Check if file is likely to be text file or ASCII-file.

    -

    If data passed is not actually a gzip archive, GzipError will be thrown.

    +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let isTextFile: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(archive:) + +
    +
    +
    +
    +
    +
    +

    Initializes the structure with the values from the first ‘member’ of GZip archive.

    + +

    If data passed is not actually a GZip archive, GzipError will be thrown.

    Throws

    -

    GzipError. It may indicate that either the data is damaged or -it might not be compressed with gzip at all.

    +

    GzipError. It may indicate that either archive is damaged or +it might not be archived with GZip at all.

    @@ -425,7 +457,7 @@ it might not be compressed with gzip at all.

    Declaration

    Swift

    - 
    public init(archiveData: Data) throws
    + 
    public init(archive data: Data) throws
    @@ -436,12 +468,12 @@ it might not be compressed with gzip at all.

    - archiveData + archive
    -

    Data compressed with gzip.

    +

    Data archived with GZip.

    @@ -449,7 +481,7 @@ it might not be compressed with gzip at all.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs/GzipHeader/CompressionMethod.html b/docs/Structs/GzipHeader/CompressionMethod.html index a75c1923..899545d9 100644 --- a/docs/Structs/GzipHeader/CompressionMethod.html +++ b/docs/Structs/GzipHeader/CompressionMethod.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Supported compression methods in gzip archive.

    +

    Supported compression methods in GZip archive.

    @@ -210,7 +210,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs/GzipHeader/FileSystemType.html b/docs/Structs/GzipHeader/FileSystemType.html index e8814fed..bf47adc2 100644 --- a/docs/Structs/GzipHeader/FileSystemType.html +++ b/docs/Structs/GzipHeader/FileSystemType.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Type of file system on which gzip archive was created.

    +

    Type of file system on which GZip archive was created.

    @@ -198,7 +198,12 @@
    -

    One of many Linux systems. (It seems like modern macOS systems also fall into this category).

    +

    One of many UNIX-like systems.

    +
    +

    Note

    + It seems like modern macOS systems also fall into this category. + +
    @@ -210,7 +215,7 @@
    - Show on GitHub + Show on GitHub
    @@ -232,7 +237,7 @@
    -

    Older Macintosh (Mac OS, OS X) systems.

    +

    Older Macintosh systems.

    @@ -244,7 +249,7 @@
    - Show on GitHub + Show on GitHub
    @@ -278,7 +283,7 @@
    - Show on GitHub + Show on GitHub
    @@ -312,7 +317,7 @@
    - Show on GitHub + Show on GitHub
    @@ -334,7 +339,7 @@
    -

    File system was one of the rare systems..

    +

    File system is one of the rare systems.

    @@ -346,7 +351,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs/ZlibHeader.html b/docs/Structs/ZlibHeader.html index 61a5bf3f..933e2284 100644 --- a/docs/Structs/ZlibHeader.html +++ b/docs/Structs/ZlibHeader.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    A structure which provides information about zlib archive.

    +

    Represents a Zlib archive’s header.

    @@ -211,7 +211,7 @@
    - Show on GitHub + Show on GitHub
    @@ -229,7 +229,7 @@
    -

    Levels of compression which can be used to create zlib archive.

    +

    Levels of compression which can be used to create Zlib archive.

    See more
    @@ -242,7 +242,7 @@
    - Show on GitHub + Show on GitHub
    @@ -260,7 +260,7 @@
    -

    Compression method of archive. Always equals to .deflate.

    +

    Compression method of archive. Currently, always equals to .deflate.

    @@ -272,7 +272,7 @@
    - Show on GitHub + Show on GitHub
    @@ -290,7 +290,7 @@
    -

    Level of compression in the archive.

    +

    Level of compression used in archive.

    @@ -302,7 +302,7 @@
    - Show on GitHub + Show on GitHub
    @@ -320,7 +320,7 @@
    -

    Size of ‘window’: moving interval of data which was used to make the archive

    +

    Size of ‘window’: moving interval of data which was used to make archive.

    @@ -332,7 +332,7 @@
    - Show on GitHub + Show on GitHub
    @@ -340,9 +340,9 @@
  • - - - init(archiveData:) + + + init(archive:)
    @@ -350,13 +350,13 @@
    -

    Initializes the structure with the values from zlib archive presented in archiveData.

    +

    Initializes the structure with the values from Zlib archive.

    -

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

    +

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

    Throws

    -

    ZlibError. It may indicate that either the data is damaged or -it might not be compressed with zlib at all.

    +

    ZlibError. It may indicate that either archive is damaged or +it might not be archived with Zlib at all.

    @@ -365,7 +365,7 @@ it might not be compressed with zlib at all.

    Declaration

    Swift

    - 
    public init(archiveData: Data) throws
    + 
    public init(archive data: Data) throws
    @@ -376,12 +376,12 @@ it might not be compressed with zlib at all.

    - archiveData + archive
    -

    Data compressed with zlib.

    +

    Data archived with zlib.

    @@ -389,7 +389,7 @@ it might not be compressed with zlib at all.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs/ZlibHeader/CompressionLevel.html b/docs/Structs/ZlibHeader/CompressionLevel.html index f0e28da0..21c22d48 100644 --- a/docs/Structs/ZlibHeader/CompressionLevel.html +++ b/docs/Structs/ZlibHeader/CompressionLevel.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Levels of compression which can be used to create zlib archive.

    +

    Levels of compression which can be used to create Zlib archive.

    @@ -210,7 +210,7 @@
    - Show on GitHub + Show on GitHub
    @@ -244,7 +244,7 @@
    - Show on GitHub + Show on GitHub
    @@ -278,7 +278,7 @@
    - Show on GitHub + Show on GitHub
    @@ -312,7 +312,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Structs/ZlibHeader/CompressionMethod.html b/docs/Structs/ZlibHeader/CompressionMethod.html index c640d261..74298ff8 100644 --- a/docs/Structs/ZlibHeader/CompressionMethod.html +++ b/docs/Structs/ZlibHeader/CompressionMethod.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -210,7 +210,7 @@

    - Show on GitHub + Show on GitHub
    diff --git a/docs/badge.svg b/docs/badge.svg index 0d836268..2606d804 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -1 +1 @@ -documentationdocumentation75%75% \ No newline at end of file +documentationdocumentation100%100% \ No newline at end of file diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html index 7fa3b6d8..e2240f7e 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,7 +191,7 @@

    -

    Provides function to decompress data, which were compressed with LZMA2

    +

    Provides decompression function for LZMA2 algorithm.

    See more
    @@ -199,12 +199,12 @@

    Declaration

    Swift

    - 
    public final class LZMA2: DecompressionAlgorithm
    + 
    public class LZMA2: DecompressionAlgorithm
    - Show on GitHub + Show on GitHub
    @@ -226,7 +226,7 @@
    -

    Provides unarchive function for GZip archives.

    +

    Provides unarchive and archive functions for GZip archives.

    See more
    @@ -234,12 +234,12 @@

    Declaration

    Swift

    - 
    public final class GzipArchive: Archive
    + 
    public class GzipArchive: Archive
    - Show on GitHub + Show on GitHub
    @@ -261,7 +261,7 @@
    -

    Represents either a file or directory entry inside ZIP archive.

    +

    Represents either a file or directory entry in ZIP container.

    See more
    @@ -274,7 +274,7 @@
    - Show on GitHub + Show on GitHub
    @@ -292,7 +292,7 @@
    -

    Provides function which opens ZIP archives (containers).

    +

    Provides open function for ZIP containers.

    See more
    @@ -305,7 +305,7 @@
    - Show on GitHub + Show on GitHub
    @@ -327,7 +327,7 @@
    -

    Provides function to decompress data, which were compressed with LZMA

    +

    Provides decompression function for LZMA algorithm.

    See more
    @@ -335,12 +335,12 @@

    Declaration

    Swift

    - 
    public final class LZMA: DecompressionAlgorithm
    + 
    public class LZMA: DecompressionAlgorithm
    - Show on GitHub + Show on GitHub
    @@ -362,7 +362,7 @@
    -

    Provides unarchive function for Zlib archives.

    +

    Provides unarchive and archive functions for Zlib archives.

    See more
    @@ -370,12 +370,12 @@

    Declaration

    Swift

    - 
    public final class ZlibArchive: Archive
    + 
    public class ZlibArchive: Archive
    - Show on GitHub + Show on GitHub
    @@ -397,7 +397,7 @@
    -

    Provides function to decompress data, which were compressed with DEFLATE.

    +

    Provides compression and decompression functions for Deflate algorithm.

    See more
    @@ -405,12 +405,12 @@

    Declaration

    Swift

    - 
    public final class Deflate: DecompressionAlgorithm
    + 
    public class Deflate: DecompressionAlgorithm
    - Show on GitHub + Show on GitHub
    @@ -432,7 +432,7 @@
    -

    Provides function to decompress data, which were compressed using BZip2.

    +

    Provides decompression function for BZip2 algorithm.

    See more
    @@ -440,12 +440,12 @@

    Declaration

    Swift

    - 
    public final class BZip2: DecompressionAlgorithm
    + 
    public class BZip2: DecompressionAlgorithm
    - Show on GitHub + Show on GitHub
    @@ -467,7 +467,7 @@
    -

    Represents either a file or directory entry inside TAR archive.

    +

    Represents either a file or directory entry in TAR container.

    See more
    @@ -480,7 +480,7 @@
    - Show on GitHub + Show on GitHub
    @@ -498,7 +498,7 @@
    -

    Provides function which opens TAR archives (containers).

    +

    Provides open function for TAR containers.

    See more
    @@ -511,7 +511,7 @@
    - Show on GitHub + Show on GitHub
    @@ -541,12 +541,12 @@

    Declaration

    Swift

    - 
    public final class XZArchive: Archive
    + 
    public class XZArchive: Archive
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html index 391621e7..4d7dd421 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    BZip2

    - 
    public final class BZip2: DecompressionAlgorithm
    + 
    public class BZip2: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed using BZip2.

    +

    Provides decompression function for BZip2 algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,13 @@
    -

    Decompresses compressedData with BZip2 algortihm.

    +

    Decompresses data using BZip2 algortihm.

    -

    If data passed is not actually compressed with BZip2, BZip2Error will be thrown.

    +

    If data is not actually compressed with BZip2, BZip2Error will be thrown.

    Throws

    -

    BZip2Error if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with BZip2 at all.

    +

    BZip2Error if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with BZip2 at all.

    @@ -213,7 +213,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,7 +224,7 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data @@ -241,7 +241,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html index 48b672aa..50211aec 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    Deflate

    - 
    public final class Deflate: DecompressionAlgorithm
    + 
    public class Deflate: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed with DEFLATE.

    +

    Provides compression and decompression functions for Deflate algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,18 @@
    -

    Decompresses compressedData with DEFLATE algortihm.

    +

    Decompresses data using Deflate algortihm.

    -

    If data passed is not actually compressed with DEFLATE, DeflateError will be thrown.

    +

    If data is not actually compressed with Deflate, DeflateError will be thrown.

    +
    +

    Note

    +

    This function is specification compliant.

    + +

    Throws

    -

    DeflateError if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.

    +

    DeflateError if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with Deflate at all.

    @@ -213,7 +218,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,12 +229,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data
    -

    Data compressed with DEFLATE.

    +

    Data compressed with Deflate.

    @@ -241,7 +246,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -259,15 +264,16 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Compresses data with DEFLATE algortihm.

    +

    Compresses data with Deflate algortihm.

    If during compression something goes wrong DeflateError will be thrown.

    Note

    - Currently, SWCompression creates only one block for all data +

    Currently, SWCompression creates only one block for all data and the block can either be uncompressed or compressed with static Huffman encoding. -Uncompressed block is created if amount of data provided is less than 3 bytes and -static Huffman is used in all other cases. +Choice of one block type or the other depends on bytes’ statistics of data. +However, if data size is greater than 65535 (the maximum value stored in 2 bytes), +then static Huffman block will be created.

    @@ -280,8 +286,27 @@ static Huffman is used in all other cases.
    +
    +

    Parameters

    + + + + + + + +
    + + data + + +
    +

    Data to compress.

    +
    +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html index dd78db7f..ff5cc651 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    GzipArchive

    - 
    public final class GzipArchive: Archive
    + 
    public class GzipArchive: Archive
    -

    Provides unarchive function for GZip archives.

    +

    Provides unarchive and archive functions for GZip archives.

    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,11 +198,11 @@
    -

    Unarchives gzip archive stored in archiveData.

    +

    Unarchives GZip archive.

    -

    If data passed is not actually a gzip archive, GzipError will be thrown.

    +

    If data passed is not actually a GZip archive, GzipError will be thrown.

    -

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

    +

    If data in archive is not actually compressed with Deflate algorithm, DeflateError will be thrown.

    Note

    This function is specification compliant.

    @@ -210,8 +210,9 @@

    Throws

    -

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

    +

    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.

    @@ -220,7 +221,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func unarchive(archiveData data: Data) throws -> Data
    + 
    public static func unarchive(archive data: Data) throws -> Data
    @@ -231,12 +232,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - archiveData + archive
    -

    Data compressed with gzip.

    +

    Data archived with GZip.

    @@ -248,7 +249,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Unarchived data.

    - Show on GitHub + Show on GitHub
    @@ -256,9 +257,9 @@ It may indicate that either the data is damaged or it might not be compressed wi
  • - - - archive(data:) + + + archive(data:comment:fileName:writeHeaderCRC:isTextFile:osType:modificationTime:)
    @@ -266,12 +267,13 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Archives data into GZip archive. Data will be also compressed with DEFLTATE algorithm. -Fields in the header of the resulting archive will be set to default values -(i.e. no mtime, no flags, no file name, unknown OS type). -It will be also specified that the compressor used slowest DEFLATE algorithm.

    +

    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.

    -

    If during compression something goes wrong DeflateError will be thrown.

    +

    If during compression something goes wrong DeflateError will be thrown. +If either fileName or comment cannot be encoded with ISO Latin-1 encoding, +then GzipError.cannotEncodeISOLatin1 will be thrown.

    Note

    This function is specification compliant.

    @@ -279,7 +281,7 @@ It will be also specified that the compressor used slowest DEFLATE algorithm.

    Throws

    -

    DeflateError if an error was encountered during compression.

    +

    DeflateError or GzipError.cannotEncodeISOLatin1 depending on the type of of the problem.

    @@ -288,7 +290,9 @@ It will be also specified that the compressor used slowest DEFLATE algorithm.

    Declaration

    Swift

    - 
    public static func archive(data: Data) throws -> Data
    + 
    public static func archive(data: Data, comment: String? = nil, fileName: String? = nil,
+                               writeHeaderCRC: Bool = false, isTextFile: Bool = false,
+                               osType: GzipHeader.FileSystemType? = nil, modificationTime: Date? = nil) throws -> Data
    @@ -308,15 +312,87 @@ It will be also specified that the compressor used slowest DEFLATE algorithm.

    + + + + 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.

    +
    + +

    Return Value

    -

    Data object with resulting archive.

    +

    Resulting archive’s data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html index 7810dc32..ef6a5d44 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    LZMA

    - 
    public final class LZMA: DecompressionAlgorithm
    + 
    public class LZMA: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed with LZMA

    +

    Provides decompression function for LZMA algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,13 @@
    -

    Decompresses compressedData with LZMA algortihm.

    +

    Decompresses data using LZMA algortihm.

    -

    If data passed is not actually compressed with LZMA, LZMAError will be thrown.

    +

    If data is not actually compressed with LZMA, LZMAError will be thrown.

    Throws

    -

    LZMAError if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with LZMA at all.

    +

    LZMAError if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with LZMA at all.

    @@ -213,7 +213,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,7 +224,7 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data @@ -241,7 +241,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html index 644475ed..3b9cce92 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    LZMA2

    - 
    public final class LZMA2: DecompressionAlgorithm
    + 
    public class LZMA2: DecompressionAlgorithm
    -

    Provides function to decompress data, which were compressed with LZMA2

    +

    Provides decompression function for LZMA2 algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,13 +198,13 @@
    -

    Decompresses compressedData with LZMA2 algortihm. LZMA2 is a modification of LZMA.

    +

    Decompresses data using LZMA2 algortihm.

    -

    If data passed is not actually compressed with LZMA2, LZMA2Error or LZMAError will be thrown.

    +

    If data is not actually compressed with LZMA2, LZMAError or LZMA2Error will be thrown.

    Throws

    -

    LZMA2Error or LZMAError if unexpected byte (bit) sequence was encountered in compressedData. -It may indicate that either the data is damaged or it might not be compressed with LZMA2 at all.

    +

    LZMAError or LZMA2Error if unexpected byte (bit) sequence was encountered in data. +It may indicate that either data is damaged or it might not be compressed with LZMA2 at all.

    @@ -213,7 +213,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func decompress(compressedData data: Data) throws -> Data
    + 
    public static func decompress(data: Data) throws -> Data
    @@ -224,7 +224,7 @@ It may indicate that either the data is damaged or it might not be compressed wi - compressedData + data @@ -241,7 +241,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarContainer.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarContainer.html index bbf3179b..32af50ed 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarContainer.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarContainer.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Provides function which opens TAR archives (containers).

    +

    Provides open function for TAR containers.

    @@ -188,9 +188,9 @@
  • - - - open(containerData:) + + + open(container:)
    @@ -198,19 +198,55 @@
    -

    Undocumented

    +

    Processes TAR container and returns an array of ContainerEntries (which are actually TarEntries).

    +
    +

    Important

    +

    The order of entries is defined by TAR container and, +particularly, by a creator of a given TAR container. +It is likely that directories will be encountered earlier than files stored in those directories, +but one SHOULD NOT rely on any particular order.

    + +
    +
    +

    Throws

    +

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

    + +

    Declaration

    Swift

    - 
    public class TarContainer: Container
    + 
    public static func open(container data: Data) throws -> [ContainerEntry]
    +
    +

    Parameters

    + + + + + + + +
    + + container + + +
    +

    TAR container’s data.

    +
    +
    +
    +
    +

    Return Value

    +

    Array of TarEntry as an array of ContainerEntry.

    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry.html index 89fdeeba..5977bab6 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Represents either a file or directory entry inside TAR archive.

    +

    Represents either a file or directory entry in TAR container.

    @@ -198,7 +198,7 @@
    -

    Undocumented

    +

    Represents a type of an entry.

    See more
    @@ -206,12 +206,12 @@

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public enum EntryType: String
    - Show on GitHub + Show on GitHub
    @@ -241,7 +241,7 @@
    - Show on GitHub + Show on GitHub
    @@ -259,109 +259,19 @@
    -

    Undocumented

    +

    True, if an entry is a directory.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public var isDirectory: Bool
    - Show on GitHub -
    -
    - -
    • -
  • -
    - - - - mode - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class TarEntry: ContainerEntry
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
    • -
  • -
    - - - - ownerID - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class TarEntry: ContainerEntry
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
    • -
  • -
    - - - - groupID - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class TarEntry: ContainerEntry
    - -
    -
    -
    - Show on GitHub + Show on GitHub
    @@ -379,19 +289,109 @@
    -

    Undocumented

    +

    Size of the data associated with the entry.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var size: Int
    - Show on GitHub + Show on GitHub +
    +
    + +
    • +
  • +
    + + + + mode + +
    +
    +
    +
    +
    +
    +

    File mode.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let mode: Int?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ownerID + +
    +
    +
    +
    +
    +
    +

    Owner’s ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var ownerID: Int?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + groupID + +
    +
    +
    +
    +
    +
    +

    Owner’s group ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var groupID: Int?
    + +
    +
    +
    + Show on GitHub
    @@ -409,19 +409,19 @@
    -

    Undocumented

    +

    The most recent modification time of the original file or directory.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var modificationTime: Date
    - Show on GitHub + Show on GitHub
    @@ -439,19 +439,19 @@
    -

    Undocumented

    +

    Type of entry.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public let type: EntryType
    - Show on GitHub + Show on GitHub
    @@ -469,19 +469,19 @@
    -

    Undocumented

    +

    Owner’s user name.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var ownerUserName: String?
    - Show on GitHub + Show on GitHub
    @@ -499,19 +499,19 @@
    -

    Undocumented

    +

    Owner’s group name.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var ownerGroupName: String?
    - Show on GitHub + Show on GitHub
    @@ -529,19 +529,19 @@
    -

    Undocumented

    +

    The most recent access time of the original file or directory (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var accessTime: Date?
    - Show on GitHub + Show on GitHub
    @@ -559,19 +559,19 @@
    -

    Undocumented

    +

    Name of the character set used to encode entry’s data (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var charset: String?
    - Show on GitHub + Show on GitHub
    @@ -589,19 +589,19 @@
    -

    Undocumented

    +

    Comment associated with the entry (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var comment: String?
    - Show on GitHub + Show on GitHub
    @@ -619,19 +619,19 @@
    -

    Undocumented

    +

    Path to linked entry (PAX only).

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var linkPath: String?
    - Show on GitHub + Show on GitHub
    @@ -649,19 +649,19 @@
    -

    Undocumented

    +

    Other entries from PAX extended headers.

    Declaration

    Swift

    - 
    public class TarEntry: ContainerEntry
    + 
    public private(set) var unknownExtendedHeaderEntries: [String: String] = [:]
    - Show on GitHub + Show on GitHub
    @@ -680,12 +680,6 @@

    Returns data associated with this entry.

    -
    -

    Note

    - Returned Data object with the size of 0 can either indicate that the entry is an empty file -or it is a directory. - -
    @@ -697,7 +691,7 @@ or it is a directory.
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry/EntryType.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry/EntryType.html index 5a40df63..cfc0eb1e 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry/EntryType.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/TarEntry/EntryType.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -170,7 +170,13 @@

    EntryType

    -

    Undocumented

    +
    +
    + 
    public enum EntryType: String
    + +
    +
    +

    Represents a type of an entry.

    @@ -192,11 +198,19 @@
    -

    Undocumented

    +

    Normal file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case normal = "0"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -218,11 +232,19 @@
    -

    Undocumented

    +

    Hard linked entry.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case hardLink = "1"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -244,11 +266,19 @@
    -

    Undocumented

    +

    Symbolically linked entry.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case symbolicLink = "2"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -270,11 +300,19 @@
    -

    Undocumented

    +

    Character special file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case characterSpecial = "3"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -296,11 +334,19 @@
    -

    Undocumented

    +

    Block special file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case blockSpecial = "4"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -322,11 +368,19 @@
    -

    Undocumented

    +

    Directory.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case directory = "5"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -348,11 +402,19 @@
    -

    Undocumented

    +

    FIFO special file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fifo = "6"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -374,11 +436,19 @@
    -

    Undocumented

    +

    Contiguous file.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case contiguous = "7"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -400,11 +470,19 @@
    -

    Undocumented

    +

    PAX global extended header. (Should not be encountered separately).

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case globalExtendedHeader = "g"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -426,11 +504,19 @@
    -

    Undocumented

    +

    PAX local extended header. (Should not be encountered separately).

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case localExtendedHeader = "x"
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -452,11 +538,19 @@
    -

    Undocumented

    +

    Either unknown type, vendor specific or reserved value.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case vendorUnknownOrReserved
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html index 34de8365..6e80d6a7 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,7 +172,7 @@

    XZArchive

    - 
    public final class XZArchive: Archive
    + 
    public class XZArchive: Archive
    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,17 +198,18 @@
    -

    Unarchives xz archive stored in archiveData.

    +

    Unarchives XZ archive.

    -

    If data passed is not actually a xz archive, XZError will be thrown. -If filters other than LZMA2 are used in archive then XZError.wrongFilterID will be thrown.

    +

    If data passed is not actually XZ archive, XZError will be thrown. +Particularly, if filters other than LZMA2 are used in archive, +then XZError.wrongFilter will be thrown.

    -

    If data inside the archive is not actually compressed with LZMA2, -LZMAError or LZMA2Error will be thrown.

    +

    If an error happens during LZMA2 decompression, +then LZMAError or LZMA2Error will be thrown.

    Throws

    -

    LZMAError, LZMA2Error or XZError depending on the type of inconsistency in data. -It may indicate that either the data is damaged or it might not be compressed with xz or LZMA(2) at all.

    +

    LZMAError, LZMA2Error or XZError depending on the type of the problem. +It may indicate that either the archive is damaged or it might not be compressed with XZ or LZMA(2) at all.

    @@ -217,7 +218,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func unarchive(archiveData data: Data) throws -> Data
    + 
    public static func unarchive(archive data: Data) throws -> Data
    @@ -228,12 +229,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - archiveData + archive
    -

    Data compressed with xz.

    +

    Data archived using XZ format.

    @@ -245,7 +246,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Unarchived data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html index cd31f8ff..0fa4556b 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Provides function which opens ZIP archives (containers).

    +

    Provides open function for ZIP containers.

    @@ -188,9 +188,9 @@
  • - - - open(containerData:) + + + open(container:)
    @@ -198,27 +198,20 @@
    -

    Processes ZIP archive (container) and returns an array of ContainerEntries (which are actually ZipEntries). -First member of a tuple is entry’s name, second member is entry’s data.

    +

    Processes ZIP container and returns an array of ContainerEntries (which are actually ZipEntries).

    Important

    -

    The order of entries is defined by ZIP archive and, particularly, creator of given ZIP container. +

    The order of entries is defined by ZIP container and, +particularly, by a creator of a given ZIP container. It is likely that directories will be encountered earlier than files stored in those directories, -but one SHOULD NOT assume that this is the case.

    - -
    -
    -

    Note

    -

    Currently, there is no universal (platform and file system independent) method to determine if entry is a directory. -One can check this by looking at the size of entry’s data (it should be 0 for directory) AND -the last character of entry’s name (it should be ‘/’). If all of these is true then entry is likely to be a directory.

    +but one SHOULD NOT rely on any particular order.

    Throws

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

    +depending on the type of the problem. +It may indicate that either container is damaged or it might not be ZIP container at all.

    @@ -227,7 +220,7 @@ It may indicate that either the container is damaged or it might not be ZIP cont

    Declaration

    Swift

    - 
    public static func open(containerData: Data) throws -> [ContainerEntry]
    + 
    public static func open(container data: Data) throws -> [ContainerEntry]
    @@ -238,12 +231,12 @@ It may indicate that either the container is damaged or it might not be ZIP cont - containerData + container
    -

    Data of ZIP container.

    +

    ZIP container’s data.

    @@ -252,10 +245,10 @@ It may indicate that either the container is damaged or it might not be ZIP cont

    Return Value

    -

    Array of pairs ZipEntries as an array of ContainerEntries.

    +

    Array of ZipEntry as an array of ContainerEntry.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipEntry.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipEntry.html index a0976478..0ec16e22 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipEntry.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Represents either a file or directory entry inside ZIP archive.

    +

    Represents either a file or directory entry in ZIP container.

    @@ -210,7 +210,7 @@
    - Show on GitHub + Show on GitHub
    @@ -240,7 +240,7 @@
    - Show on GitHub + Show on GitHub
    @@ -258,7 +258,7 @@
    -

    File or directory attributes related to the file system of archive’s creator.

    +

    File or directory attributes related to the file system of the container’s creator.

    @@ -270,7 +270,7 @@
    - Show on GitHub + Show on GitHub
    @@ -288,19 +288,19 @@
    -

    Undocumented

    +

    Size of the data associated with the entry.

    Declaration

    Swift

    - 
    public class ZipEntry: ContainerEntry
    + 
    public var size: Int
    - Show on GitHub + Show on GitHub
    @@ -318,8 +318,9 @@
    -

    True, if an entry is likely to be a directory. -Particularly, it is true if size of data is 0 and last character of entry’s name is ‘/’.

    +

    True, if an entry is a directory. +For MS-DOS and UNIX-like container creator’s OS, the result is based on ‘external file attributes’. +Otherwise, it is true if size of data is 0 AND last character of entry’s name is ‘/’.

    @@ -331,7 +332,7 @@ Particularly, it is true if size of data is 0 and last character of entry’
    - Show on GitHub + Show on GitHub
    @@ -350,17 +351,10 @@ Particularly, it is true if size of data is 0 and last character of entry’

    Returns data associated with this entry.

    -
    -

    Note

    -

    Returned Data object with the size of 0 can either indicate that the entry is an empty file -or it is a directory.

    - -

    Throws

    -

    ZipError or any other error associated with compression type, -depending on the type of inconsistency in data. -An error can indicate that the container is damaged.

    + ZipError or any other error associated with compression type, +depending on the type of the problem. An error can indicate that container is damaged.
    @@ -374,7 +368,7 @@ An error can indicate that the container is damaged.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html index c703621d..f6e07165 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -172,11 +172,11 @@

    ZlibArchive

    - 
    public final class ZlibArchive: Archive
    + 
    public class ZlibArchive: Archive
    -

    Provides unarchive function for Zlib archives.

    +

    Provides unarchive and archive functions for Zlib archives.

    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,11 +198,11 @@
    -

    Unarchives Zlib archive stored in archiveData.

    +

    Unarchives Zlib archive.

    -

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

    +

    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.

    +

    If data in archive is not actually compressed with Deflate algorithm, DeflateError will be thrown.

    Note

    This function is specification compliant.

    @@ -210,8 +210,9 @@

    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.

    +

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

    @@ -220,7 +221,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Declaration

    Swift

    - 
    public static func unarchive(archiveData data: Data) throws -> Data
    + 
    public static func unarchive(archive data: Data) throws -> Data
    @@ -231,12 +232,12 @@ It may indicate that either the data is damaged or it might not be compressed wi - archiveData + archive
    -

    Data compressed with zlib.

    +

    Data archived with Zlib.

    @@ -248,7 +249,7 @@ It may indicate that either the data is damaged or it might not be compressed wi

    Unarchived data.

    - Show on GitHub + Show on GitHub
    @@ -266,8 +267,9 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    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.

    +

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

    If during compression something goes wrong DeflateError will be thrown.

    @@ -311,10 +313,10 @@ It will be specified in archive’s header that the compressor used slowest

    Return Value

    -

    Data object with resulting archive.

    +

    Resulting archive’s data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html index 6766e027..816aaf55 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,16 +191,8 @@

    -

    Error happened during LZMA2 decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA2 at all.

    - -
      -
    • wrongProperties: reserved bits of LZMA2 properties byte weren’t zero.
      • -
    • wrongDictionarySize: dictionary size was greater than 2^32.
      • -
    • wrongControlByte: unsupported value of LZMA2 packet’s control byte.
      • -
    • wrongReset: unsupported ‘reset’ value of LZMA2 packet’s.
      • -
    • wrongSizes: size of compressed or decompressed data wasn’t the same as specified in LZMA2 packet.
      • -
    +

    Represents an error, which happened during LZMA2 decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA2 at all.

    See more
    @@ -213,7 +205,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -235,19 +227,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during unarchiving gzip archive. -It may indicate that either the data is damaged or it might not be gzip archive at all.

    - -
      -
    • wrongMagic: first two bytes of archive were not 31 and 139.
      • -
    • wrongCompressionMethod: unsupported compression method (not 8 aka Deflate).
      • -
    • wrongFlags: unsupported flags (reserved flags weren’t 0).
      • -
    • wrongHeaderCRC: computed Cyclic Redundancy Check of archive’s header - didn’t match the archive’s value.
      • -
    • wrongCRC: computed Cyclic Redundancy Check of uncompressed data didn’t match the archive’s value. -Associated value contains already decompressed data.
      • -
    • wrongISize: size of uncompressed data modulo 2^32 didn’t match the archive’s value.
      • -
    +

    Represents an error, which happened during processing GZip archive. +It may indicate that either archive is damaged or it might not be GZip archive at all.

    See more
    @@ -260,7 +241,7 @@ Associated value contains already decompressed data.
    • - Show on GitHub + Show on GitHub
    @@ -282,22 +263,8 @@ Associated value contains already decompressed data.
    -

    Error happened during processing ZIP archive (container). -It may indicate that either the data is damaged or it might not be ZIP archive (container) at all.

    - - +

    Represents an error, which happened during processing ZIP container. +It may indicate that either container is damaged or it might not be ZIP container at all.

    See more
    @@ -310,7 +277,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -332,21 +299,8 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Error happened during LZMA decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA at all.

    - - +

    Represents an error, which happened during LZMA decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA at all.

    See more
    @@ -359,7 +313,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -381,17 +335,8 @@ than the repeat length.
    -

    Error happened during unarchiving Zlib archive. -It may indicate that either the data is damaged or it might not be Zlib archive at all.

    - - +

    Represents an error, which happened during processing Zlib archive. +It may indicate that either archive is damaged or it might not be Zlib archive at all.

    See more
    @@ -404,7 +349,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -426,15 +371,8 @@ Associated value contains already decompressed data.
    -

    Error happened during deflate decompression. -It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.

    - - +

    Represents an error, which happened during Deflate compression or decompression. +It may indicate that either the data is damaged or it might not be compressed with Deflate at all.

    See more
    @@ -447,7 +385,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -469,21 +407,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during bzip2 decompression. -It may indicate that either the data is damaged or it might not be compressed with BZip2 at all.

    - - +

    Represents an error, which happened during BZip2 decompression. +It may indicate that either data is damaged or it might not be compressed with BZip2 at all.

    See more
    @@ -496,7 +421,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -518,12 +443,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during processing TAR archive (container). -It may indicate that either the data is damaged or it might not be TAR archive (container) at all.

    - - +

    Represents an error, which happened during processing TAR container. +It may indicate that either container is damaged or it might not be TAR container at all.

    See more
    @@ -536,7 +457,7 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    - Show on GitHub + Show on GitHub
    @@ -558,23 +479,8 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Error happened during unarchiving XZ archive. -It may indicate that either the data is damaged or it might not be XZ archive at all.

    - - +

    Represents an error, which happened during unarchiving XZ archive. +It may indicate that either archive is damaged or it might not be XZ archive at all.

    See more
    @@ -587,7 +493,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/BZip2Error.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/BZip2Error.html index 319fa64d..a5bfdd2f 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/BZip2Error.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/BZip2Error.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,21 +176,8 @@ -

    Error happened during bzip2 decompression. -It may indicate that either the data is damaged or it might not be compressed with BZip2 at all.

    - - +

    Represents an error, which happened during BZip2 decompression. +It may indicate that either data is damaged or it might not be compressed with BZip2 at all.

    @@ -212,7 +199,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Magic number was not 0x425a.

    +

    ‘Magic’ number is not 0x425a.

    @@ -224,7 +211,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -246,7 +233,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Compression method was not type ‘h’ (not Huffman).

    +

    Compression method is not type ‘h’ (not Huffman).

    @@ -258,7 +245,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -280,7 +267,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown block size (not from ‘0’ to ‘9’).

    +

    Unsupported block size (not from ‘0’ to ‘9’).

    @@ -292,7 +279,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -314,7 +301,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown block type (was neither ‘pi’ nor ‘sqrt(pi)’).

    +

    Unsupported block type (is neither ‘pi’ nor ‘sqrt(pi)’).

    @@ -326,7 +313,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -360,7 +347,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -394,7 +381,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -416,7 +403,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Selector was greater than total number of Huffman tables/groups.

    +

    Selector is greater than the total number of Huffman tables/groups.

    @@ -428,7 +415,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -462,7 +449,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -484,7 +471,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Symbol was not found in Huffman tree.

    +

    Symbol wasn’t found in Huffman tree.

    @@ -496,7 +483,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -518,8 +505,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Computed CRC of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in archive. +Associated value of the error contains already decompressed data.

    @@ -531,7 +518,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/DeflateError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/DeflateError.html index e7ebdcf9..ad715075 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/DeflateError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/DeflateError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,15 +176,8 @@ -

    Error happened during deflate decompression. -It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.

    - - +

    Represents an error, which happened during Deflate compression or decompression. +It may indicate that either the data is damaged or it might not be compressed with Deflate at all.

    @@ -206,7 +199,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Uncompressed block’ length and nlength bytes were not compatible.

    +

    Uncompressed block’s length and nlength bytes isn’t consistent with each other.

    @@ -218,7 +211,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -240,7 +233,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown block type (not from 0 to 2).

    +

    Unknown block type (not 0, 1 or 2).

    @@ -252,7 +245,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -286,7 +279,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -308,7 +301,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Symbol was not found in Huffman tree.

    +

    Symbol wasn’t found in Huffman tree.

    @@ -320,7 +313,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/GzipError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/GzipError.html index 54abc734..0db3728c 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/GzipError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/GzipError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,19 +176,8 @@ -

    Error happened during unarchiving gzip archive. -It may indicate that either the data is damaged or it might not be gzip archive at all.

    - - +

    Represents an error, which happened during processing GZip archive. +It may indicate that either archive is damaged or it might not be GZip archive at all.

    @@ -210,7 +199,7 @@ Associated value contains already decompressed data.
    -

    First two bytes of archive were not 31 and 139.

    +

    First two bytes (‘magic’ number) of archive isn’t 31 and 139.

    @@ -222,7 +211,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -244,7 +233,7 @@ Associated value contains already decompressed data.
    -

    Compression method was other than 8 which is the only supported one.

    +

    Compression method used in archive is different from Deflate, which is the only supported one.

    @@ -256,7 +245,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -278,7 +267,8 @@ Associated value contains already decompressed data.
    -

    Reserved flags bits were not equal to 0.

    +

    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive), +that archive uses a newer version of GZip format.

    @@ -290,7 +280,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -312,7 +302,7 @@ Associated value contains already decompressed data.
    -

    Computed CRC of header didn’t match the value stored in the archive.

    +

    Computed CRC of archive’s header doesn’t match the value stored in archive.

    @@ -324,7 +314,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -346,8 +336,8 @@ Associated value contains already decompressed data.
    -

    Computed CRC of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in archive. +Associated value of the error contains already decompressed data.

    @@ -359,7 +349,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -381,7 +371,7 @@ Associated value contains already decompressed data.

    -

    Computed isize didn’t match the value stored in the archive.

    +

    Computed ‘isize’ didn’t match the value stored in the archive.

    @@ -393,7 +383,41 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub +
    +
    + + + + +
    +
    -

    Error happened during LZMA2 decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA2 at all.

    - - +

    Represents an error, which happened during LZMA2 decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA2 at all.

    @@ -207,7 +199,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Reserved bits of LZMA2 properties byte were not equal to zero.

    +

    Reserved bits of LZMA2 properties’ byte aren’t equal to zero.

    @@ -219,7 +211,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -241,7 +233,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Dictionary size was too big.

    +

    Dictionary size is too big.

    @@ -253,7 +245,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -287,7 +279,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -309,7 +301,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Unknown reset instruction encounetered in LZMA2 packet.

    +

    Unknown reset instruction encountered in LZMA2 packet.

    @@ -321,7 +313,7 @@ It may indicate that either the data is damaged or it might not be compressed wi
    - Show on GitHub + Show on GitHub
    @@ -343,8 +335,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Either size of decompressed data was not equal to specified one in LZMA2 packet or -amount of compressed data read was different from the one stored in LZMA2 packet.

    +

    Either size of decompressed data isn’t equal to the one specified in LZMA2 packet or +amount of compressed data read is different from the one stored in LZMA2 packet.

    @@ -356,7 +348,7 @@ amount of compressed data read was different from the one stored in LZMA2 packet
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMAError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMAError.html index 3aed164a..645625fe 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMAError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMAError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,21 +176,8 @@ -

    Error happened during LZMA decompression. -It may indicate that either the data is damaged or it might not be compressed with LZMA at all.

    - - +

    Represents an error, which happened during LZMA decompression. +It may indicate that either data is damaged or it might not be compressed with LZMA at all.

    @@ -212,7 +199,7 @@ than the repeat length.
    -

    Properties byte was greater than 225.

    +

    Properties’ byte is greater than 225.

    @@ -224,7 +211,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -258,7 +245,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -280,7 +267,7 @@ than the repeat length.
    -

    The number of uncompressed bytes hit limit in the middle of decoding.

    +

    Size of uncompressed data hit specified limit in the middle of decoding.

    @@ -292,7 +279,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -326,7 +313,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -360,7 +347,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -394,7 +381,7 @@ than the repeat length.
    - Show on GitHub + Show on GitHub
    @@ -428,7 +415,41 @@ than the repeat length.
    - Show on GitHub + Show on GitHub +
    + + + + + +
    +
    -

    Error happened during processing TAR archive (container). -It may indicate that either the data is damaged or it might not be TAR archive (container) at all.

    - - +

    Represents an error, which happened during processing TAR container. +It may indicate that either container is damaged or it might not be TAR container at all.

    @@ -203,19 +199,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Size of data is too small, even to contain only one header.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case tooSmallFileIsPassed
    - Show on GitHub + Show on GitHub
    @@ -237,19 +233,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Failed to process a field as a number.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case fieldIsNotNumber
    - Show on GitHub + Show on GitHub
    @@ -271,19 +267,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Computed checksum of a header doesn’t match the value stored in container.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case wrongHeaderChecksum
    - Show on GitHub + Show on GitHub
    @@ -305,19 +301,19 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Unsupported version of USTAR format.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case wrongUstarVersion
    - Show on GitHub + Show on GitHub
    @@ -339,19 +335,53 @@ It may indicate that either the data is damaged or it might not be TAR archive (
    -

    Undocumented

    +

    Entry from PAX extended header is in incorrect format.

    Declaration

    Swift

    - 
    public enum TarError: Error
    + 
    case wrongPaxHeaderEntry
    - Show on GitHub + Show on GitHub +
    +
    + + + + +
    +
    -

    Error happened during unarchiving XZ archive. -It may indicate that either the data is damaged or it might not be XZ archive at all.

    - - +

    Represents an error, which happened during unarchiving XZ archive. +It may indicate that either archive is damaged or it might not be XZ archive at all.

    @@ -214,7 +199,7 @@ Associated value contains already decompressed data.
    -

    Either magic number in header or footer was not equal to predefined value.

    +

    Either ‘magic’ number in header or footer isn’t equal to a predefined value.

    @@ -226,7 +211,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -238,9 +223,9 @@ Associated value contains already decompressed data.
  • - - - wrongArchiveInfo + + + wrongFieldValue
    @@ -248,19 +233,19 @@ Associated value contains already decompressed data.
    • -

    One of special fields of archive had an incorrect value.

    +

    One of the fields in archive has an incorrect value.

    Declaration

    Swift

    - 
    case wrongArchiveInfo
    + 
    case wrongFieldValue
    - Show on GitHub + Show on GitHub
    @@ -282,7 +267,8 @@ Associated value contains already decompressed data.
    -

    One of special fields of archive had a reserved value.

    +

    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive), +that archive uses a newer version of XZ format.

    @@ -294,7 +280,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -316,7 +302,7 @@ Associated value contains already decompressed data.
    -

    Checksum of one of special fields of archive was incorrect.

    +

    Checksum of one of the fields of archive doesn’t match the value stored in archive.

    @@ -328,7 +314,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -350,7 +336,7 @@ Associated value contains already decompressed data.
    -

    ID of filter(s) used in archvie was unsupported.

    +

    Filter used in archvie is unsupported.

    @@ -362,7 +348,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -384,7 +370,7 @@ Associated value contains already decompressed data.
    -

    Type of checksum of archive was SHA-256.

    +

    Archive uses SHA-256 checksum which is unsupported.

    @@ -396,7 +382,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -418,8 +404,8 @@ Associated value contains already decompressed data.
    -

    Either size of decompressed data was not equal to specified one in block header or -amount of compressed data read was different from the one stored in block header.

    +

    Either size of decompressed data isn’t equal to the one specified in archive or +amount of compressed data read is different from the one stored in archive.

    @@ -431,7 +417,7 @@ amount of compressed data read was different from the one stored in block header
    - Show on GitHub + Show on GitHub
    @@ -453,8 +439,8 @@ amount of compressed data read was different from the one stored in block header
    -

    Computed checksum of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in the archive. +Associated value of the error contains already decompressed data.

    @@ -466,7 +452,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -488,7 +474,7 @@ Associated value contains already decompressed data.

    -

    Unsupported padding of a structure in the archive.

    +

    Padding (null-bytes appended to an archive’s structure) is incorrect.

    @@ -500,7 +486,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    @@ -534,7 +520,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZipError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZipError.html index 047dfc95..e74bfd4e 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZipError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZipError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,22 +176,8 @@ -

    Error happened during processing ZIP archive (container). -It may indicate that either the data is damaged or it might not be ZIP archive (container) at all.

    - - +

    Represents an error, which happened during processing ZIP container. +It may indicate that either container is damaged or it might not be ZIP container at all.

    @@ -213,7 +199,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    End of Central Directoty record was not found.

    +

    End of Central Directoty record wasn’t found.

    @@ -225,7 +211,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -247,7 +233,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong signature of one of ZIP container’s structures.

    +

    Wrong signature of one of container’s structures.

    @@ -259,7 +245,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -281,7 +267,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong either compressed or uncompressed size of a ZIP container’s entry.

    +

    Wrong either compressed or uncompressed size of a container’s entry.

    @@ -293,7 +279,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -315,7 +301,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong number of version needed to extract ZIP container.

    +

    Version needed to process container is unsupported.

    @@ -327,7 +313,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -349,7 +335,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Archive either spanned or consists of several volumes. This feature is not supported.

    +

    Container is either spanned or consists of several volumes. These features aren’t supported.

    @@ -361,7 +347,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -383,7 +369,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Entry or record is encrypted. This feature is not supported.

    +

    Entry or record is encrypted. This feature isn’t supported.

    @@ -395,7 +381,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -417,7 +403,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Entry contains patched data. This feature is not supported.

    +

    Entry contains patched data. This feature isn’t supported.

    @@ -429,7 +415,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -451,7 +437,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong compression method of an entry.

    +

    Entry is compressed using unsupported compression method.

    @@ -463,7 +449,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -485,7 +471,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Wrong local header of an entry.

    +

    Local header of an entry is inconsistent with Central Directory.

    @@ -497,7 +483,7 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    - Show on GitHub + Show on GitHub
    @@ -519,8 +505,8 @@ It may indicate that either the data is damaged or it might not be ZIP archive (
    -

    Computed CRC32 of entry’s data didn’t match the value stored in the container. -Associated value contains extracted data.

    +

    Computed checksum of entry’s data doesn’t match the value stored in container. +Associated value of the error contains entry’s data.

    @@ -532,7 +518,7 @@ Associated value contains extracted data.

    - Show on GitHub + Show on GitHub
    @@ -554,19 +540,19 @@ Associated value contains extracted data.

    -

    Undocumented

    +

    Either entry’s comment or file name cannot be processed using UTF-8 encoding.

    Declaration

    Swift

    - 
    public enum ZipError: Error
    + 
    case wrongTextField
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZlibError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZlibError.html index 665a6523..61f3e13f 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZlibError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/ZlibError.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,17 +176,8 @@ -

    Error happened during unarchiving Zlib archive. -It may indicate that either the data is damaged or it might not be Zlib archive at all.

    - - +

    Represents an error, which happened during processing Zlib archive. +It may indicate that either archive is damaged or it might not be Zlib archive at all.

    @@ -208,7 +199,7 @@ Associated value contains already decompressed data.
    -

    Compression method was other than 8 which is the only supported one.

    +

    Compression method used in archive is different from Deflate, which is the only supported one.

    @@ -220,7 +211,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -242,7 +233,7 @@ Associated value contains already decompressed data.
    -

    Compression info was greater than 7 which is uncompatible number 8 compression method.

    +

    Compression info has value incompatible with Deflate compression method.

    @@ -254,7 +245,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -276,7 +267,7 @@ Associated value contains already decompressed data.
    -

    First two bytes were inconsistent with each other.

    +

    First two bytes of archive’s flags are inconsistent with each other.

    @@ -288,7 +279,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -310,7 +301,7 @@ Associated value contains already decompressed data.
    -

    Compression level was other than 0, 1, 2, 3.

    +

    Compression level has value, which is different from the supported ones.

    @@ -322,7 +313,7 @@ Associated value contains already decompressed data.
    - Show on GitHub + Show on GitHub
    @@ -344,8 +335,8 @@ Associated value contains already decompressed data.
    -

    Computed Adler-32 sum of uncompressed data didn’t match the value stored in the archive. -Associated value contains already decompressed data.

    +

    Computed checksum of uncompressed data doesn’t match the value stored in archive. +Associated value of the error contains already decompressed data.

    @@ -357,7 +348,7 @@ Associated value contains already decompressed data.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols.html index 6375a356..b49937fe 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,7 +191,7 @@

    -

    Abstract archive class which supports unarchiving.

    +

    A type that represents an archive.

    See more
    @@ -204,7 +204,7 @@
    - Show on GitHub + Show on GitHub
    @@ -222,7 +222,7 @@
    -

    Abstract decompression algorithm class which supports decompression.

    +

    A type that provides an implementation of a particular decompression algorithm.

    See more
    @@ -235,7 +235,7 @@
    - Show on GitHub + Show on GitHub
    @@ -253,12 +253,20 @@
    -

    Undocumented

    +

    A type that represents a container of files, directories and/or other data.

    See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol Container
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -276,12 +284,20 @@
    -

    Undocumented

    +

    A type that represents an entry from a container (file or directory) with attributes.

    See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol ContainerEntry
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Archive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Archive.html index 04d2e675..3b330cb5 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Archive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Archive.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Abstract archive class which supports unarchiving.

    +

    A type that represents an archive.

    @@ -188,9 +188,9 @@
  • - - - unarchive(archiveData:) + + + unarchive(archive:)
    @@ -198,19 +198,19 @@
    -

    Abstract unarchive function.

    +

    Unarchive data from the archive.

    Declaration

    Swift

    - 
    static func unarchive(archiveData: Data) throws -> Data
    + 
    static func unarchive(archive: Data) throws -> Data
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Container.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Container.html index 51bedd79..70158a29 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Container.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/Container.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -170,7 +170,13 @@

    Container

    -

    Undocumented

    +
    +
    + 
    public protocol Container
    + +
    +
    +

    A type that represents a container of files, directories and/or other data.

    @@ -182,9 +188,9 @@
  • - - - open(containerData:) + + + open(container:)
    @@ -192,11 +198,19 @@
    -

    Undocumented

    +

    Retrieve all the entries from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    static func open(container: Data) throws -> [ContainerEntry]
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/ContainerEntry.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/ContainerEntry.html index 83d16939..b7e9942d 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/ContainerEntry.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/ContainerEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -170,7 +170,13 @@

    ContainerEntry

    -

    Undocumented

    +
    +
    + 
    public protocol ContainerEntry
    + +
    +
    +

    A type that represents an entry from a container (file or directory) with attributes.

    @@ -192,11 +198,19 @@
    -

    Undocumented

    +

    Retrieve name of the entry from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    var name: String
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -214,11 +228,19 @@
    -

    Undocumented

    +

    Retrieve size of the entry’s data from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    var size: Int
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -236,11 +258,19 @@
    -

    Undocumented

    +

    Check if entry is a directory.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    var isDirectory: Bool
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -258,11 +288,19 @@
    -

    Undocumented

    +

    Retrieve entry’s data from the container.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    func data() throws -> Data
    + +
    +
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/DecompressionAlgorithm.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/DecompressionAlgorithm.html index d9edaa85..3191ec43 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/DecompressionAlgorithm.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Protocols/DecompressionAlgorithm.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Abstract decompression algorithm class which supports decompression.

    +

    A type that provides an implementation of a particular decompression algorithm.

    @@ -188,9 +188,9 @@
  • - - - decompress(compressedData:) + + + decompress(data:)
    @@ -198,19 +198,19 @@
    -

    Abstract decompress function.

    +

    Decompress data compressed with particular algorithm.

    Declaration

    Swift

    - 
    static func decompress(compressedData: Data) throws -> Data
    + 
    static func decompress(data: Data) throws -> Data
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html index 755e680d..b6d2ee06 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -191,7 +191,7 @@

    -

    A structure which provides information about gzip archive.

    +

    Represents a GZip archive’s header.

    See more
    @@ -204,7 +204,7 @@
    - Show on GitHub + Show on GitHub
    @@ -226,7 +226,7 @@
    -

    A structure which provides information about zlib archive.

    +

    Represents a Zlib archive’s header.

    See more
    @@ -239,7 +239,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader.html index 80379478..9031ee75 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    A structure which provides information about gzip archive.

    +

    Represents a GZip archive’s header.

    @@ -198,7 +198,7 @@
    -

    Supported compression methods in gzip archive.

    +

    Supported compression methods in GZip archive.

    See more
    @@ -211,7 +211,7 @@
    - Show on GitHub + Show on GitHub
    @@ -229,7 +229,7 @@
    -

    Type of file system on which gzip archive was created.

    +

    Type of file system on which GZip archive was created.

    See more
    @@ -242,7 +242,7 @@
    - Show on GitHub + Show on GitHub
    @@ -260,7 +260,7 @@
    -

    Compression method of archive. Always equals to .deflate.

    +

    Compression method of archive. Currently, always equals to .deflate.

    @@ -272,7 +272,7 @@
    - Show on GitHub + Show on GitHub
    @@ -290,7 +290,9 @@
    -

    The most recent modification time of the original file. If set to 0 (default value == unset), then nil.

    +

    The most recent modification time of the original file. +If corresponding archive’s field is set to 0, which means that no time was specified, +then this property is nil.

    @@ -302,7 +304,7 @@
    - Show on GitHub + Show on GitHub
    @@ -320,7 +322,7 @@
    -

    Type of file system on which compression took place.

    +

    Type of file system on which archivation took place.

    @@ -332,7 +334,7 @@
    - Show on GitHub + Show on GitHub
    @@ -340,9 +342,9 @@
  • - - - originalFileName + + + fileName
    @@ -350,19 +352,19 @@
    -

    Name of the original file.

    +

    Name of the original file. If archive doesn’t contain file’s name, then nil.

    Declaration

    Swift

    - 
    public let originalFileName: String?
    + 
    public let fileName: String?
    - Show on GitHub + Show on GitHub
    @@ -380,7 +382,7 @@
    -

    Comment inside the archive.

    +

    Comment stored in archive. If archive doesn’t contain any comment, then nil.

    @@ -392,7 +394,7 @@
    - Show on GitHub + Show on GitHub
    @@ -400,9 +402,9 @@
  • - - - init(archiveData:) + + + isTextFile
    @@ -410,13 +412,43 @@
    -

    Initializes the structure with the values of first ‘member’ in gzip archive presented in archiveData.

    +

    Check if file is likely to be text file or ASCII-file.

    -

    If data passed is not actually a gzip archive, GzipError will be thrown.

    +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let isTextFile: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(archive:) + +
    +
    +
    +
    +
    +
    +

    Initializes the structure with the values from the first ‘member’ of GZip archive.

    + +

    If data passed is not actually a GZip archive, GzipError will be thrown.

    Throws

    -

    GzipError. It may indicate that either the data is damaged or -it might not be compressed with gzip at all.

    +

    GzipError. It may indicate that either archive is damaged or +it might not be archived with GZip at all.

    @@ -425,7 +457,7 @@ it might not be compressed with gzip at all.

    Declaration

    Swift

    - 
    public init(archiveData: Data) throws
    + 
    public init(archive data: Data) throws
    @@ -436,12 +468,12 @@ it might not be compressed with gzip at all.

    - archiveData + archive
    -

    Data compressed with gzip.

    +

    Data archived with GZip.

    @@ -449,7 +481,7 @@ it might not be compressed with gzip at all.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html index a75c1923..899545d9 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Supported compression methods in gzip archive.

    +

    Supported compression methods in GZip archive.

    @@ -210,7 +210,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html index e8814fed..bf47adc2 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Type of file system on which gzip archive was created.

    +

    Type of file system on which GZip archive was created.

    @@ -198,7 +198,12 @@
    -

    One of many Linux systems. (It seems like modern macOS systems also fall into this category).

    +

    One of many UNIX-like systems.

    +
    +

    Note

    + It seems like modern macOS systems also fall into this category. + +
    @@ -210,7 +215,7 @@
    - Show on GitHub + Show on GitHub
    @@ -232,7 +237,7 @@
    -

    Older Macintosh (Mac OS, OS X) systems.

    +

    Older Macintosh systems.

    @@ -244,7 +249,7 @@
    - Show on GitHub + Show on GitHub
    @@ -278,7 +283,7 @@
    - Show on GitHub + Show on GitHub
    @@ -312,7 +317,7 @@
    - Show on GitHub + Show on GitHub
    @@ -334,7 +339,7 @@
    -

    File system was one of the rare systems..

    +

    File system is one of the rare systems.

    @@ -346,7 +351,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html index 61a5bf3f..933e2284 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    A structure which provides information about zlib archive.

    +

    Represents a Zlib archive’s header.

    @@ -211,7 +211,7 @@
    - Show on GitHub + Show on GitHub
    @@ -229,7 +229,7 @@
    -

    Levels of compression which can be used to create zlib archive.

    +

    Levels of compression which can be used to create Zlib archive.

    See more
    @@ -242,7 +242,7 @@
    - Show on GitHub + Show on GitHub
    @@ -260,7 +260,7 @@
    -

    Compression method of archive. Always equals to .deflate.

    +

    Compression method of archive. Currently, always equals to .deflate.

    @@ -272,7 +272,7 @@
    - Show on GitHub + Show on GitHub
    @@ -290,7 +290,7 @@
    -

    Level of compression in the archive.

    +

    Level of compression used in archive.

    @@ -302,7 +302,7 @@
    - Show on GitHub + Show on GitHub
    @@ -320,7 +320,7 @@
    -

    Size of ‘window’: moving interval of data which was used to make the archive

    +

    Size of ‘window’: moving interval of data which was used to make archive.

    @@ -332,7 +332,7 @@
    - Show on GitHub + Show on GitHub
    @@ -340,9 +340,9 @@
  • - - - init(archiveData:) + + + init(archive:)
    @@ -350,13 +350,13 @@
    -

    Initializes the structure with the values from zlib archive presented in archiveData.

    +

    Initializes the structure with the values from Zlib archive.

    -

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

    +

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

    Throws

    -

    ZlibError. It may indicate that either the data is damaged or -it might not be compressed with zlib at all.

    +

    ZlibError. It may indicate that either archive is damaged or +it might not be archived with Zlib at all.

    @@ -365,7 +365,7 @@ it might not be compressed with zlib at all.

    Declaration

    Swift

    - 
    public init(archiveData: Data) throws
    + 
    public init(archive data: Data) throws
    @@ -376,12 +376,12 @@ it might not be compressed with zlib at all.

    - archiveData + archive
    -

    Data compressed with zlib.

    +

    Data archived with zlib.

    @@ -389,7 +389,7 @@ it might not be compressed with zlib at all.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html index f0e28da0..21c22d48 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -176,7 +176,7 @@ -

    Levels of compression which can be used to create zlib archive.

    +

    Levels of compression which can be used to create Zlib archive.

    @@ -210,7 +210,7 @@
    - Show on GitHub + Show on GitHub
    @@ -244,7 +244,7 @@
    - Show on GitHub + Show on GitHub
    @@ -278,7 +278,7 @@
    - Show on GitHub + Show on GitHub
    @@ -312,7 +312,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html index c640d261..74298ff8 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html @@ -23,7 +23,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -210,7 +210,7 @@

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html index 2d2a68f9..acd592b9 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html @@ -22,7 +22,7 @@ SWCompression Docs - (75% documented) + (100% documented)

    @@ -180,7 +180,7 @@

    CocoaPods Carthage compatible

    -

    A framework which contains implementations of (de)compression algorithms.

    +

    A framework which contains implementations of (de)compression algorithms and functions which parse various archives and containers.

    Developed with Swift.

    Why have you made this framework?

    @@ -203,7 +203,8 @@ And yes, it is also in Objective-C.

  • Containers:
  • Decompression algorithms: @@ -225,7 +226,7 @@ And yes, it is also in Objective-C.

  • Zlib
  • Platform independent.
    • -
  • Swift only.
    • +
  • Written with Swift only.

    • By the way, it seems like GZip, Deflate and Zlib implementations are specification compliant.

    @@ -246,6 +247,8 @@ Available subspecs:

  • SWCompression/Gzip
  • SWCompression/Zlib
  • SWCompression/BZip2
    • +
  • SWCompression/ZIP
    • +
  • SWCompression/TAR

    • You can add some or all of them instead of pod 'SWCompression'

    @@ -254,7 +257,8 @@ Available subspecs:

    To complete installation, run pod install.

    -

    Note: Actually, there is one more subspec (SWCompression/Common) but it does not contain any end-user functions. It is included in every other subspec and should not be specified directly in Podfile.

    +

    Note: Actually, there is one more subspec (SWCompression/Common) but it does not contain any end-user functions. +It is included in every other subspec and should not be specified directly in Podfile.

    Carthage

    Add to your Cartfile github "tsolomko/SWCompression".

    @@ -270,31 +274,41 @@ Available subspecs:

    let package = Package( name: "PackageName", dependencies: [ - .Package(url: "https://github.com/tsolomko/SWCompression.git", majorVersion: 2) + .Package(url: "https://github.com/tsolomko/SWCompression.git", majorVersion: 3) ] )

    More info about SPM you can find at Swift Package Manager’s Documentation.

    +

    SWCompression/ZIP and compression methods

    + +

    Deflate is a default compression method of ZIP containers.

    + +

    This means, that if you use CocoaPods, when installing SWCompression/ZIP it will install SWCompression/Deflate as a dependency.

    + +

    However, ZIP containers can also support LZMA and BZip2. +So if you want to enable them in your Pods configuration you need to include SWCompression/LZMA and/or SWCompression/Deflate.

    + +

    If you use Carthage or Swift Package Manager you always have the full package, +and ZIP will be built with both BZip2 and LZMA support.

    Usage

    Basics

    If you’d like to decompress deflated data just use:

    let data = try! Data(contentsOf: URL(fileURLWithPath: "path/to/file"),
                      options: .mappedIfSafe)
-let decompressedData = try? Deflate.decompress(compressedData: data)
+let decompressedData = try? Deflate.decompress(data: data)

    Note: It is highly recommended to specify Data.ReadingOptions.mappedIfSafe, -especially if you are working with large files, -so you don’t run out of system memory.

    +especially if you are working with large files, so you don’t run out of system memory.

    However, it is unlikely that you will encounter deflated data outside of any archive. So, in case of GZip archive you should use:

    let decompressedData = try? GzipArchive.unarchive(archiveData: data)
    -

    One final note: every unarchive/decompress function can throw an error and +

    One final note: every SWCompression function can throw an error and you are responsible for handling them.

    Documentation

    @@ -302,8 +316,7 @@ you are responsible for handling them.

    This documentation can be found at its own website.

    Handling Errors

    -

    If you look at list of available error types and their cases, -you may be frightened by their number. +

    If you look at list of available error types and their cases, you may be frightened by their number. However, most of these cases (such as XZError.WrongMagic) exist for diagnostic purposes.

    Thus, you only need to handle the most common type of error for your archive/algorithm. @@ -311,7 +324,7 @@ For example:

    do {
   let data = try Data(contentsOf: URL(fileURLWithPath: "path/to/file"),
                       options: .mappedIfSafe)
-  let decompressedData = XZArchive.unarchive(archiveData: data)
+  let decompressedData = XZArchive.unarchive(archive: data)
 } catch let error as XZError {
   <handle XZ related error here>
 } catch let error {
@@ -340,7 +353,9 @@ so some difference in speed is expected.
    
 
    Future plans
    
 
 
diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/search.json b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/search.json
index 0812255e..e6d82172 100644
--- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/search.json
+++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/search.json
@@ -1 +1 @@
-{"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16fastestAlgorithmFMS1_S1_":{"name":"fastestAlgorithm","abstract":"
    Fastest algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13fastAlgorithmFMS1_S1_":{"name":"fastAlgorithm","abstract":"
    Fast algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16defaultAlgorithmFMS1_S1_":{"name":"defaultAlgorithm","abstract":"
    Default algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13slowAlgorithmFMS1_S1_":{"name":"slowAlgorithm","abstract":"
    Slowest algorithm but with maximum compression.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionMethod.html#/s:FOV13SWCompression10ZlibHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/ZlibHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader/CompressionLevel.html":{"name":"CompressionLevel","abstract":"
    Levels of compression which can be used to create zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Always equals to .deflate.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader16compressionLevelOS0_16CompressionLevel":{"name":"compressionLevel","abstract":"
    Level of compression in the archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader10windowSizeSi":{"name":"windowSize","abstract":"
    Size of ‘window’: moving interval of data which was used to make the archive
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:FV13SWCompression10ZlibHeadercFzT11archiveDataV10Foundation4Data_S0_":{"name":"init(archiveData:)","abstract":"
    Initializes the structure with the values from zlib archive presented in archiveData.
    ","parent_name":"ZlibHeader"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4unixFMS1_S1_":{"name":"unix","abstract":"
    One of many Linux systems. (It seems like modern macOS systems also fall into this category).
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType9macintoshFMS1_S1_":{"name":"macintosh","abstract":"
    Older Macintosh (Mac OS, OS X) systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4ntfsFMS1_S1_":{"name":"ntfs","abstract":"
    File system used in Microsoft™®© Windows™®©.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType7unknownFMS1_S1_":{"name":"unknown","abstract":"
    File system was unknown to the archiver.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType5otherFMS1_S1_":{"name":"other","abstract":"
    File system was one of the rare systems..
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/CompressionMethod.html#/s:FOV13SWCompression10GzipHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/GzipHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in gzip archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader/FileSystemType.html":{"name":"FileSystemType","abstract":"
    Type of file system on which gzip archive was created.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Always equals to .deflate.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader16modificationTimeGSqV10Foundation4Date_":{"name":"modificationTime","abstract":"
    The most recent modification time of the original file. If set to 0 (default value == unset), then nil.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader6osTypeOS0_14FileSystemType":{"name":"osType","abstract":"
    Type of file system on which compression took place.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader16originalFileNameGSqSS_":{"name":"originalFileName","abstract":"
    Name of the original file.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader7commentGSqSS_":{"name":"comment","abstract":"
    Comment inside the archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:FV13SWCompression10GzipHeadercFzT11archiveDataV10Foundation4Data_S0_":{"name":"init(archiveData:)","abstract":"
    Initializes the structure with the values of first ‘member’ in gzip archive presented in archiveData.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html":{"name":"GzipHeader","abstract":"
    A structure which provides information about gzip archive.
    "},"Structs/ZlibHeader.html":{"name":"ZlibHeader","abstract":"
    A structure which provides information about zlib archive.
    "},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4nameSS":{"name":"name","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4sizeSi":{"name":"size","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:FP13SWCompression14ContainerEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/Container.html#/s:ZFP13SWCompression9Container4openFzT13containerDataV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(containerData:)","abstract":"
    Undocumented
    ","parent_name":"Container"},"Protocols/DecompressionAlgorithm.html#/s:ZFP13SWCompression22DecompressionAlgorithm10decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Abstract decompress function.
    ","parent_name":"DecompressionAlgorithm"},"Protocols/Archive.html#/s:ZFP13SWCompression7Archive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Abstract unarchive function.
    ","parent_name":"Archive"},"Protocols/Archive.html":{"name":"Archive","abstract":"
    Abstract archive class which supports unarchiving.
    "},"Protocols/DecompressionAlgorithm.html":{"name":"DecompressionAlgorithm","abstract":"
    Abstract decompression algorithm class which supports decompression.
    "},"Protocols/Container.html":{"name":"Container","abstract":"
    Undocumented
    "},"Protocols/ContainerEntry.html":{"name":"ContainerEntry","abstract":"
    Undocumented
    "},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    Either magic number in header or footer was not equal to predefined value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError16wrongArchiveInfoFMS0_S0_":{"name":"wrongArchiveInfo","abstract":"
    One of special fields of archive had an incorrect value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError18fieldReservedValueFMS0_S0_":{"name":"fieldReservedValue","abstract":"
    One of special fields of archive had a reserved value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongInfoCRCFMS0_S0_":{"name":"wrongInfoCRC","abstract":"
    Checksum of one of special fields of archive was incorrect.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongFilterIDFMS0_S0_":{"name":"wrongFilterID","abstract":"
    ID of filter(s) used in archvie was unsupported.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError15checkTypeSHA256FMS0_S0_":{"name":"checkTypeSHA256","abstract":"
    Type of checksum of archive was SHA-256.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongDataSizeFMS0_S0_":{"name":"wrongDataSize","abstract":"
    Either size of decompressed data was not equal to specified one in block header or","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongCheckFMS0_FV10Foundation4DataS0_":{"name":"wrongCheck","abstract":"
    Computed checksum of uncompressed data didn’t match the value stored in the archive.","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongPaddingFMS0_S0_":{"name":"wrongPadding","abstract":"
    Unsupported padding of a structure in the archive.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError21multiByteIntegerErrorFMS0_S0_":{"name":"multiByteIntegerError","abstract":"
    Either null byte encountered or exceeded maximum amount bytes during reading multi byte number.
    ","parent_name":"XZError"},"Enums/TarError.html#/s:FO13SWCompression8TarError20tooSmallFileIsPassedFMS0_S0_":{"name":"tooSmallFileIsPassed","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError16fieldIsNotNumberFMS0_S0_":{"name":"fieldIsNotNumber","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongHeaderChecksumFMS0_S0_":{"name":"wrongHeaderChecksum","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError17wrongUstarVersionFMS0_S0_":{"name":"wrongUstarVersion","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongPaxHeaderEntryFMS0_S0_":{"name":"wrongPaxHeaderEntry","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    Magic number was not 0x425a.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method was not type ‘h’ (not Huffman).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockSizeFMS0_S0_":{"name":"wrongBlockSize","abstract":"
    Unknown block size (not from ‘0’ to ‘9’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unknown block type (was neither ‘pi’ nor ‘sqrt(pi)’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error15randomizedBlockFMS0_S0_":{"name":"randomizedBlock","abstract":"
    Block is randomized.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error18wrongHuffmanGroupsFMS0_S0_":{"name":"wrongHuffmanGroups","abstract":"
    Wrong number of Huffman tables/groups (should be between 2 and 6).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error13wrongSelectorFMS0_S0_":{"name":"wrongSelector","abstract":"
    Selector was greater than total number of Huffman tables/groups.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongHuffmanLengthCodeFMS0_S0_":{"name":"wrongHuffmanLengthCode","abstract":"
    Wrong code of Huffman length (should be between 0 and 20).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol was not found in Huffman tree.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed CRC of uncompressed data didn’t match the value stored in the archive.","parent_name":"BZip2Error"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError29wrongUncompressedBlockLengthsFMS0_S0_":{"name":"wrongUncompressedBlockLengths","abstract":"
    Uncompressed block’ length and nlength bytes were not compatible.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unknown block type (not from 0 to 2).
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError11wrongSymbolFMS0_S0_":{"name":"wrongSymbol","abstract":"
    Decoded symbol was found in Huffman tree but is unknown.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol was not found in Huffman tree.
    ","parent_name":"DeflateError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method was other than 8 which is the only supported one.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError20wrongCompressionInfoFMS0_S0_":{"name":"wrongCompressionInfo","abstract":"
    Compression info was greater than 7 which is uncompatible number 8 compression method.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError11wrongFcheckFMS0_S0_":{"name":"wrongFcheck","abstract":"
    First two bytes were inconsistent with each other.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError21wrongCompressionLevelFMS0_S0_":{"name":"wrongCompressionLevel","abstract":"
    Compression level was other than 0, 1, 2, 3.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError12wrongAdler32FMS0_FV10Foundation4DataS0_":{"name":"wrongAdler32","abstract":"
    Computed Adler-32 sum of uncompressed data didn’t match the value stored in the archive.","parent_name":"ZlibError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Properties byte was greater than 225.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError21rangeDecoderInitErrorFMS0_S0_":{"name":"rangeDecoderInitError","abstract":"
    Unable to initialize RanderDecorer.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError24exceededUncompressedSizeFMS0_S0_":{"name":"exceededUncompressedSize","abstract":"
    The number of uncompressed bytes hit limit in the middle of decoding.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError13windowIsEmptyFMS0_S0_":{"name":"windowIsEmpty","abstract":"
    Unable to perfrom repeat-distance decoding because there is nothing to repeat.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError23rangeDecoderFinishErrorFMS0_S0_":{"name":"rangeDecoderFinishError","abstract":"
    End of stream marker is reached, but range decoder is in incorrect state.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError16repeatWillExceedFMS0_S0_":{"name":"repeatWillExceed","abstract":"
    The number of bytes to repeat is greater than the amount bytes that is left to decode.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError17notEnoughToRepeatFMS0_S0_":{"name":"notEnoughToRepeat","abstract":"
    The amount of already decoded bytes is smaller than repeat length.
    ","parent_name":"LZMAError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError27notFoundCentralDirectoryEndFMS0_S0_":{"name":"notFoundCentralDirectoryEnd","abstract":"
    End of Central Directoty record was not found.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongSignatureFMS0_S0_":{"name":"wrongSignature","abstract":"
    Wrong signature of one of ZIP container’s structures.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError9wrongSizeFMS0_S0_":{"name":"wrongSize","abstract":"
    Wrong either compressed or uncompressed size of a ZIP container’s entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError12wrongVersionFMS0_S0_":{"name":"wrongVersion","abstract":"
    Wrong number of version needed to extract ZIP container.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError24multiVolumesNotSupportedFMS0_S0_":{"name":"multiVolumesNotSupported","abstract":"
    Archive either spanned or consists of several volumes. This feature is not supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError22encryptionNotSupportedFMS0_S0_":{"name":"encryptionNotSupported","abstract":"
    Entry or record is encrypted. This feature is not supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError20patchingNotSupportedFMS0_S0_":{"name":"patchingNotSupported","abstract":"
    Entry contains patched data. This feature is not supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError23compressionNotSupportedFMS0_S0_":{"name":"compressionNotSupported","abstract":"
    Wrong compression method of an entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError16wrongLocalHeaderFMS0_S0_":{"name":"wrongLocalHeader","abstract":"
    Wrong local header of an entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError10wrongCRC32FMS0_FV10Foundation4DataS0_":{"name":"wrongCRC32","abstract":"
    Computed CRC32 of entry’s data didn’t match the value stored in the container.","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongTextFieldFMS0_S0_":{"name":"wrongTextField","abstract":"
    Undocumented
    ","parent_name":"ZipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    First two bytes of archive were not 31 and 139.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method was other than 8 which is the only supported one.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongFlagsFMS0_S0_":{"name":"wrongFlags","abstract":"
    Reserved flags bits were not equal to 0.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError14wrongHeaderCRCFMS0_S0_":{"name":"wrongHeaderCRC","abstract":"
    Computed CRC of header didn’t match the value stored in the archive.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed CRC of uncompressed data didn’t match the value stored in the archive.","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongISizeFMS0_S0_":{"name":"wrongISize","abstract":"
    Computed isize didn’t match the value stored in the archive.
    ","parent_name":"GzipError"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Reserved bits of LZMA2 properties byte were not equal to zero.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error19wrongDictionarySizeFMS0_S0_":{"name":"wrongDictionarySize","abstract":"
    Dictionary size was too big.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error16wrongControlByteFMS0_S0_":{"name":"wrongControlByte","abstract":"
    Unknown conrol byte value of LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongResetFMS0_S0_":{"name":"wrongReset","abstract":"
    Unknown reset instruction encounetered in LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongSizesFMS0_S0_":{"name":"wrongSizes","abstract":"
    Either size of decompressed data was not equal to specified one in LZMA2 packet or","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html":{"name":"LZMA2Error","abstract":"
    Error happened during LZMA2 decompression."},"Enums/GzipError.html":{"name":"GzipError","abstract":"
    Error happened during unarchiving gzip archive."},"Enums/ZipError.html":{"name":"ZipError","abstract":"
    Error happened during processing ZIP archive (container)."},"Enums/LZMAError.html":{"name":"LZMAError","abstract":"
    Error happened during LZMA decompression."},"Enums/ZlibError.html":{"name":"ZlibError","abstract":"
    Error happened during unarchiving Zlib archive."},"Enums/DeflateError.html":{"name":"DeflateError","abstract":"
    Error happened during deflate decompression."},"Enums/BZip2Error.html":{"name":"BZip2Error","abstract":"
    Error happened during bzip2 decompression."},"Enums/TarError.html":{"name":"TarError","abstract":"
    Error happened during processing TAR archive (container)."},"Enums/XZError.html":{"name":"XZError","abstract":"
    Error happened during unarchiving XZ archive."},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Unarchives xz archive stored in archiveData.
    ","parent_name":"XZArchive"},"Classes/TarContainer.html#/s:ZFC13SWCompression12TarContainer4openFzT13containerDataV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(containerData:)","abstract":"
    Undocumented
    ","parent_name":"TarContainer"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType6normalFMS1_S1_":{"name":"normal","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType8hardLinkFMS1_S1_":{"name":"hardLink","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12symbolicLinkFMS1_S1_":{"name":"symbolicLink","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType16characterSpecialFMS1_S1_":{"name":"characterSpecial","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12blockSpecialFMS1_S1_":{"name":"blockSpecial","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType9directoryFMS1_S1_":{"name":"directory","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType4fifoFMS1_S1_":{"name":"fifo","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType10contiguousFMS1_S1_":{"name":"contiguous","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType20globalExtendedHeaderFMS1_S1_":{"name":"globalExtendedHeader","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType19localExtendedHeaderFMS1_S1_":{"name":"localExtendedHeader","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType23vendorUnknownOrReservedFMS1_S1_":{"name":"vendorUnknownOrReserved","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html":{"name":"EntryType","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4modeGSqSi_":{"name":"mode","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7ownerIDGSqSi_":{"name":"ownerID","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7groupIDGSqSi_":{"name":"groupID","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4sizeSi":{"name":"size","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry16modificationTimeV10Foundation4Date":{"name":"modificationTime","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4typeOS0_9EntryType":{"name":"type","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry13ownerUserNameGSqSS_":{"name":"ownerUserName","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry14ownerGroupNameGSqSS_":{"name":"ownerGroupName","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry10accessTimeGSqV10Foundation4Date_":{"name":"accessTime","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7charsetGSqSS_":{"name":"charset","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7commentGSqSS_":{"name":"comment","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry8linkPathGSqSS_":{"name":"linkPath","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry28unknownExtendedHeaderEntriesGVs10DictionarySSSS_":{"name":"unknownExtendedHeaderEntries","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:FC13SWCompression8TarEntry4dataFT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"TarEntry"},"Classes/BZip2.html#/s:ZFC13SWCompression5BZip210decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with BZip2 algortihm.
    ","parent_name":"BZip2"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate10decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with DEFLATE algortihm.
    ","parent_name":"Deflate"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate8compressFzT4dataV10Foundation4Data_S2_":{"name":"compress(data:)","abstract":"
    Compresses data with DEFLATE algortihm.
    ","parent_name":"Deflate"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Unarchives Zlib archive stored in archiveData.
    ","parent_name":"ZlibArchive"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive7archiveFzT4dataV10Foundation4Data_S2_":{"name":"archive(data:)","abstract":"
    Archives data into Zlib archive. Data will be also compressed with DEFLTATE algorithm.","parent_name":"ZlibArchive"},"Classes/LZMA.html#/s:ZFC13SWCompression4LZMA10decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with LZMA algortihm.
    ","parent_name":"LZMA"},"Classes/ZipContainer.html#/s:ZFC13SWCompression12ZipContainer4openFzT13containerDataV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(containerData:)","abstract":"
    Processes ZIP archive (container) and returns an array of ContainerEntries (which are actually ZipEntries).","parent_name":"ZipContainer"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry7commentGSqSS_":{"name":"comment","abstract":"
    Comment associated with the entry.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry10attributesVs6UInt32":{"name":"attributes","abstract":"
    File or directory attributes related to the file system of archive’s creator.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4sizeSi":{"name":"size","abstract":"
    Undocumented
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    True, if an entry is likely to be a directory.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"ZipEntry"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Unarchives gzip archive stored in archiveData.
    ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive7archiveFzT4dataV10Foundation4Data_S2_":{"name":"archive(data:)","abstract":"
    Archives data into GZip archive. Data will be also compressed with DEFLTATE algorithm.","parent_name":"GzipArchive"},"Classes/LZMA2.html#/s:ZFC13SWCompression5LZMA210decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with LZMA2 algortihm. LZMA2 is a modification of LZMA.
    ","parent_name":"LZMA2"},"Classes/LZMA2.html":{"name":"LZMA2","abstract":"
    Provides function to decompress data, which were compressed with LZMA2
    "},"Classes/GzipArchive.html":{"name":"GzipArchive","abstract":"
    Provides unarchive function for GZip archives.
    "},"Classes/ZipEntry.html":{"name":"ZipEntry","abstract":"
    Represents either a file or directory entry inside ZIP archive.
    "},"Classes/ZipContainer.html":{"name":"ZipContainer","abstract":"
    Provides function which opens ZIP archives (containers).
    "},"Classes/LZMA.html":{"name":"LZMA","abstract":"
    Provides function to decompress data, which were compressed with LZMA
    "},"Classes/ZlibArchive.html":{"name":"ZlibArchive","abstract":"
    Provides unarchive function for Zlib archives.
    "},"Classes/Deflate.html":{"name":"Deflate","abstract":"
    Provides function to decompress data, which were compressed with DEFLATE.
    "},"Classes/BZip2.html":{"name":"BZip2","abstract":"
    Provides function to decompress data, which were compressed using BZip2.
    "},"Classes/TarEntry.html":{"name":"TarEntry","abstract":"
    Represents either a file or directory entry inside TAR archive.
    "},"Classes/TarContainer.html":{"name":"TarContainer","abstract":"
    Provides function which opens TAR archives (containers).
    "},"Classes/XZArchive.html":{"name":"XZArchive","abstract":"
    Provides unarchive function for XZ archives.
    "},"Classes.html":{"name":"Classes","abstract":"
    The following classes are available globally.
    "},"Enums.html":{"name":"Enums","abstract":"
    The following enums are available globally.
    "},"Protocols.html":{"name":"Protocols","abstract":"
    The following protocols are available globally.
    "},"Structs.html":{"name":"Structs","abstract":"
    The following structs are available globally.
    "}}
\ No newline at end of file
+{"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16fastestAlgorithmFMS1_S1_":{"name":"fastestAlgorithm","abstract":"
    Fastest algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13fastAlgorithmFMS1_S1_":{"name":"fastAlgorithm","abstract":"
    Fast algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16defaultAlgorithmFMS1_S1_":{"name":"defaultAlgorithm","abstract":"
    Default algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13slowAlgorithmFMS1_S1_":{"name":"slowAlgorithm","abstract":"
    Slowest algorithm but with maximum compression.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionMethod.html#/s:FOV13SWCompression10ZlibHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/ZlibHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader/CompressionLevel.html":{"name":"CompressionLevel","abstract":"
    Levels of compression which can be used to create Zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Currently, always equals to .deflate.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader16compressionLevelOS0_16CompressionLevel":{"name":"compressionLevel","abstract":"
    Level of compression used in archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader10windowSizeSi":{"name":"windowSize","abstract":"
    Size of ‘window’: moving interval of data which was used to make archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:FV13SWCompression10ZlibHeadercFzT7archiveV10Foundation4Data_S0_":{"name":"init(archive:)","abstract":"
    Initializes the structure with the values from Zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4unixFMS1_S1_":{"name":"unix","abstract":"
    One of many UNIX-like systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType9macintoshFMS1_S1_":{"name":"macintosh","abstract":"
    Older Macintosh systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4ntfsFMS1_S1_":{"name":"ntfs","abstract":"
    File system used in Microsoft™®© Windows™®©.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType7unknownFMS1_S1_":{"name":"unknown","abstract":"
    File system was unknown to the archiver.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType5otherFMS1_S1_":{"name":"other","abstract":"
    File system is one of the rare systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/CompressionMethod.html#/s:FOV13SWCompression10GzipHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/GzipHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in GZip archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader/FileSystemType.html":{"name":"FileSystemType","abstract":"
    Type of file system on which GZip archive was created.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Currently, always equals to .deflate.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader16modificationTimeGSqV10Foundation4Date_":{"name":"modificationTime","abstract":"
    The most recent modification time of the original file.","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader6osTypeOS0_14FileSystemType":{"name":"osType","abstract":"
    Type of file system on which archivation took place.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader8fileNameGSqSS_":{"name":"fileName","abstract":"
    Name of the original file. If archive doesn’t contain file’s name, then nil.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader7commentGSqSS_":{"name":"comment","abstract":"
    Comment stored in archive. If archive doesn’t contain any comment, then nil.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader10isTextFileSb":{"name":"isTextFile","abstract":"
    Check if file is likely to be text file or ASCII-file.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:FV13SWCompression10GzipHeadercFzT7archiveV10Foundation4Data_S0_":{"name":"init(archive:)","abstract":"
    Initializes the structure with the values from the first ‘member’ of GZip archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html":{"name":"GzipHeader","abstract":"
    Represents a GZip archive’s header.
    "},"Structs/ZlibHeader.html":{"name":"ZlibHeader","abstract":"
    Represents a Zlib archive’s header.
    "},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4nameSS":{"name":"name","abstract":"
    Retrieve name of the entry from the container.
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4sizeSi":{"name":"size","abstract":"
    Retrieve size of the entry’s data from the container.
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    Check if entry is a directory.
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:FP13SWCompression14ContainerEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Retrieve entry’s data from the container.
    ","parent_name":"ContainerEntry"},"Protocols/Container.html#/s:ZFP13SWCompression9Container4openFzT9containerV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(container:)","abstract":"
    Retrieve all the entries from the container.
    ","parent_name":"Container"},"Protocols/DecompressionAlgorithm.html#/s:ZFP13SWCompression22DecompressionAlgorithm10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompress data compressed with particular algorithm.
    ","parent_name":"DecompressionAlgorithm"},"Protocols/Archive.html#/s:ZFP13SWCompression7Archive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchive data from the archive.
    ","parent_name":"Archive"},"Protocols/Archive.html":{"name":"Archive","abstract":"
    A type that represents an archive.
    "},"Protocols/DecompressionAlgorithm.html":{"name":"DecompressionAlgorithm","abstract":"
    A type that provides an implementation of a particular decompression algorithm.
    "},"Protocols/Container.html":{"name":"Container","abstract":"
    A type that represents a container of files, directories and/or other data.
    "},"Protocols/ContainerEntry.html":{"name":"ContainerEntry","abstract":"
    A type that represents an entry from a container (file or directory) with attributes.
    "},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    Either ‘magic’ number in header or footer isn’t equal to a predefined value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError15wrongFieldValueFMS0_S0_":{"name":"wrongFieldValue","abstract":"
    One of the fields in archive has an incorrect value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError18fieldReservedValueFMS0_S0_":{"name":"fieldReservedValue","abstract":"
    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive),","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongInfoCRCFMS0_S0_":{"name":"wrongInfoCRC","abstract":"
    Checksum of one of the fields of archive doesn’t match the value stored in archive.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongFilterIDFMS0_S0_":{"name":"wrongFilterID","abstract":"
    Filter used in archvie is unsupported.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError15checkTypeSHA256FMS0_S0_":{"name":"checkTypeSHA256","abstract":"
    Archive uses SHA-256 checksum which is unsupported.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongDataSizeFMS0_S0_":{"name":"wrongDataSize","abstract":"
    Either size of decompressed data isn’t equal to the one specified in archive or","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongCheckFMS0_FV10Foundation4DataS0_":{"name":"wrongCheck","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in the archive.","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongPaddingFMS0_S0_":{"name":"wrongPadding","abstract":"
    Padding (null-bytes appended to an archive’s structure) is incorrect.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError21multiByteIntegerErrorFMS0_S0_":{"name":"multiByteIntegerError","abstract":"
    Either null byte encountered or exceeded maximum amount bytes during reading multi byte number.
    ","parent_name":"XZError"},"Enums/TarError.html#/s:FO13SWCompression8TarError20tooSmallFileIsPassedFMS0_S0_":{"name":"tooSmallFileIsPassed","abstract":"
    Size of data is too small, even to contain only one header.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError16fieldIsNotNumberFMS0_S0_":{"name":"fieldIsNotNumber","abstract":"
    Failed to process a field as a number.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongHeaderChecksumFMS0_S0_":{"name":"wrongHeaderChecksum","abstract":"
    Computed checksum of a header doesn’t match the value stored in container.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError17wrongUstarVersionFMS0_S0_":{"name":"wrongUstarVersion","abstract":"
    Unsupported version of USTAR format.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongPaxHeaderEntryFMS0_S0_":{"name":"wrongPaxHeaderEntry","abstract":"
    Entry from PAX extended header is in incorrect format.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError14notAsciiStringFMS0_S0_":{"name":"notAsciiString","abstract":"
    Failed to process a field as an ASCII string.
    ","parent_name":"TarError"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    ‘Magic’ number is not 0x425a.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method is not type ‘h’ (not Huffman).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockSizeFMS0_S0_":{"name":"wrongBlockSize","abstract":"
    Unsupported block size (not from ‘0’ to ‘9’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unsupported block type (is neither ‘pi’ nor ‘sqrt(pi)’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error15randomizedBlockFMS0_S0_":{"name":"randomizedBlock","abstract":"
    Block is randomized.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error18wrongHuffmanGroupsFMS0_S0_":{"name":"wrongHuffmanGroups","abstract":"
    Wrong number of Huffman tables/groups (should be between 2 and 6).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error13wrongSelectorFMS0_S0_":{"name":"wrongSelector","abstract":"
    Selector is greater than the total number of Huffman tables/groups.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongHuffmanLengthCodeFMS0_S0_":{"name":"wrongHuffmanLengthCode","abstract":"
    Wrong code of Huffman length (should be between 0 and 20).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol wasn’t found in Huffman tree.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in archive.","parent_name":"BZip2Error"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError29wrongUncompressedBlockLengthsFMS0_S0_":{"name":"wrongUncompressedBlockLengths","abstract":"
    Uncompressed block’s length and nlength bytes isn’t consistent with each other.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unknown block type (not 0, 1 or 2).
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError11wrongSymbolFMS0_S0_":{"name":"wrongSymbol","abstract":"
    Decoded symbol was found in Huffman tree but is unknown.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol wasn’t found in Huffman tree.
    ","parent_name":"DeflateError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method used in archive is different from Deflate, which is the only supported one.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError20wrongCompressionInfoFMS0_S0_":{"name":"wrongCompressionInfo","abstract":"
    Compression info has value incompatible with Deflate compression method.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError11wrongFcheckFMS0_S0_":{"name":"wrongFcheck","abstract":"
    First two bytes of archive’s flags are inconsistent with each other.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError21wrongCompressionLevelFMS0_S0_":{"name":"wrongCompressionLevel","abstract":"
    Compression level has value, which is different from the supported ones.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError12wrongAdler32FMS0_FV10Foundation4DataS0_":{"name":"wrongAdler32","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in archive.","parent_name":"ZlibError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Properties’ byte is greater than 225.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError21rangeDecoderInitErrorFMS0_S0_":{"name":"rangeDecoderInitError","abstract":"
    Unable to initialize RanderDecorer.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError24exceededUncompressedSizeFMS0_S0_":{"name":"exceededUncompressedSize","abstract":"
    Size of uncompressed data hit specified limit in the middle of decoding.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError13windowIsEmptyFMS0_S0_":{"name":"windowIsEmpty","abstract":"
    Unable to perfrom repeat-distance decoding because there is nothing to repeat.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError23rangeDecoderFinishErrorFMS0_S0_":{"name":"rangeDecoderFinishError","abstract":"
    End of stream marker is reached, but range decoder is in incorrect state.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError16repeatWillExceedFMS0_S0_":{"name":"repeatWillExceed","abstract":"
    The number of bytes to repeat is greater than the amount bytes that is left to decode.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError17notEnoughToRepeatFMS0_S0_":{"name":"notEnoughToRepeat","abstract":"
    The amount of already decoded bytes is smaller than repeat length.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError23decoderIsNotInitialisedFMS0_S0_":{"name":"decoderIsNotInitialised","abstract":"
    LZMADecoder wasn’t properly initialized before decoding data.
    ","parent_name":"LZMAError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError27notFoundCentralDirectoryEndFMS0_S0_":{"name":"notFoundCentralDirectoryEnd","abstract":"
    End of Central Directoty record wasn’t found.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongSignatureFMS0_S0_":{"name":"wrongSignature","abstract":"
    Wrong signature of one of container’s structures.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError9wrongSizeFMS0_S0_":{"name":"wrongSize","abstract":"
    Wrong either compressed or uncompressed size of a container’s entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError12wrongVersionFMS0_S0_":{"name":"wrongVersion","abstract":"
    Version needed to process container is unsupported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError24multiVolumesNotSupportedFMS0_S0_":{"name":"multiVolumesNotSupported","abstract":"
    Container is either spanned or consists of several volumes. These features aren’t supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError22encryptionNotSupportedFMS0_S0_":{"name":"encryptionNotSupported","abstract":"
    Entry or record is encrypted. This feature isn’t supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError20patchingNotSupportedFMS0_S0_":{"name":"patchingNotSupported","abstract":"
    Entry contains patched data. This feature isn’t supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError23compressionNotSupportedFMS0_S0_":{"name":"compressionNotSupported","abstract":"
    Entry is compressed using unsupported compression method.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError16wrongLocalHeaderFMS0_S0_":{"name":"wrongLocalHeader","abstract":"
    Local header of an entry is inconsistent with Central Directory.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError10wrongCRC32FMS0_FV10Foundation4DataS0_":{"name":"wrongCRC32","abstract":"
    Computed checksum of entry’s data doesn’t match the value stored in container.","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongTextFieldFMS0_S0_":{"name":"wrongTextField","abstract":"
    Either entry’s comment or file name cannot be processed using UTF-8 encoding.
    ","parent_name":"ZipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    First two bytes (‘magic’ number) of archive isn’t 31 and 139.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method used in archive is different from Deflate, which is the only supported one.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongFlagsFMS0_S0_":{"name":"wrongFlags","abstract":"
    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive),","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError14wrongHeaderCRCFMS0_S0_":{"name":"wrongHeaderCRC","abstract":"
    Computed CRC of archive’s header doesn’t match the value stored in archive.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in archive.","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongISizeFMS0_S0_":{"name":"wrongISize","abstract":"
    Computed ‘isize’ didn’t match the value stored in the archive.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError21cannotEncodeISOLatin1FMS0_S0_":{"name":"cannotEncodeISOLatin1","abstract":"
    Either specified file name or comment cannot be encoded using ISO Latin-1 encoding.
    ","parent_name":"GzipError"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Reserved bits of LZMA2 properties’ byte aren’t equal to zero.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error19wrongDictionarySizeFMS0_S0_":{"name":"wrongDictionarySize","abstract":"
    Dictionary size is too big.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error16wrongControlByteFMS0_S0_":{"name":"wrongControlByte","abstract":"
    Unknown conrol byte value of LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongResetFMS0_S0_":{"name":"wrongReset","abstract":"
    Unknown reset instruction encountered in LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongSizesFMS0_S0_":{"name":"wrongSizes","abstract":"
    Either size of decompressed data isn’t equal to the one specified in LZMA2 packet or","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html":{"name":"LZMA2Error","abstract":"
    Represents an error, which happened during LZMA2 decompression."},"Enums/GzipError.html":{"name":"GzipError","abstract":"
    Represents an error, which happened during processing GZip archive."},"Enums/ZipError.html":{"name":"ZipError","abstract":"
    Represents an error, which happened during processing ZIP container."},"Enums/LZMAError.html":{"name":"LZMAError","abstract":"
    Represents an error, which happened during LZMA decompression."},"Enums/ZlibError.html":{"name":"ZlibError","abstract":"
    Represents an error, which happened during processing Zlib archive."},"Enums/DeflateError.html":{"name":"DeflateError","abstract":"
    Represents an error, which happened during Deflate compression or decompression."},"Enums/BZip2Error.html":{"name":"BZip2Error","abstract":"
    Represents an error, which happened during BZip2 decompression."},"Enums/TarError.html":{"name":"TarError","abstract":"
    Represents an error, which happened during processing TAR container."},"Enums/XZError.html":{"name":"XZError","abstract":"
    Represents an error, which happened during unarchiving XZ archive."},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchives XZ archive.
    ","parent_name":"XZArchive"},"Classes/TarContainer.html#/s:ZFC13SWCompression12TarContainer4openFzT9containerV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(container:)","abstract":"
    Processes TAR container and returns an array of ContainerEntries (which are actually TarEntries).
    ","parent_name":"TarContainer"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType6normalFMS1_S1_":{"name":"normal","abstract":"
    Normal file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType8hardLinkFMS1_S1_":{"name":"hardLink","abstract":"
    Hard linked entry.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12symbolicLinkFMS1_S1_":{"name":"symbolicLink","abstract":"
    Symbolically linked entry.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType16characterSpecialFMS1_S1_":{"name":"characterSpecial","abstract":"
    Character special file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12blockSpecialFMS1_S1_":{"name":"blockSpecial","abstract":"
    Block special file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType9directoryFMS1_S1_":{"name":"directory","abstract":"
    Directory.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType4fifoFMS1_S1_":{"name":"fifo","abstract":"
    FIFO special file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType10contiguousFMS1_S1_":{"name":"contiguous","abstract":"
    Contiguous file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType20globalExtendedHeaderFMS1_S1_":{"name":"globalExtendedHeader","abstract":"
    PAX global extended header. (Should not be encountered separately).
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType19localExtendedHeaderFMS1_S1_":{"name":"localExtendedHeader","abstract":"
    PAX local extended header. (Should not be encountered separately).
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType23vendorUnknownOrReservedFMS1_S1_":{"name":"vendorUnknownOrReserved","abstract":"
    Either unknown type, vendor specific or reserved value.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html":{"name":"EntryType","abstract":"
    Represents a type of an entry.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    True, if an entry is a directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4sizeSi":{"name":"size","abstract":"
    Size of the data associated with the entry.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4modeGSqSi_":{"name":"mode","abstract":"
    File mode.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7ownerIDGSqSi_":{"name":"ownerID","abstract":"
    Owner’s ID.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7groupIDGSqSi_":{"name":"groupID","abstract":"
    Owner’s group ID.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry16modificationTimeV10Foundation4Date":{"name":"modificationTime","abstract":"
    The most recent modification time of the original file or directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4typeOS0_9EntryType":{"name":"type","abstract":"
    Type of entry.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry13ownerUserNameGSqSS_":{"name":"ownerUserName","abstract":"
    Owner’s user name.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry14ownerGroupNameGSqSS_":{"name":"ownerGroupName","abstract":"
    Owner’s group name.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry10accessTimeGSqV10Foundation4Date_":{"name":"accessTime","abstract":"
    The most recent access time of the original file or directory (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7charsetGSqSS_":{"name":"charset","abstract":"
    Name of the character set used to encode entry’s data (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7commentGSqSS_":{"name":"comment","abstract":"
    Comment associated with the entry (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry8linkPathGSqSS_":{"name":"linkPath","abstract":"
    Path to linked entry (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry28unknownExtendedHeaderEntriesGVs10DictionarySSSS_":{"name":"unknownExtendedHeaderEntries","abstract":"
    Other entries from PAX extended headers.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:FC13SWCompression8TarEntry4dataFT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"TarEntry"},"Classes/BZip2.html#/s:ZFC13SWCompression5BZip210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using BZip2 algortihm.
    ","parent_name":"BZip2"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using Deflate algortihm.
    ","parent_name":"Deflate"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate8compressFzT4dataV10Foundation4Data_S2_":{"name":"compress(data:)","abstract":"
    Compresses data with Deflate algortihm.
    ","parent_name":"Deflate"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchives Zlib archive.
    ","parent_name":"ZlibArchive"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive7archiveFzT4dataV10Foundation4Data_S2_":{"name":"archive(data:)","abstract":"
    Archives data into Zlib archive.","parent_name":"ZlibArchive"},"Classes/LZMA.html#/s:ZFC13SWCompression4LZMA10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using LZMA algortihm.
    ","parent_name":"LZMA"},"Classes/ZipContainer.html#/s:ZFC13SWCompression12ZipContainer4openFzT9containerV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(container:)","abstract":"
    Processes ZIP container and returns an array of ContainerEntries (which are actually ZipEntries).
    ","parent_name":"ZipContainer"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry7commentGSqSS_":{"name":"comment","abstract":"
    Comment associated with the entry.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry10attributesVs6UInt32":{"name":"attributes","abstract":"
    File or directory attributes related to the file system of the container’s creator.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4sizeSi":{"name":"size","abstract":"
    Size of the data associated with the entry.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    True, if an entry is a directory.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"ZipEntry"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchives GZip archive.
    ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive7archiveFzT4dataV10Foundation4Data7commentGSqSS_8fileNameGSqSS_14writeHeaderCRCSb10isTextFileSb6osTypeGSqOVS_10GzipHeader14FileSystemType_16modificationTimeGSqVS1_4Date__S2_":{"name":"archive(data:comment:fileName:writeHeaderCRC:isTextFile:osType:modificationTime:)","abstract":"
    Archives data into GZip archive, using various specified options.","parent_name":"GzipArchive"},"Classes/LZMA2.html#/s:ZFC13SWCompression5LZMA210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using LZMA2 algortihm.
    ","parent_name":"LZMA2"},"Classes/LZMA2.html":{"name":"LZMA2","abstract":"
    Provides decompression function for LZMA2 algorithm.
    "},"Classes/GzipArchive.html":{"name":"GzipArchive","abstract":"
    Provides unarchive and archive functions for GZip archives.
    "},"Classes/ZipEntry.html":{"name":"ZipEntry","abstract":"
    Represents either a file or directory entry in ZIP container.
    "},"Classes/ZipContainer.html":{"name":"ZipContainer","abstract":"
    Provides open function for ZIP containers.
    "},"Classes/LZMA.html":{"name":"LZMA","abstract":"
    Provides decompression function for LZMA algorithm.
    "},"Classes/ZlibArchive.html":{"name":"ZlibArchive","abstract":"
    Provides unarchive and archive functions for Zlib archives.
    "},"Classes/Deflate.html":{"name":"Deflate","abstract":"
    Provides compression and decompression functions for Deflate algorithm.
    "},"Classes/BZip2.html":{"name":"BZip2","abstract":"
    Provides decompression function for BZip2 algorithm.
    "},"Classes/TarEntry.html":{"name":"TarEntry","abstract":"
    Represents either a file or directory entry in TAR container.
    "},"Classes/TarContainer.html":{"name":"TarContainer","abstract":"
    Provides open function for TAR containers.
    "},"Classes/XZArchive.html":{"name":"XZArchive","abstract":"
    Provides unarchive function for XZ archives.
    "},"Classes.html":{"name":"Classes","abstract":"
    The following classes are available globally.
    "},"Enums.html":{"name":"Enums","abstract":"
    The following enums are available globally.
    "},"Protocols.html":{"name":"Protocols","abstract":"
    The following protocols are available globally.
    "},"Structs.html":{"name":"Structs","abstract":"
    The following structs are available globally.
    "}}
\ No newline at end of file
diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx b/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx
index cf8d3093..81b7f0de 100644
Binary files a/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx differ
diff --git a/docs/docsets/SWCompression.tgz b/docs/docsets/SWCompression.tgz
index efa019cc..639acc4d 100644
Binary files a/docs/docsets/SWCompression.tgz and b/docs/docsets/SWCompression.tgz differ
diff --git a/docs/index.html b/docs/index.html
index 2d2a68f9..acd592b9 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -22,7 +22,7 @@
         
           SWCompression Docs
         
-         (75% documented)
+         (100% documented)
       
    
     
       
    
@@ -180,7 +180,7 @@
 
    CocoaPods
 Carthage compatible
    
 
-
    A framework which contains implementations of (de)compression algorithms.
    
+
    A framework which contains implementations of (de)compression algorithms and functions which parse various archives and containers.
    
 
 
    Developed with Swift.
    
 
    Why have you made this framework?
    
@@ -203,7 +203,8 @@ And yes, it is also in Objective-C.
    
 
  • Containers:
 
 
      
-
    • ZIP (complying to ISO/IEC 21320 standard)
      • 
+
    • ZIP
      • 
+
    • TAR
      • 
 
    • 
 
  • Decompression algorithms:
 
@@ -225,7 +226,7 @@ And yes, it is also in Objective-C.
    
 
  • Zlib
    • 
 
 
  • Platform independent.
    • 
-
  • Swift only.
    • 
+
  • Written with Swift only.
    • 
 
 
 
    By the way, it seems like GZip, Deflate and Zlib implementations are specification compliant.
    
@@ -246,6 +247,8 @@ Available subspecs:
    
 
  • SWCompression/Gzip
    • 
 
  • SWCompression/Zlib
    • 
 
  • SWCompression/BZip2
    • 
+
  • SWCompression/ZIP
    • 
+
  • SWCompression/TAR
    • 
 
 
 
    You can add some or all of them instead of pod 'SWCompression'
    
@@ -254,7 +257,8 @@ Available subspecs:
    
 
 
    To complete installation, run pod install.
    
 
-
    Note: Actually, there is one more subspec (SWCompression/Common) but it does not contain any end-user functions. It is included in every other subspec and should not be specified directly in Podfile.
    
+
    Note: Actually, there is one more subspec (SWCompression/Common) but it does not contain any end-user functions.
+It is included in every other subspec and should not be specified directly in Podfile.
    
 
    Carthage
    
 
 
    Add to  your Cartfile github "tsolomko/SWCompression".
    
@@ -270,31 +274,41 @@ Available subspecs:
    
 let package = Package(
     name: "PackageName",
     dependencies: [
-        .Package(url: "https://github.com/tsolomko/SWCompression.git", majorVersion: 2)
+        .Package(url: "https://github.com/tsolomko/SWCompression.git", majorVersion: 3)
     ]
 )

    More info about SPM you can find at Swift Package Manager’s Documentation.

    +

    SWCompression/ZIP and compression methods

    + +

    Deflate is a default compression method of ZIP containers.

    + +

    This means, that if you use CocoaPods, when installing SWCompression/ZIP it will install SWCompression/Deflate as a dependency.

    + +

    However, ZIP containers can also support LZMA and BZip2. +So if you want to enable them in your Pods configuration you need to include SWCompression/LZMA and/or SWCompression/Deflate.

    + +

    If you use Carthage or Swift Package Manager you always have the full package, +and ZIP will be built with both BZip2 and LZMA support.

    Usage

    Basics

    If you’d like to decompress deflated data just use:

    let data = try! Data(contentsOf: URL(fileURLWithPath: "path/to/file"),
                      options: .mappedIfSafe)
-let decompressedData = try? Deflate.decompress(compressedData: data)
+let decompressedData = try? Deflate.decompress(data: data)

    Note: It is highly recommended to specify Data.ReadingOptions.mappedIfSafe, -especially if you are working with large files, -so you don’t run out of system memory.

    +especially if you are working with large files, so you don’t run out of system memory.

    However, it is unlikely that you will encounter deflated data outside of any archive. So, in case of GZip archive you should use:

    let decompressedData = try? GzipArchive.unarchive(archiveData: data)
    -

    One final note: every unarchive/decompress function can throw an error and +

    One final note: every SWCompression function can throw an error and you are responsible for handling them.

    Documentation

    @@ -302,8 +316,7 @@ you are responsible for handling them.

    This documentation can be found at its own website.

    Handling Errors

    -

    If you look at list of available error types and their cases, -you may be frightened by their number. +

    If you look at list of available error types and their cases, you may be frightened by their number. However, most of these cases (such as XZError.WrongMagic) exist for diagnostic purposes.

    Thus, you only need to handle the most common type of error for your archive/algorithm. @@ -311,7 +324,7 @@ For example:

    do {
   let data = try Data(contentsOf: URL(fileURLWithPath: "path/to/file"),
                       options: .mappedIfSafe)
-  let decompressedData = XZArchive.unarchive(archiveData: data)
+  let decompressedData = XZArchive.unarchive(archive: data)
 } catch let error as XZError {
   <handle XZ related error here>
 } catch let error {
@@ -340,7 +353,9 @@ so some difference in speed is expected.
    
 
    Future plans
    
 
 
diff --git a/docs/search.json b/docs/search.json
index 0812255e..e6d82172 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -1 +1 @@
-{"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16fastestAlgorithmFMS1_S1_":{"name":"fastestAlgorithm","abstract":"
    Fastest algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13fastAlgorithmFMS1_S1_":{"name":"fastAlgorithm","abstract":"
    Fast algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16defaultAlgorithmFMS1_S1_":{"name":"defaultAlgorithm","abstract":"
    Default algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13slowAlgorithmFMS1_S1_":{"name":"slowAlgorithm","abstract":"
    Slowest algorithm but with maximum compression.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionMethod.html#/s:FOV13SWCompression10ZlibHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/ZlibHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader/CompressionLevel.html":{"name":"CompressionLevel","abstract":"
    Levels of compression which can be used to create zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Always equals to .deflate.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader16compressionLevelOS0_16CompressionLevel":{"name":"compressionLevel","abstract":"
    Level of compression in the archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader10windowSizeSi":{"name":"windowSize","abstract":"
    Size of ‘window’: moving interval of data which was used to make the archive
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:FV13SWCompression10ZlibHeadercFzT11archiveDataV10Foundation4Data_S0_":{"name":"init(archiveData:)","abstract":"
    Initializes the structure with the values from zlib archive presented in archiveData.
    ","parent_name":"ZlibHeader"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4unixFMS1_S1_":{"name":"unix","abstract":"
    One of many Linux systems. (It seems like modern macOS systems also fall into this category).
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType9macintoshFMS1_S1_":{"name":"macintosh","abstract":"
    Older Macintosh (Mac OS, OS X) systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4ntfsFMS1_S1_":{"name":"ntfs","abstract":"
    File system used in Microsoft™®© Windows™®©.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType7unknownFMS1_S1_":{"name":"unknown","abstract":"
    File system was unknown to the archiver.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType5otherFMS1_S1_":{"name":"other","abstract":"
    File system was one of the rare systems..
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/CompressionMethod.html#/s:FOV13SWCompression10GzipHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/GzipHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in gzip archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader/FileSystemType.html":{"name":"FileSystemType","abstract":"
    Type of file system on which gzip archive was created.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Always equals to .deflate.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader16modificationTimeGSqV10Foundation4Date_":{"name":"modificationTime","abstract":"
    The most recent modification time of the original file. If set to 0 (default value == unset), then nil.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader6osTypeOS0_14FileSystemType":{"name":"osType","abstract":"
    Type of file system on which compression took place.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader16originalFileNameGSqSS_":{"name":"originalFileName","abstract":"
    Name of the original file.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader7commentGSqSS_":{"name":"comment","abstract":"
    Comment inside the archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:FV13SWCompression10GzipHeadercFzT11archiveDataV10Foundation4Data_S0_":{"name":"init(archiveData:)","abstract":"
    Initializes the structure with the values of first ‘member’ in gzip archive presented in archiveData.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html":{"name":"GzipHeader","abstract":"
    A structure which provides information about gzip archive.
    "},"Structs/ZlibHeader.html":{"name":"ZlibHeader","abstract":"
    A structure which provides information about zlib archive.
    "},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4nameSS":{"name":"name","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4sizeSi":{"name":"size","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:FP13SWCompression14ContainerEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Undocumented
    ","parent_name":"ContainerEntry"},"Protocols/Container.html#/s:ZFP13SWCompression9Container4openFzT13containerDataV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(containerData:)","abstract":"
    Undocumented
    ","parent_name":"Container"},"Protocols/DecompressionAlgorithm.html#/s:ZFP13SWCompression22DecompressionAlgorithm10decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Abstract decompress function.
    ","parent_name":"DecompressionAlgorithm"},"Protocols/Archive.html#/s:ZFP13SWCompression7Archive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Abstract unarchive function.
    ","parent_name":"Archive"},"Protocols/Archive.html":{"name":"Archive","abstract":"
    Abstract archive class which supports unarchiving.
    "},"Protocols/DecompressionAlgorithm.html":{"name":"DecompressionAlgorithm","abstract":"
    Abstract decompression algorithm class which supports decompression.
    "},"Protocols/Container.html":{"name":"Container","abstract":"
    Undocumented
    "},"Protocols/ContainerEntry.html":{"name":"ContainerEntry","abstract":"
    Undocumented
    "},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    Either magic number in header or footer was not equal to predefined value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError16wrongArchiveInfoFMS0_S0_":{"name":"wrongArchiveInfo","abstract":"
    One of special fields of archive had an incorrect value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError18fieldReservedValueFMS0_S0_":{"name":"fieldReservedValue","abstract":"
    One of special fields of archive had a reserved value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongInfoCRCFMS0_S0_":{"name":"wrongInfoCRC","abstract":"
    Checksum of one of special fields of archive was incorrect.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongFilterIDFMS0_S0_":{"name":"wrongFilterID","abstract":"
    ID of filter(s) used in archvie was unsupported.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError15checkTypeSHA256FMS0_S0_":{"name":"checkTypeSHA256","abstract":"
    Type of checksum of archive was SHA-256.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongDataSizeFMS0_S0_":{"name":"wrongDataSize","abstract":"
    Either size of decompressed data was not equal to specified one in block header or","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongCheckFMS0_FV10Foundation4DataS0_":{"name":"wrongCheck","abstract":"
    Computed checksum of uncompressed data didn’t match the value stored in the archive.","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongPaddingFMS0_S0_":{"name":"wrongPadding","abstract":"
    Unsupported padding of a structure in the archive.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError21multiByteIntegerErrorFMS0_S0_":{"name":"multiByteIntegerError","abstract":"
    Either null byte encountered or exceeded maximum amount bytes during reading multi byte number.
    ","parent_name":"XZError"},"Enums/TarError.html#/s:FO13SWCompression8TarError20tooSmallFileIsPassedFMS0_S0_":{"name":"tooSmallFileIsPassed","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError16fieldIsNotNumberFMS0_S0_":{"name":"fieldIsNotNumber","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongHeaderChecksumFMS0_S0_":{"name":"wrongHeaderChecksum","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError17wrongUstarVersionFMS0_S0_":{"name":"wrongUstarVersion","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongPaxHeaderEntryFMS0_S0_":{"name":"wrongPaxHeaderEntry","abstract":"
    Undocumented
    ","parent_name":"TarError"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    Magic number was not 0x425a.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method was not type ‘h’ (not Huffman).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockSizeFMS0_S0_":{"name":"wrongBlockSize","abstract":"
    Unknown block size (not from ‘0’ to ‘9’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unknown block type (was neither ‘pi’ nor ‘sqrt(pi)’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error15randomizedBlockFMS0_S0_":{"name":"randomizedBlock","abstract":"
    Block is randomized.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error18wrongHuffmanGroupsFMS0_S0_":{"name":"wrongHuffmanGroups","abstract":"
    Wrong number of Huffman tables/groups (should be between 2 and 6).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error13wrongSelectorFMS0_S0_":{"name":"wrongSelector","abstract":"
    Selector was greater than total number of Huffman tables/groups.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongHuffmanLengthCodeFMS0_S0_":{"name":"wrongHuffmanLengthCode","abstract":"
    Wrong code of Huffman length (should be between 0 and 20).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol was not found in Huffman tree.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed CRC of uncompressed data didn’t match the value stored in the archive.","parent_name":"BZip2Error"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError29wrongUncompressedBlockLengthsFMS0_S0_":{"name":"wrongUncompressedBlockLengths","abstract":"
    Uncompressed block’ length and nlength bytes were not compatible.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unknown block type (not from 0 to 2).
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError11wrongSymbolFMS0_S0_":{"name":"wrongSymbol","abstract":"
    Decoded symbol was found in Huffman tree but is unknown.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol was not found in Huffman tree.
    ","parent_name":"DeflateError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method was other than 8 which is the only supported one.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError20wrongCompressionInfoFMS0_S0_":{"name":"wrongCompressionInfo","abstract":"
    Compression info was greater than 7 which is uncompatible number 8 compression method.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError11wrongFcheckFMS0_S0_":{"name":"wrongFcheck","abstract":"
    First two bytes were inconsistent with each other.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError21wrongCompressionLevelFMS0_S0_":{"name":"wrongCompressionLevel","abstract":"
    Compression level was other than 0, 1, 2, 3.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError12wrongAdler32FMS0_FV10Foundation4DataS0_":{"name":"wrongAdler32","abstract":"
    Computed Adler-32 sum of uncompressed data didn’t match the value stored in the archive.","parent_name":"ZlibError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Properties byte was greater than 225.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError21rangeDecoderInitErrorFMS0_S0_":{"name":"rangeDecoderInitError","abstract":"
    Unable to initialize RanderDecorer.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError24exceededUncompressedSizeFMS0_S0_":{"name":"exceededUncompressedSize","abstract":"
    The number of uncompressed bytes hit limit in the middle of decoding.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError13windowIsEmptyFMS0_S0_":{"name":"windowIsEmpty","abstract":"
    Unable to perfrom repeat-distance decoding because there is nothing to repeat.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError23rangeDecoderFinishErrorFMS0_S0_":{"name":"rangeDecoderFinishError","abstract":"
    End of stream marker is reached, but range decoder is in incorrect state.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError16repeatWillExceedFMS0_S0_":{"name":"repeatWillExceed","abstract":"
    The number of bytes to repeat is greater than the amount bytes that is left to decode.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError17notEnoughToRepeatFMS0_S0_":{"name":"notEnoughToRepeat","abstract":"
    The amount of already decoded bytes is smaller than repeat length.
    ","parent_name":"LZMAError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError27notFoundCentralDirectoryEndFMS0_S0_":{"name":"notFoundCentralDirectoryEnd","abstract":"
    End of Central Directoty record was not found.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongSignatureFMS0_S0_":{"name":"wrongSignature","abstract":"
    Wrong signature of one of ZIP container’s structures.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError9wrongSizeFMS0_S0_":{"name":"wrongSize","abstract":"
    Wrong either compressed or uncompressed size of a ZIP container’s entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError12wrongVersionFMS0_S0_":{"name":"wrongVersion","abstract":"
    Wrong number of version needed to extract ZIP container.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError24multiVolumesNotSupportedFMS0_S0_":{"name":"multiVolumesNotSupported","abstract":"
    Archive either spanned or consists of several volumes. This feature is not supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError22encryptionNotSupportedFMS0_S0_":{"name":"encryptionNotSupported","abstract":"
    Entry or record is encrypted. This feature is not supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError20patchingNotSupportedFMS0_S0_":{"name":"patchingNotSupported","abstract":"
    Entry contains patched data. This feature is not supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError23compressionNotSupportedFMS0_S0_":{"name":"compressionNotSupported","abstract":"
    Wrong compression method of an entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError16wrongLocalHeaderFMS0_S0_":{"name":"wrongLocalHeader","abstract":"
    Wrong local header of an entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError10wrongCRC32FMS0_FV10Foundation4DataS0_":{"name":"wrongCRC32","abstract":"
    Computed CRC32 of entry’s data didn’t match the value stored in the container.","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongTextFieldFMS0_S0_":{"name":"wrongTextField","abstract":"
    Undocumented
    ","parent_name":"ZipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    First two bytes of archive were not 31 and 139.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method was other than 8 which is the only supported one.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongFlagsFMS0_S0_":{"name":"wrongFlags","abstract":"
    Reserved flags bits were not equal to 0.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError14wrongHeaderCRCFMS0_S0_":{"name":"wrongHeaderCRC","abstract":"
    Computed CRC of header didn’t match the value stored in the archive.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed CRC of uncompressed data didn’t match the value stored in the archive.","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongISizeFMS0_S0_":{"name":"wrongISize","abstract":"
    Computed isize didn’t match the value stored in the archive.
    ","parent_name":"GzipError"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Reserved bits of LZMA2 properties byte were not equal to zero.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error19wrongDictionarySizeFMS0_S0_":{"name":"wrongDictionarySize","abstract":"
    Dictionary size was too big.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error16wrongControlByteFMS0_S0_":{"name":"wrongControlByte","abstract":"
    Unknown conrol byte value of LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongResetFMS0_S0_":{"name":"wrongReset","abstract":"
    Unknown reset instruction encounetered in LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongSizesFMS0_S0_":{"name":"wrongSizes","abstract":"
    Either size of decompressed data was not equal to specified one in LZMA2 packet or","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html":{"name":"LZMA2Error","abstract":"
    Error happened during LZMA2 decompression."},"Enums/GzipError.html":{"name":"GzipError","abstract":"
    Error happened during unarchiving gzip archive."},"Enums/ZipError.html":{"name":"ZipError","abstract":"
    Error happened during processing ZIP archive (container)."},"Enums/LZMAError.html":{"name":"LZMAError","abstract":"
    Error happened during LZMA decompression."},"Enums/ZlibError.html":{"name":"ZlibError","abstract":"
    Error happened during unarchiving Zlib archive."},"Enums/DeflateError.html":{"name":"DeflateError","abstract":"
    Error happened during deflate decompression."},"Enums/BZip2Error.html":{"name":"BZip2Error","abstract":"
    Error happened during bzip2 decompression."},"Enums/TarError.html":{"name":"TarError","abstract":"
    Error happened during processing TAR archive (container)."},"Enums/XZError.html":{"name":"XZError","abstract":"
    Error happened during unarchiving XZ archive."},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Unarchives xz archive stored in archiveData.
    ","parent_name":"XZArchive"},"Classes/TarContainer.html#/s:ZFC13SWCompression12TarContainer4openFzT13containerDataV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(containerData:)","abstract":"
    Undocumented
    ","parent_name":"TarContainer"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType6normalFMS1_S1_":{"name":"normal","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType8hardLinkFMS1_S1_":{"name":"hardLink","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12symbolicLinkFMS1_S1_":{"name":"symbolicLink","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType16characterSpecialFMS1_S1_":{"name":"characterSpecial","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12blockSpecialFMS1_S1_":{"name":"blockSpecial","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType9directoryFMS1_S1_":{"name":"directory","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType4fifoFMS1_S1_":{"name":"fifo","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType10contiguousFMS1_S1_":{"name":"contiguous","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType20globalExtendedHeaderFMS1_S1_":{"name":"globalExtendedHeader","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType19localExtendedHeaderFMS1_S1_":{"name":"localExtendedHeader","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType23vendorUnknownOrReservedFMS1_S1_":{"name":"vendorUnknownOrReserved","abstract":"
    Undocumented
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html":{"name":"EntryType","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4modeGSqSi_":{"name":"mode","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7ownerIDGSqSi_":{"name":"ownerID","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7groupIDGSqSi_":{"name":"groupID","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4sizeSi":{"name":"size","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry16modificationTimeV10Foundation4Date":{"name":"modificationTime","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4typeOS0_9EntryType":{"name":"type","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry13ownerUserNameGSqSS_":{"name":"ownerUserName","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry14ownerGroupNameGSqSS_":{"name":"ownerGroupName","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry10accessTimeGSqV10Foundation4Date_":{"name":"accessTime","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7charsetGSqSS_":{"name":"charset","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7commentGSqSS_":{"name":"comment","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry8linkPathGSqSS_":{"name":"linkPath","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry28unknownExtendedHeaderEntriesGVs10DictionarySSSS_":{"name":"unknownExtendedHeaderEntries","abstract":"
    Undocumented
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:FC13SWCompression8TarEntry4dataFT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"TarEntry"},"Classes/BZip2.html#/s:ZFC13SWCompression5BZip210decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with BZip2 algortihm.
    ","parent_name":"BZip2"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate10decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with DEFLATE algortihm.
    ","parent_name":"Deflate"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate8compressFzT4dataV10Foundation4Data_S2_":{"name":"compress(data:)","abstract":"
    Compresses data with DEFLATE algortihm.
    ","parent_name":"Deflate"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Unarchives Zlib archive stored in archiveData.
    ","parent_name":"ZlibArchive"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive7archiveFzT4dataV10Foundation4Data_S2_":{"name":"archive(data:)","abstract":"
    Archives data into Zlib archive. Data will be also compressed with DEFLTATE algorithm.","parent_name":"ZlibArchive"},"Classes/LZMA.html#/s:ZFC13SWCompression4LZMA10decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with LZMA algortihm.
    ","parent_name":"LZMA"},"Classes/ZipContainer.html#/s:ZFC13SWCompression12ZipContainer4openFzT13containerDataV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(containerData:)","abstract":"
    Processes ZIP archive (container) and returns an array of ContainerEntries (which are actually ZipEntries).","parent_name":"ZipContainer"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry7commentGSqSS_":{"name":"comment","abstract":"
    Comment associated with the entry.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry10attributesVs6UInt32":{"name":"attributes","abstract":"
    File or directory attributes related to the file system of archive’s creator.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4sizeSi":{"name":"size","abstract":"
    Undocumented
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    True, if an entry is likely to be a directory.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"ZipEntry"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT11archiveDataV10Foundation4Data_S2_":{"name":"unarchive(archiveData:)","abstract":"
    Unarchives gzip archive stored in archiveData.
    ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive7archiveFzT4dataV10Foundation4Data_S2_":{"name":"archive(data:)","abstract":"
    Archives data into GZip archive. Data will be also compressed with DEFLTATE algorithm.","parent_name":"GzipArchive"},"Classes/LZMA2.html#/s:ZFC13SWCompression5LZMA210decompressFzT14compressedDataV10Foundation4Data_S2_":{"name":"decompress(compressedData:)","abstract":"
    Decompresses compressedData with LZMA2 algortihm. LZMA2 is a modification of LZMA.
    ","parent_name":"LZMA2"},"Classes/LZMA2.html":{"name":"LZMA2","abstract":"
    Provides function to decompress data, which were compressed with LZMA2
    "},"Classes/GzipArchive.html":{"name":"GzipArchive","abstract":"
    Provides unarchive function for GZip archives.
    "},"Classes/ZipEntry.html":{"name":"ZipEntry","abstract":"
    Represents either a file or directory entry inside ZIP archive.
    "},"Classes/ZipContainer.html":{"name":"ZipContainer","abstract":"
    Provides function which opens ZIP archives (containers).
    "},"Classes/LZMA.html":{"name":"LZMA","abstract":"
    Provides function to decompress data, which were compressed with LZMA
    "},"Classes/ZlibArchive.html":{"name":"ZlibArchive","abstract":"
    Provides unarchive function for Zlib archives.
    "},"Classes/Deflate.html":{"name":"Deflate","abstract":"
    Provides function to decompress data, which were compressed with DEFLATE.
    "},"Classes/BZip2.html":{"name":"BZip2","abstract":"
    Provides function to decompress data, which were compressed using BZip2.
    "},"Classes/TarEntry.html":{"name":"TarEntry","abstract":"
    Represents either a file or directory entry inside TAR archive.
    "},"Classes/TarContainer.html":{"name":"TarContainer","abstract":"
    Provides function which opens TAR archives (containers).
    "},"Classes/XZArchive.html":{"name":"XZArchive","abstract":"
    Provides unarchive function for XZ archives.
    "},"Classes.html":{"name":"Classes","abstract":"
    The following classes are available globally.
    "},"Enums.html":{"name":"Enums","abstract":"
    The following enums are available globally.
    "},"Protocols.html":{"name":"Protocols","abstract":"
    The following protocols are available globally.
    "},"Structs.html":{"name":"Structs","abstract":"
    The following structs are available globally.
    "}}
\ No newline at end of file
+{"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16fastestAlgorithmFMS1_S1_":{"name":"fastestAlgorithm","abstract":"
    Fastest algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13fastAlgorithmFMS1_S1_":{"name":"fastAlgorithm","abstract":"
    Fast algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel16defaultAlgorithmFMS1_S1_":{"name":"defaultAlgorithm","abstract":"
    Default algorithm.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionLevel.html#/s:FOV13SWCompression10ZlibHeader16CompressionLevel13slowAlgorithmFMS1_S1_":{"name":"slowAlgorithm","abstract":"
    Slowest algorithm but with maximum compression.
    ","parent_name":"CompressionLevel"},"Structs/ZlibHeader/CompressionMethod.html#/s:FOV13SWCompression10ZlibHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/ZlibHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader/CompressionLevel.html":{"name":"CompressionLevel","abstract":"
    Levels of compression which can be used to create Zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Currently, always equals to .deflate.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader16compressionLevelOS0_16CompressionLevel":{"name":"compressionLevel","abstract":"
    Level of compression used in archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:vV13SWCompression10ZlibHeader10windowSizeSi":{"name":"windowSize","abstract":"
    Size of ‘window’: moving interval of data which was used to make archive.
    ","parent_name":"ZlibHeader"},"Structs/ZlibHeader.html#/s:FV13SWCompression10ZlibHeadercFzT7archiveV10Foundation4Data_S0_":{"name":"init(archive:)","abstract":"
    Initializes the structure with the values from Zlib archive.
    ","parent_name":"ZlibHeader"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4unixFMS1_S1_":{"name":"unix","abstract":"
    One of many UNIX-like systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType9macintoshFMS1_S1_":{"name":"macintosh","abstract":"
    Older Macintosh systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType4ntfsFMS1_S1_":{"name":"ntfs","abstract":"
    File system used in Microsoft™®© Windows™®©.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType7unknownFMS1_S1_":{"name":"unknown","abstract":"
    File system was unknown to the archiver.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/FileSystemType.html#/s:FOV13SWCompression10GzipHeader14FileSystemType5otherFMS1_S1_":{"name":"other","abstract":"
    File system is one of the rare systems.
    ","parent_name":"FileSystemType"},"Structs/GzipHeader/CompressionMethod.html#/s:FOV13SWCompression10GzipHeader17CompressionMethod7deflateFMS1_S1_":{"name":"deflate","abstract":"
    The only one supported compression method (Deflate).
    ","parent_name":"CompressionMethod"},"Structs/GzipHeader/CompressionMethod.html":{"name":"CompressionMethod","abstract":"
    Supported compression methods in GZip archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader/FileSystemType.html":{"name":"FileSystemType","abstract":"
    Type of file system on which GZip archive was created.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader17compressionMethodOS0_17CompressionMethod":{"name":"compressionMethod","abstract":"
    Compression method of archive. Currently, always equals to .deflate.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader16modificationTimeGSqV10Foundation4Date_":{"name":"modificationTime","abstract":"
    The most recent modification time of the original file.","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader6osTypeOS0_14FileSystemType":{"name":"osType","abstract":"
    Type of file system on which archivation took place.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader8fileNameGSqSS_":{"name":"fileName","abstract":"
    Name of the original file. If archive doesn’t contain file’s name, then nil.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader7commentGSqSS_":{"name":"comment","abstract":"
    Comment stored in archive. If archive doesn’t contain any comment, then nil.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:vV13SWCompression10GzipHeader10isTextFileSb":{"name":"isTextFile","abstract":"
    Check if file is likely to be text file or ASCII-file.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html#/s:FV13SWCompression10GzipHeadercFzT7archiveV10Foundation4Data_S0_":{"name":"init(archive:)","abstract":"
    Initializes the structure with the values from the first ‘member’ of GZip archive.
    ","parent_name":"GzipHeader"},"Structs/GzipHeader.html":{"name":"GzipHeader","abstract":"
    Represents a GZip archive’s header.
    "},"Structs/ZlibHeader.html":{"name":"ZlibHeader","abstract":"
    Represents a Zlib archive’s header.
    "},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4nameSS":{"name":"name","abstract":"
    Retrieve name of the entry from the container.
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry4sizeSi":{"name":"size","abstract":"
    Retrieve size of the entry’s data from the container.
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:vP13SWCompression14ContainerEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    Check if entry is a directory.
    ","parent_name":"ContainerEntry"},"Protocols/ContainerEntry.html#/s:FP13SWCompression14ContainerEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Retrieve entry’s data from the container.
    ","parent_name":"ContainerEntry"},"Protocols/Container.html#/s:ZFP13SWCompression9Container4openFzT9containerV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(container:)","abstract":"
    Retrieve all the entries from the container.
    ","parent_name":"Container"},"Protocols/DecompressionAlgorithm.html#/s:ZFP13SWCompression22DecompressionAlgorithm10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompress data compressed with particular algorithm.
    ","parent_name":"DecompressionAlgorithm"},"Protocols/Archive.html#/s:ZFP13SWCompression7Archive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchive data from the archive.
    ","parent_name":"Archive"},"Protocols/Archive.html":{"name":"Archive","abstract":"
    A type that represents an archive.
    "},"Protocols/DecompressionAlgorithm.html":{"name":"DecompressionAlgorithm","abstract":"
    A type that provides an implementation of a particular decompression algorithm.
    "},"Protocols/Container.html":{"name":"Container","abstract":"
    A type that represents a container of files, directories and/or other data.
    "},"Protocols/ContainerEntry.html":{"name":"ContainerEntry","abstract":"
    A type that represents an entry from a container (file or directory) with attributes.
    "},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    Either ‘magic’ number in header or footer isn’t equal to a predefined value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError15wrongFieldValueFMS0_S0_":{"name":"wrongFieldValue","abstract":"
    One of the fields in archive has an incorrect value.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError18fieldReservedValueFMS0_S0_":{"name":"fieldReservedValue","abstract":"
    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive),","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongInfoCRCFMS0_S0_":{"name":"wrongInfoCRC","abstract":"
    Checksum of one of the fields of archive doesn’t match the value stored in archive.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongFilterIDFMS0_S0_":{"name":"wrongFilterID","abstract":"
    Filter used in archvie is unsupported.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError15checkTypeSHA256FMS0_S0_":{"name":"checkTypeSHA256","abstract":"
    Archive uses SHA-256 checksum which is unsupported.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError13wrongDataSizeFMS0_S0_":{"name":"wrongDataSize","abstract":"
    Either size of decompressed data isn’t equal to the one specified in archive or","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError10wrongCheckFMS0_FV10Foundation4DataS0_":{"name":"wrongCheck","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in the archive.","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError12wrongPaddingFMS0_S0_":{"name":"wrongPadding","abstract":"
    Padding (null-bytes appended to an archive’s structure) is incorrect.
    ","parent_name":"XZError"},"Enums/XZError.html#/s:FO13SWCompression7XZError21multiByteIntegerErrorFMS0_S0_":{"name":"multiByteIntegerError","abstract":"
    Either null byte encountered or exceeded maximum amount bytes during reading multi byte number.
    ","parent_name":"XZError"},"Enums/TarError.html#/s:FO13SWCompression8TarError20tooSmallFileIsPassedFMS0_S0_":{"name":"tooSmallFileIsPassed","abstract":"
    Size of data is too small, even to contain only one header.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError16fieldIsNotNumberFMS0_S0_":{"name":"fieldIsNotNumber","abstract":"
    Failed to process a field as a number.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongHeaderChecksumFMS0_S0_":{"name":"wrongHeaderChecksum","abstract":"
    Computed checksum of a header doesn’t match the value stored in container.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError17wrongUstarVersionFMS0_S0_":{"name":"wrongUstarVersion","abstract":"
    Unsupported version of USTAR format.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError19wrongPaxHeaderEntryFMS0_S0_":{"name":"wrongPaxHeaderEntry","abstract":"
    Entry from PAX extended header is in incorrect format.
    ","parent_name":"TarError"},"Enums/TarError.html#/s:FO13SWCompression8TarError14notAsciiStringFMS0_S0_":{"name":"notAsciiString","abstract":"
    Failed to process a field as an ASCII string.
    ","parent_name":"TarError"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    ‘Magic’ number is not 0x425a.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method is not type ‘h’ (not Huffman).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockSizeFMS0_S0_":{"name":"wrongBlockSize","abstract":"
    Unsupported block size (not from ‘0’ to ‘9’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unsupported block type (is neither ‘pi’ nor ‘sqrt(pi)’).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error15randomizedBlockFMS0_S0_":{"name":"randomizedBlock","abstract":"
    Block is randomized.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error18wrongHuffmanGroupsFMS0_S0_":{"name":"wrongHuffmanGroups","abstract":"
    Wrong number of Huffman tables/groups (should be between 2 and 6).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error13wrongSelectorFMS0_S0_":{"name":"wrongSelector","abstract":"
    Selector is greater than the total number of Huffman tables/groups.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error22wrongHuffmanLengthCodeFMS0_S0_":{"name":"wrongHuffmanLengthCode","abstract":"
    Wrong code of Huffman length (should be between 0 and 20).
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol wasn’t found in Huffman tree.
    ","parent_name":"BZip2Error"},"Enums/BZip2Error.html#/s:FO13SWCompression10BZip2Error8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in archive.","parent_name":"BZip2Error"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError29wrongUncompressedBlockLengthsFMS0_S0_":{"name":"wrongUncompressedBlockLengths","abstract":"
    Uncompressed block’s length and nlength bytes isn’t consistent with each other.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14wrongBlockTypeFMS0_S0_":{"name":"wrongBlockType","abstract":"
    Unknown block type (not 0, 1 or 2).
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError11wrongSymbolFMS0_S0_":{"name":"wrongSymbol","abstract":"
    Decoded symbol was found in Huffman tree but is unknown.
    ","parent_name":"DeflateError"},"Enums/DeflateError.html#/s:FO13SWCompression12DeflateError14symbolNotFoundFMS0_S0_":{"name":"symbolNotFound","abstract":"
    Symbol wasn’t found in Huffman tree.
    ","parent_name":"DeflateError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method used in archive is different from Deflate, which is the only supported one.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError20wrongCompressionInfoFMS0_S0_":{"name":"wrongCompressionInfo","abstract":"
    Compression info has value incompatible with Deflate compression method.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError11wrongFcheckFMS0_S0_":{"name":"wrongFcheck","abstract":"
    First two bytes of archive’s flags are inconsistent with each other.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError21wrongCompressionLevelFMS0_S0_":{"name":"wrongCompressionLevel","abstract":"
    Compression level has value, which is different from the supported ones.
    ","parent_name":"ZlibError"},"Enums/ZlibError.html#/s:FO13SWCompression9ZlibError12wrongAdler32FMS0_FV10Foundation4DataS0_":{"name":"wrongAdler32","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in archive.","parent_name":"ZlibError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Properties’ byte is greater than 225.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError21rangeDecoderInitErrorFMS0_S0_":{"name":"rangeDecoderInitError","abstract":"
    Unable to initialize RanderDecorer.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError24exceededUncompressedSizeFMS0_S0_":{"name":"exceededUncompressedSize","abstract":"
    Size of uncompressed data hit specified limit in the middle of decoding.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError13windowIsEmptyFMS0_S0_":{"name":"windowIsEmpty","abstract":"
    Unable to perfrom repeat-distance decoding because there is nothing to repeat.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError23rangeDecoderFinishErrorFMS0_S0_":{"name":"rangeDecoderFinishError","abstract":"
    End of stream marker is reached, but range decoder is in incorrect state.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError16repeatWillExceedFMS0_S0_":{"name":"repeatWillExceed","abstract":"
    The number of bytes to repeat is greater than the amount bytes that is left to decode.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError17notEnoughToRepeatFMS0_S0_":{"name":"notEnoughToRepeat","abstract":"
    The amount of already decoded bytes is smaller than repeat length.
    ","parent_name":"LZMAError"},"Enums/LZMAError.html#/s:FO13SWCompression9LZMAError23decoderIsNotInitialisedFMS0_S0_":{"name":"decoderIsNotInitialised","abstract":"
    LZMADecoder wasn’t properly initialized before decoding data.
    ","parent_name":"LZMAError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError27notFoundCentralDirectoryEndFMS0_S0_":{"name":"notFoundCentralDirectoryEnd","abstract":"
    End of Central Directoty record wasn’t found.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongSignatureFMS0_S0_":{"name":"wrongSignature","abstract":"
    Wrong signature of one of container’s structures.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError9wrongSizeFMS0_S0_":{"name":"wrongSize","abstract":"
    Wrong either compressed or uncompressed size of a container’s entry.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError12wrongVersionFMS0_S0_":{"name":"wrongVersion","abstract":"
    Version needed to process container is unsupported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError24multiVolumesNotSupportedFMS0_S0_":{"name":"multiVolumesNotSupported","abstract":"
    Container is either spanned or consists of several volumes. These features aren’t supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError22encryptionNotSupportedFMS0_S0_":{"name":"encryptionNotSupported","abstract":"
    Entry or record is encrypted. This feature isn’t supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError20patchingNotSupportedFMS0_S0_":{"name":"patchingNotSupported","abstract":"
    Entry contains patched data. This feature isn’t supported.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError23compressionNotSupportedFMS0_S0_":{"name":"compressionNotSupported","abstract":"
    Entry is compressed using unsupported compression method.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError16wrongLocalHeaderFMS0_S0_":{"name":"wrongLocalHeader","abstract":"
    Local header of an entry is inconsistent with Central Directory.
    ","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError10wrongCRC32FMS0_FV10Foundation4DataS0_":{"name":"wrongCRC32","abstract":"
    Computed checksum of entry’s data doesn’t match the value stored in container.","parent_name":"ZipError"},"Enums/ZipError.html#/s:FO13SWCompression8ZipError14wrongTextFieldFMS0_S0_":{"name":"wrongTextField","abstract":"
    Either entry’s comment or file name cannot be processed using UTF-8 encoding.
    ","parent_name":"ZipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongMagicFMS0_S0_":{"name":"wrongMagic","abstract":"
    First two bytes (‘magic’ number) of archive isn’t 31 and 139.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError22wrongCompressionMethodFMS0_S0_":{"name":"wrongCompressionMethod","abstract":"
    Compression method used in archive is different from Deflate, which is the only supported one.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongFlagsFMS0_S0_":{"name":"wrongFlags","abstract":"
    One of the reserved fields in archive has an unexpected value, which can also mean (apart from damaged archive),","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError14wrongHeaderCRCFMS0_S0_":{"name":"wrongHeaderCRC","abstract":"
    Computed CRC of archive’s header doesn’t match the value stored in archive.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError8wrongCRCFMS0_FV10Foundation4DataS0_":{"name":"wrongCRC","abstract":"
    Computed checksum of uncompressed data doesn’t match the value stored in archive.","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError10wrongISizeFMS0_S0_":{"name":"wrongISize","abstract":"
    Computed ‘isize’ didn’t match the value stored in the archive.
    ","parent_name":"GzipError"},"Enums/GzipError.html#/s:FO13SWCompression9GzipError21cannotEncodeISOLatin1FMS0_S0_":{"name":"cannotEncodeISOLatin1","abstract":"
    Either specified file name or comment cannot be encoded using ISO Latin-1 encoding.
    ","parent_name":"GzipError"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error15wrongPropertiesFMS0_S0_":{"name":"wrongProperties","abstract":"
    Reserved bits of LZMA2 properties’ byte aren’t equal to zero.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error19wrongDictionarySizeFMS0_S0_":{"name":"wrongDictionarySize","abstract":"
    Dictionary size is too big.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error16wrongControlByteFMS0_S0_":{"name":"wrongControlByte","abstract":"
    Unknown conrol byte value of LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongResetFMS0_S0_":{"name":"wrongReset","abstract":"
    Unknown reset instruction encountered in LZMA2 packet.
    ","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html#/s:FO13SWCompression10LZMA2Error10wrongSizesFMS0_S0_":{"name":"wrongSizes","abstract":"
    Either size of decompressed data isn’t equal to the one specified in LZMA2 packet or","parent_name":"LZMA2Error"},"Enums/LZMA2Error.html":{"name":"LZMA2Error","abstract":"
    Represents an error, which happened during LZMA2 decompression."},"Enums/GzipError.html":{"name":"GzipError","abstract":"
    Represents an error, which happened during processing GZip archive."},"Enums/ZipError.html":{"name":"ZipError","abstract":"
    Represents an error, which happened during processing ZIP container."},"Enums/LZMAError.html":{"name":"LZMAError","abstract":"
    Represents an error, which happened during LZMA decompression."},"Enums/ZlibError.html":{"name":"ZlibError","abstract":"
    Represents an error, which happened during processing Zlib archive."},"Enums/DeflateError.html":{"name":"DeflateError","abstract":"
    Represents an error, which happened during Deflate compression or decompression."},"Enums/BZip2Error.html":{"name":"BZip2Error","abstract":"
    Represents an error, which happened during BZip2 decompression."},"Enums/TarError.html":{"name":"TarError","abstract":"
    Represents an error, which happened during processing TAR container."},"Enums/XZError.html":{"name":"XZError","abstract":"
    Represents an error, which happened during unarchiving XZ archive."},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchives XZ archive.
    ","parent_name":"XZArchive"},"Classes/TarContainer.html#/s:ZFC13SWCompression12TarContainer4openFzT9containerV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(container:)","abstract":"
    Processes TAR container and returns an array of ContainerEntries (which are actually TarEntries).
    ","parent_name":"TarContainer"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType6normalFMS1_S1_":{"name":"normal","abstract":"
    Normal file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType8hardLinkFMS1_S1_":{"name":"hardLink","abstract":"
    Hard linked entry.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12symbolicLinkFMS1_S1_":{"name":"symbolicLink","abstract":"
    Symbolically linked entry.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType16characterSpecialFMS1_S1_":{"name":"characterSpecial","abstract":"
    Character special file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType12blockSpecialFMS1_S1_":{"name":"blockSpecial","abstract":"
    Block special file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType9directoryFMS1_S1_":{"name":"directory","abstract":"
    Directory.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType4fifoFMS1_S1_":{"name":"fifo","abstract":"
    FIFO special file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType10contiguousFMS1_S1_":{"name":"contiguous","abstract":"
    Contiguous file.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType20globalExtendedHeaderFMS1_S1_":{"name":"globalExtendedHeader","abstract":"
    PAX global extended header. (Should not be encountered separately).
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType19localExtendedHeaderFMS1_S1_":{"name":"localExtendedHeader","abstract":"
    PAX local extended header. (Should not be encountered separately).
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html#/s:FOC13SWCompression8TarEntry9EntryType23vendorUnknownOrReservedFMS1_S1_":{"name":"vendorUnknownOrReserved","abstract":"
    Either unknown type, vendor specific or reserved value.
    ","parent_name":"EntryType"},"Classes/TarEntry/EntryType.html":{"name":"EntryType","abstract":"
    Represents a type of an entry.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    True, if an entry is a directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4sizeSi":{"name":"size","abstract":"
    Size of the data associated with the entry.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4modeGSqSi_":{"name":"mode","abstract":"
    File mode.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7ownerIDGSqSi_":{"name":"ownerID","abstract":"
    Owner’s ID.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7groupIDGSqSi_":{"name":"groupID","abstract":"
    Owner’s group ID.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry16modificationTimeV10Foundation4Date":{"name":"modificationTime","abstract":"
    The most recent modification time of the original file or directory.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry4typeOS0_9EntryType":{"name":"type","abstract":"
    Type of entry.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry13ownerUserNameGSqSS_":{"name":"ownerUserName","abstract":"
    Owner’s user name.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry14ownerGroupNameGSqSS_":{"name":"ownerGroupName","abstract":"
    Owner’s group name.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry10accessTimeGSqV10Foundation4Date_":{"name":"accessTime","abstract":"
    The most recent access time of the original file or directory (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7charsetGSqSS_":{"name":"charset","abstract":"
    Name of the character set used to encode entry’s data (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry7commentGSqSS_":{"name":"comment","abstract":"
    Comment associated with the entry (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry8linkPathGSqSS_":{"name":"linkPath","abstract":"
    Path to linked entry (PAX only).
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:vC13SWCompression8TarEntry28unknownExtendedHeaderEntriesGVs10DictionarySSSS_":{"name":"unknownExtendedHeaderEntries","abstract":"
    Other entries from PAX extended headers.
    ","parent_name":"TarEntry"},"Classes/TarEntry.html#/s:FC13SWCompression8TarEntry4dataFT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"TarEntry"},"Classes/BZip2.html#/s:ZFC13SWCompression5BZip210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using BZip2 algortihm.
    ","parent_name":"BZip2"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using Deflate algortihm.
    ","parent_name":"Deflate"},"Classes/Deflate.html#/s:ZFC13SWCompression7Deflate8compressFzT4dataV10Foundation4Data_S2_":{"name":"compress(data:)","abstract":"
    Compresses data with Deflate algortihm.
    ","parent_name":"Deflate"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchives Zlib archive.
    ","parent_name":"ZlibArchive"},"Classes/ZlibArchive.html#/s:ZFC13SWCompression11ZlibArchive7archiveFzT4dataV10Foundation4Data_S2_":{"name":"archive(data:)","abstract":"
    Archives data into Zlib archive.","parent_name":"ZlibArchive"},"Classes/LZMA.html#/s:ZFC13SWCompression4LZMA10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using LZMA algortihm.
    ","parent_name":"LZMA"},"Classes/ZipContainer.html#/s:ZFC13SWCompression12ZipContainer4openFzT9containerV10Foundation4Data_GSaPS_14ContainerEntry__":{"name":"open(container:)","abstract":"
    Processes ZIP container and returns an array of ContainerEntries (which are actually ZipEntries).
    ","parent_name":"ZipContainer"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4nameSS":{"name":"name","abstract":"
    Name of the file or directory.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry7commentGSqSS_":{"name":"comment","abstract":"
    Comment associated with the entry.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry10attributesVs6UInt32":{"name":"attributes","abstract":"
    File or directory attributes related to the file system of the container’s creator.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry4sizeSi":{"name":"size","abstract":"
    Size of the data associated with the entry.
    ","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:vC13SWCompression8ZipEntry11isDirectorySb":{"name":"isDirectory","abstract":"
    True, if an entry is a directory.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"
    Returns data associated with this entry.
    ","parent_name":"ZipEntry"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"
    Unarchives GZip archive.
    ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive7archiveFzT4dataV10Foundation4Data7commentGSqSS_8fileNameGSqSS_14writeHeaderCRCSb10isTextFileSb6osTypeGSqOVS_10GzipHeader14FileSystemType_16modificationTimeGSqVS1_4Date__S2_":{"name":"archive(data:comment:fileName:writeHeaderCRC:isTextFile:osType:modificationTime:)","abstract":"
    Archives data into GZip archive, using various specified options.","parent_name":"GzipArchive"},"Classes/LZMA2.html#/s:ZFC13SWCompression5LZMA210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"
    Decompresses data using LZMA2 algortihm.
    ","parent_name":"LZMA2"},"Classes/LZMA2.html":{"name":"LZMA2","abstract":"
    Provides decompression function for LZMA2 algorithm.
    "},"Classes/GzipArchive.html":{"name":"GzipArchive","abstract":"
    Provides unarchive and archive functions for GZip archives.
    "},"Classes/ZipEntry.html":{"name":"ZipEntry","abstract":"
    Represents either a file or directory entry in ZIP container.
    "},"Classes/ZipContainer.html":{"name":"ZipContainer","abstract":"
    Provides open function for ZIP containers.
    "},"Classes/LZMA.html":{"name":"LZMA","abstract":"
    Provides decompression function for LZMA algorithm.
    "},"Classes/ZlibArchive.html":{"name":"ZlibArchive","abstract":"
    Provides unarchive and archive functions for Zlib archives.
    "},"Classes/Deflate.html":{"name":"Deflate","abstract":"
    Provides compression and decompression functions for Deflate algorithm.
    "},"Classes/BZip2.html":{"name":"BZip2","abstract":"
    Provides decompression function for BZip2 algorithm.
    "},"Classes/TarEntry.html":{"name":"TarEntry","abstract":"
    Represents either a file or directory entry in TAR container.
    "},"Classes/TarContainer.html":{"name":"TarContainer","abstract":"
    Provides open function for TAR containers.
    "},"Classes/XZArchive.html":{"name":"XZArchive","abstract":"
    Provides unarchive function for XZ archives.
    "},"Classes.html":{"name":"Classes","abstract":"
    The following classes are available globally.
    "},"Enums.html":{"name":"Enums","abstract":"
    The following enums are available globally.
    "},"Protocols.html":{"name":"Protocols","abstract":"
    The following protocols are available globally.
    "},"Structs.html":{"name":"Structs","abstract":"
    The following structs are available globally.
    "}}
\ No newline at end of file
diff --git a/docs/undocumented.json b/docs/undocumented.json
index 3ffe176b..1862018e 100644
--- a/docs/undocumented.json
+++ b/docs/undocumented.json
@@ -1,292 +1,6 @@
 {
   "warnings": [
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 27,
-      "symbol": "Container",
-      "symbol_kind": "source.lang.swift.decl.protocol",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 29,
-      "symbol": "Container.open(containerData:)",
-      "symbol_kind": "source.lang.swift.decl.function.method.static",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 33,
-      "symbol": "ContainerEntry",
-      "symbol_kind": "source.lang.swift.decl.protocol",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 35,
-      "symbol": "ContainerEntry.name",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 36,
-      "symbol": "ContainerEntry.size",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 37,
-      "symbol": "ContainerEntry.isDirectory",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/Protocols.swift",
-      "line": 39,
-      "symbol": "ContainerEntry.data()",
-      "symbol_kind": "source.lang.swift.decl.function.method.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 18,
-      "symbol": "TarError.tooSmallFileIsPassed",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 19,
-      "symbol": "TarError.fieldIsNotNumber",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 20,
-      "symbol": "TarError.wrongHeaderChecksum",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 21,
-      "symbol": "TarError.wrongUstarVersion",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 22,
-      "symbol": "TarError.wrongPaxHeaderEntry",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 28,
-      "symbol": "TarEntry.EntryType",
-      "symbol_kind": "source.lang.swift.decl.enum",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 29,
-      "symbol": "TarEntry.EntryType.normal",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 30,
-      "symbol": "TarEntry.EntryType.hardLink",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 31,
-      "symbol": "TarEntry.EntryType.symbolicLink",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 32,
-      "symbol": "TarEntry.EntryType.characterSpecial",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 33,
-      "symbol": "TarEntry.EntryType.blockSpecial",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 34,
-      "symbol": "TarEntry.EntryType.directory",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 35,
-      "symbol": "TarEntry.EntryType.fifo",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 36,
-      "symbol": "TarEntry.EntryType.contiguous",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 37,
-      "symbol": "TarEntry.EntryType.globalExtendedHeader",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 38,
-      "symbol": "TarEntry.EntryType.localExtendedHeader",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 39,
-      "symbol": "TarEntry.EntryType.vendorUnknownOrReserved",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 47,
-      "symbol": "TarEntry.isDirectory",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 51,
-      "symbol": "TarEntry.mode",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 52,
-      "symbol": "TarEntry.ownerID",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 53,
-      "symbol": "TarEntry.groupID",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 54,
-      "symbol": "TarEntry.size",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 55,
-      "symbol": "TarEntry.modificationTime",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 56,
-      "symbol": "TarEntry.type",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 58,
-      "symbol": "TarEntry.ownerUserName",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 59,
-      "symbol": "TarEntry.ownerGroupName",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 69,
-      "symbol": "TarEntry.accessTime",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 70,
-      "symbol": "TarEntry.charset",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 71,
-      "symbol": "TarEntry.comment",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 72,
-      "symbol": "TarEntry.linkPath",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 73,
-      "symbol": "TarEntry.unknownExtendedHeaderEntries",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/TarContainer.swift",
-      "line": 293,
-      "symbol": "TarContainer.open(containerData:)",
-      "symbol_kind": "source.lang.swift.decl.function.method.static",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift",
-      "line": 51,
-      "symbol": "ZipError.wrongTextField",
-      "symbol_kind": "source.lang.swift.decl.enumelement",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift",
-      "line": 75,
-      "symbol": "ZipEntry.size",
-      "symbol_kind": "source.lang.swift.decl.var.instance",
-      "warning": "undocumented"
-    }
+
   ],
   "source_directory": "/Users/timofeysolomko/Developer/SWCompression"
 }
\ No newline at end of file