diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html b/docs/Archives.html similarity index 65% rename from docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html rename to docs/Archives.html index 6b3aec15..38341aef 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs.html +++ b/docs/Archives.html @@ -1,7 +1,7 @@ - Structs Reference + Archives Reference @@ -15,14 +15,14 @@ - +

SWCompression Docs - (97% documented) + (100% documented)

@@ -43,14 +43,14 @@

SWCompression Reference - Structs Reference + Archives Reference

-

Structs

-

The following structs are available globally.

- +

Archives

+
@@ -181,6 +185,37 @@
    +
  • +
    + + + + GzipArchive + +
    +
    +
    +
    +
    +
    +

    Provides unarchive and archive functions for GZip archives.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class GzipArchive: Archive
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
  • @@ -216,6 +251,37 @@
      +
    • +
      + + + + ZlibArchive + +
      +
      +
      +
      +
      +
      +

      Provides unarchive and archive functions for Zlib archives.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class ZlibArchive: Archive
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
    • @@ -249,6 +315,41 @@
    +
    +
      +
    • +
      + + + + XZArchive + +
      +
      +
      +
      +
      +
      +

      Provides unarchive function for XZ archives.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class XZArchive: Archive
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
      • +
    +
diff --git a/docs/Classes/BZip2.html b/docs/Classes/BZip2.html index 23855fd0..7b19f03d 100644 --- a/docs/Classes/BZip2.html +++ b/docs/Classes/BZip2.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/Deflate.html b/docs/Classes/Deflate.html index f80caa8f..12d3043f 100644 --- a/docs/Classes/Deflate.html +++ b/docs/Classes/Deflate.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/GzipArchive.html b/docs/Classes/GzipArchive.html index 71b44d8e..7672adbf 100644 --- a/docs/Classes/GzipArchive.html +++ b/docs/Classes/GzipArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

@@ -201,7 +206,7 @@
-

Undocumented

+

Represents a member of multi-member of GZip archive.

See more
@@ -209,12 +214,12 @@

Declaration

Swift

- 
public class GzipArchive: Archive
+ 
public struct Member
- Show on GitHub + Show on GitHub
@@ -283,7 +288,7 @@ it might not be archived with GZip or compressed with Deflate at all.

Unarchived data.

- Show on GitHub + Show on GitHub
@@ -301,19 +306,58 @@ it might not be archived with GZip or compressed with Deflate at all.

-

Undocumented

+

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

+
+

Note

+

wrongCRC error contains only last processed member’s data as their associated value +instead of all successfully processed members. +This is a known issue and it will be fixed in future major version +because solution requires backwards-incompatible API changes.

+ +
+
+

Throws

+

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

+ +

Declaration

Swift

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

Parameters

+ + + + + + + +
+ + archive + + +
+

GZip archive with one or more members.

+
+
+
+
+

Return Value

+

Unarchived data.

+
- Show on GitHub + Show on GitHub
@@ -456,7 +500,7 @@ then - Show on GitHub + Show on GitHub diff --git a/docs/Classes/GzipArchive/Member.html b/docs/Classes/GzipArchive/Member.html index 6320eec3..b1547853 100644 --- a/docs/Classes/GzipArchive/Member.html +++ b/docs/Classes/GzipArchive/Member.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

@@ -173,7 +178,13 @@

Member

-

Undocumented

+
+
+ 
public struct Member
+ +
+
+

Represents a member of multi-member of GZip archive.

@@ -195,11 +206,19 @@
-

Undocumented

+

GZip header of a member.

+
+

Declaration

+
+

Swift

+ 
public let header: GzipHeader
+ +
+
- Show on GitHub + Show on GitHub
@@ -217,11 +236,19 @@
-

Undocumented

+

Unarchived data from a member.

+
+

Declaration

+
+

Swift

+ 
public let data: Data
+ +
+
- Show on GitHub + Show on GitHub
diff --git a/docs/Classes/LZMA.html b/docs/Classes/LZMA.html index d7fceea9..96e7a9f1 100644 --- a/docs/Classes/LZMA.html +++ b/docs/Classes/LZMA.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/LZMA2.html b/docs/Classes/LZMA2.html index 1e702b9f..cda1ca56 100644 --- a/docs/Classes/LZMA2.html +++ b/docs/Classes/LZMA2.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/TarContainer.html b/docs/Classes/TarContainer.html index a2f9ea6b..cd85b347 100644 --- a/docs/Classes/TarContainer.html +++ b/docs/Classes/TarContainer.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/TarEntry.html b/docs/Classes/TarEntry.html index 525142f1..7f8759b8 100644 --- a/docs/Classes/TarEntry.html +++ b/docs/Classes/TarEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

@@ -340,7 +345,7 @@

Declaration

Swift

- 
public var entryAttributes: [FileAttributeKey: Any]
+ 
public let entryAttributes: [FileAttributeKey: Any]
diff --git a/docs/Classes/TarEntry/EntryType.html b/docs/Classes/TarEntry/EntryType.html index ddfe49a8..f32d9768 100644 --- a/docs/Classes/TarEntry/EntryType.html +++ b/docs/Classes/TarEntry/EntryType.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/XZArchive.html b/docs/Classes/XZArchive.html index 4e04a96a..7e9ae4d2 100644 --- a/docs/Classes/XZArchive.html +++ b/docs/Classes/XZArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

@@ -267,19 +272,57 @@ It may indicate that either the archive is damaged or it might not be compressed
-

Undocumented

+

Unarchives XZ archive which contains one or more streams.

+
+

Note

+

wrongCheck error contains only last processed stream’s data as their associated value +instead of all successfully processed members. +This is a known issue and it will be fixed in future major version +because solution requires backwards-incompatible API changes.

+ +
+
+

Throws

+

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

+ +

Declaration

Swift

- 
public class XZArchive: Archive
+ 
public static func multiUnarchive(archive data: Data) throws -> [Data]
+
+

Parameters

+ + + + + + + +
+ + archive + + +
+

XZ archive with one or more streams.

+
+
+
+
+

Return Value

+

Unarchived data.

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

@@ -51,7 +51,7 @@

diff --git a/docs/Classes/ZipEntry.html b/docs/Classes/ZipEntry.html index a2cc508e..b0c53eea 100644 --- a/docs/Classes/ZipEntry.html +++ b/docs/Classes/ZipEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

@@ -371,7 +376,7 @@ Otherwise, it is true if size of data is 0 AND last character of entry’s n

Declaration

Swift

- 
public var entryAttributes: [FileAttributeKey: Any]
+ 
public let entryAttributes: [FileAttributeKey: Any]
diff --git a/docs/Classes/ZlibArchive.html b/docs/Classes/ZlibArchive.html index 8e9eb1ca..a0b2171a 100644 --- a/docs/Classes/ZlibArchive.html +++ b/docs/Classes/ZlibArchive.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Classes.html b/docs/Compression.html similarity index 53% rename from docs/Classes.html rename to docs/Compression.html index 5a2f3968..acc1c547 100644 --- a/docs/Classes.html +++ b/docs/Compression.html @@ -1,7 +1,7 @@ - Classes Reference + Compression Reference @@ -15,14 +15,14 @@ - +

SWCompression Docs - (97% documented) + (100% documented)

@@ -43,14 +43,14 @@

SWCompression Reference - Classes Reference + Compression Reference

-
-
    -
  • -
    - - - - GzipArchive - -
    -
    -
    -
    -
    -
    -

    Provides unarchive and archive functions for GZip archives.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public class GzipArchive: Archive
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
    • -
-
-
- -
-
- -
-
- -
-
-
+ diff --git a/docs/Enums/BZip2Error.html b/docs/Enums/BZip2Error.html index f206ceb7..9f4116e4 100644 --- a/docs/Enums/BZip2Error.html +++ b/docs/Enums/BZip2Error.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/DeflateError.html b/docs/Enums/DeflateError.html index 1d907d40..8d2eee6b 100644 --- a/docs/Enums/DeflateError.html +++ b/docs/Enums/DeflateError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/GzipError.html b/docs/Enums/GzipError.html index ccf29009..100e27db 100644 --- a/docs/Enums/GzipError.html +++ b/docs/Enums/GzipError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/LZMA2Error.html b/docs/Enums/LZMA2Error.html index 849a6ba4..c32efd23 100644 --- a/docs/Enums/LZMA2Error.html +++ b/docs/Enums/LZMA2Error.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/LZMAError.html b/docs/Enums/LZMAError.html index 2e00c726..6fcbc26e 100644 --- a/docs/Enums/LZMAError.html +++ b/docs/Enums/LZMAError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/TarError.html b/docs/Enums/TarError.html index 80efdd22..6acf039e 100644 --- a/docs/Enums/TarError.html +++ b/docs/Enums/TarError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/XZError.html b/docs/Enums/XZError.html index 3b3d56f0..cc0160a8 100644 --- a/docs/Enums/XZError.html +++ b/docs/Enums/XZError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/ZipError.html b/docs/Enums/ZipError.html index 8d093d34..0e3fe623 100644 --- a/docs/Enums/ZipError.html +++ b/docs/Enums/ZipError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums/ZlibError.html b/docs/Enums/ZlibError.html index ec690100..cbe4a03d 100644 --- a/docs/Enums/ZlibError.html +++ b/docs/Enums/ZlibError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

@@ -51,7 +51,7 @@

diff --git a/docs/Enums.html b/docs/Errors.html similarity index 97% rename from docs/Enums.html rename to docs/Errors.html index a0c1bb1f..48748c18 100644 --- a/docs/Enums.html +++ b/docs/Errors.html @@ -1,7 +1,7 @@ - Enums Reference + Errors Reference @@ -15,14 +15,14 @@ - +

SWCompression Docs - (97% documented) + (100% documented)

@@ -43,14 +43,14 @@

SWCompression Reference - Enums Reference + Errors Reference

-

Enums

-

The following enums are available globally.

- +

Errors

+
@@ -184,9 +188,9 @@
  • - - - LZMA2Error + + + BZip2Error
    @@ -194,165 +198,21 @@
    -

    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.

    +

    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 + See more

    Declaration

    Swift

    - 
    public enum LZMA2Error: Error
    + 
    public enum BZip2Error: Error
    - Show on GitHub -
    -
    -
    -
    • - -
    -
    -
      -
    • -
      - - - - GzipError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum GzipError: Error
      - -
      -
      -
      - Show on GitHub -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - ZipError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum ZipError: Error
      - -
      -
      -
      - Show on GitHub -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - LZMAError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum LZMAError: Error
      - -
      -
      -
      - Show on GitHub -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - ZlibError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum ZlibError: Error
      - -
      -
      -
      - Show on GitHub + Show on GitHub
      @@ -400,9 +260,9 @@ It may indicate that either the data is damaged or it might not be compressed wi
    • - - - BZip2Error + + + GzipError
      @@ -410,21 +270,93 @@ It may indicate that either the data is damaged or it might not be compressed wi
      -

      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.

      +

      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 + See more

      Declaration

      Swift

      - 
      public enum BZip2Error: Error
      + 
      public enum GzipError: Error
      - Show on GitHub + Show on GitHub +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + LZMA2Error + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum LZMA2Error: Error
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + LZMAError + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum LZMAError: Error
      + +
      +
      +
      + Show on GitHub
      @@ -503,6 +435,78 @@ It may indicate that either archive is damaged or it might not be XZ archive at
    +
    +
      +
    • +
      + + + + ZipError + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum ZipError: Error
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + ZlibError + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum ZlibError: Error
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
      • +
    +
    diff --git a/docs/Protocols.html b/docs/Protocols.html index 2630076f..137e8fb8 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -22,7 +22,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -50,7 +50,7 @@

    @@ -172,8 +177,7 @@

    Protocols

    -

    The following protocols are available globally.

    - +
    @@ -212,37 +216,6 @@ -
  • - -
    -
    -
    -
    -
    -

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

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol DecompressionAlgorithm
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
  • @@ -300,7 +273,38 @@
    - Show on GitHub + Show on GitHub +
    + + +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol DecompressionAlgorithm
    + +
    +
    +
    + Show on GitHub
    diff --git a/docs/Protocols/Archive.html b/docs/Protocols/Archive.html index 8513feff..5debefde 100644 --- a/docs/Protocols/Archive.html +++ b/docs/Protocols/Archive.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Protocols/Container.html b/docs/Protocols/Container.html index b7a8edc1..33bca1a3 100644 --- a/docs/Protocols/Container.html +++ b/docs/Protocols/Container.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Protocols/ContainerEntry.html b/docs/Protocols/ContainerEntry.html index 51fa9c4b..a8bb049a 100644 --- a/docs/Protocols/ContainerEntry.html +++ b/docs/Protocols/ContainerEntry.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -278,6 +283,42 @@
    • +
  • +
    + + + + entryAttributes + +
    +
    +
    +
    +
    +
    +

    Provides a dictionary with various attributes of the entry. +FileAttributeKey values are used as dictionary keys.

    +
    +

    Note

    + Will be renamed to attributes in 4.0. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    var entryAttributes: [FileAttributeKey: Any]
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
  • @@ -303,7 +344,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/docs/Protocols/DecompressionAlgorithm.html b/docs/Protocols/DecompressionAlgorithm.html index a1f94025..1c990471 100644 --- a/docs/Protocols/DecompressionAlgorithm.html +++ b/docs/Protocols/DecompressionAlgorithm.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Structs/GzipHeader.html b/docs/Structs/GzipHeader.html index 64c2f425..a6257042 100644 --- a/docs/Structs/GzipHeader.html +++ b/docs/Structs/GzipHeader.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Structs/GzipHeader/CompressionMethod.html b/docs/Structs/GzipHeader/CompressionMethod.html index bceb4de7..c6af7cf4 100644 --- a/docs/Structs/GzipHeader/CompressionMethod.html +++ b/docs/Structs/GzipHeader/CompressionMethod.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Structs/GzipHeader/FileSystemType.html b/docs/Structs/GzipHeader/FileSystemType.html index 235a0059..2a299823 100644 --- a/docs/Structs/GzipHeader/FileSystemType.html +++ b/docs/Structs/GzipHeader/FileSystemType.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Structs/ZlibHeader.html b/docs/Structs/ZlibHeader.html index 80eec57d..815f6229 100644 --- a/docs/Structs/ZlibHeader.html +++ b/docs/Structs/ZlibHeader.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Structs/ZlibHeader/CompressionLevel.html b/docs/Structs/ZlibHeader/CompressionLevel.html index 1e256c4d..30919717 100644 --- a/docs/Structs/ZlibHeader/CompressionLevel.html +++ b/docs/Structs/ZlibHeader/CompressionLevel.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/Structs/ZlibHeader/CompressionMethod.html b/docs/Structs/ZlibHeader/CompressionMethod.html index 3ded2f85..e4ee3e72 100644 --- a/docs/Structs/ZlibHeader/CompressionMethod.html +++ b/docs/Structs/ZlibHeader/CompressionMethod.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/badge.svg b/docs/badge.svg index ffb8f670..2606d804 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -1 +1 @@ -documentationdocumentation97%97% \ No newline at end of file +documentationdocumentation100%100% \ No newline at end of file diff --git a/docs/Structs.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Archives.html similarity index 65% rename from docs/Structs.html rename to docs/docsets/SWCompression.docset/Contents/Resources/Documents/Archives.html index 6b3aec15..38341aef 100644 --- a/docs/Structs.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Archives.html @@ -1,7 +1,7 @@ - Structs Reference + Archives Reference @@ -15,14 +15,14 @@ - +

    SWCompression Docs - (97% documented) + (100% documented)

    @@ -43,14 +43,14 @@

    SWCompression Reference - Structs Reference + Archives Reference

    -

    Structs

    -

    The following structs are available globally.

    - +

    Archives

    +
    @@ -181,6 +185,37 @@
      +
    • +
      + + + + GzipArchive + +
      +
      +
      +
      +
      +
      +

      Provides unarchive and archive functions for GZip archives.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public class GzipArchive: Archive
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
    • @@ -216,6 +251,37 @@
        +
      • +
        + + + + ZlibArchive + +
        +
        +
        +
        +
        +
        +

        Provides unarchive and archive functions for Zlib archives.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public class ZlibArchive: Archive
        + +
        +
        +
        + Show on GitHub +
        +
        +
        +
      • @@ -249,6 +315,41 @@
      +
      +
        +
      • +
        + + + + XZArchive + +
        +
        +
        +
        +
        +
        +

        Provides unarchive function for XZ archives.

        + + See more +
        +
        +

        Declaration

        +
        +

        Swift

        + 
        public class XZArchive: Archive
        + +
        +
        +
        + 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 23855fd0..7b19f03d 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 f80caa8f..12d3043f 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 71b44d8e..7672adbf 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -201,7 +206,7 @@
    -

    Undocumented

    +

    Represents a member of multi-member of GZip archive.

    See more
    @@ -209,12 +214,12 @@

    Declaration

    Swift

    - 
    public class GzipArchive: Archive
    + 
    public struct Member
    - Show on GitHub + Show on GitHub
    @@ -283,7 +288,7 @@ it might not be archived with GZip or compressed with Deflate at all.

    Unarchived data.

    - Show on GitHub + Show on GitHub
    @@ -301,19 +306,58 @@ it might not be archived with GZip or compressed with Deflate at all.

    -

    Undocumented

    +

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

    +
    +

    Note

    +

    wrongCRC error contains only last processed member’s data as their associated value +instead of all successfully processed members. +This is a known issue and it will be fixed in future major version +because solution requires backwards-incompatible API changes.

    + +
    +
    +

    Throws

    +

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

    + +

    Declaration

    Swift

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

    Parameters

    + + + + + + + +
    + + archive + + +
    +

    GZip archive with one or more members.

    +
    +
    +
    +
    +

    Return Value

    +

    Unarchived data.

    +
    - Show on GitHub + Show on GitHub
    @@ -456,7 +500,7 @@ then - Show on GitHub + Show on GitHub diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive/Member.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive/Member.html index 6320eec3..b1547853 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive/Member.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive/Member.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -173,7 +178,13 @@

    Member

    -

    Undocumented

    +
    +
    + 
    public struct Member
    + +
    +
    +

    Represents a member of multi-member of GZip archive.

    @@ -195,11 +206,19 @@
    -

    Undocumented

    +

    GZip header of a member.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let header: GzipHeader
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -217,11 +236,19 @@
    -

    Undocumented

    +

    Unarchived data from a member.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let data: 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 d7fceea9..96e7a9f1 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 1e702b9f..cda1ca56 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 a2f9ea6b..cd85b347 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 525142f1..7f8759b8 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -340,7 +345,7 @@

    Declaration

    Swift

    - 
    public var entryAttributes: [FileAttributeKey: Any]
    + 
    public let entryAttributes: [FileAttributeKey: Any]
    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 ddfe49a8..f32d9768 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 4e04a96a..7e9ae4d2 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -267,19 +272,57 @@ It may indicate that either the archive is damaged or it might not be compressed
    -

    Undocumented

    +

    Unarchives XZ archive which contains one or more streams.

    +
    +

    Note

    +

    wrongCheck error contains only last processed stream’s data as their associated value +instead of all successfully processed members. +This is a known issue and it will be fixed in future major version +because solution requires backwards-incompatible API changes.

    + +
    +
    +

    Throws

    +

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

    + +

    Declaration

    Swift

    - 
    public class XZArchive: Archive
    + 
    public static func multiUnarchive(archive data: Data) throws -> [Data]
    +
    +

    Parameters

    + + + + + + + +
    + + archive + + +
    +

    XZ archive with one or more streams.

    +
    +
    +
    +
    +

    Return Value

    +

    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 ef4e5ad7..dd814815 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 a2cc508e..b0c53eea 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -371,7 +376,7 @@ Otherwise, it is true if size of data is 0 AND last character of entry’s n

    Declaration

    Swift

    - 
    public var entryAttributes: [FileAttributeKey: Any]
    + 
    public let entryAttributes: [FileAttributeKey: Any]
    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 8e9eb1ca..a0b2171a 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Compression.html similarity index 53% rename from docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html rename to docs/docsets/SWCompression.docset/Contents/Resources/Documents/Compression.html index 5a2f3968..acc1c547 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Compression.html @@ -1,7 +1,7 @@ - Classes Reference + Compression Reference @@ -15,14 +15,14 @@ - +

    SWCompression Docs - (97% documented) + (100% documented)

    @@ -43,14 +43,14 @@

    SWCompression Reference - Classes Reference + Compression Reference

    -
    -
      -
    • -
      - - - - GzipArchive - -
      -
      -
      -
      -
      -
      -

      Provides unarchive and archive functions for GZip archives.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public class GzipArchive: Archive
      - -
      -
      -
      - 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 f206ceb7..9f4116e4 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 1d907d40..8d2eee6b 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 ccf29009..100e27db 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMA2Error.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMA2Error.html index 849a6ba4..c32efd23 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMA2Error.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/LZMA2Error.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 2e00c726..6fcbc26e 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/TarError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/TarError.html index 80efdd22..6acf039e 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/TarError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/TarError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/XZError.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/XZError.html index 3b3d56f0..cc0160a8 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/XZError.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/XZError.html @@ -23,7 +23,7 @@ SWCompression Docs - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 8d093d34..0e3fe623 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 ec690100..cbe4a03d 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Errors.html similarity index 97% rename from docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html rename to docs/docsets/SWCompression.docset/Contents/Resources/Documents/Errors.html index a0c1bb1f..48748c18 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Errors.html @@ -1,7 +1,7 @@ - Enums Reference + Errors Reference @@ -15,14 +15,14 @@ - +

    SWCompression Docs - (97% documented) + (100% documented)

    @@ -43,14 +43,14 @@

    SWCompression Reference - Enums Reference + Errors Reference

    -

    Enums

    -

    The following enums are available globally.

    - +

    Errors

    +
    @@ -184,9 +188,9 @@
  • - - - LZMA2Error + + + BZip2Error
    @@ -194,165 +198,21 @@
    -

    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.

    +

    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 + See more

    Declaration

    Swift

    - 
    public enum LZMA2Error: Error
    + 
    public enum BZip2Error: Error
    - Show on GitHub -
    -
    -
    -
    • - -
    -
    -
      -
    • -
      - - - - GzipError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum GzipError: Error
      - -
      -
      -
      - Show on GitHub -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - ZipError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum ZipError: Error
      - -
      -
      -
      - Show on GitHub -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - LZMAError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum LZMAError: Error
      - -
      -
      -
      - Show on GitHub -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - ZlibError - -
      -
      -
      -
      -
      -
      -

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

      Declaration

      -
      -

      Swift

      - 
      public enum ZlibError: Error
      - -
      -
      -
      - Show on GitHub + Show on GitHub
      @@ -400,9 +260,9 @@ It may indicate that either the data is damaged or it might not be compressed wi
    • - - - BZip2Error + + + GzipError
      @@ -410,21 +270,93 @@ It may indicate that either the data is damaged or it might not be compressed wi
      -

      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.

      +

      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 + See more

      Declaration

      Swift

      - 
      public enum BZip2Error: Error
      + 
      public enum GzipError: Error
      - Show on GitHub + Show on GitHub +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + LZMA2Error + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum LZMA2Error: Error
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + LZMAError + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum LZMAError: Error
      + +
      +
      +
      + Show on GitHub
      @@ -503,6 +435,78 @@ It may indicate that either archive is damaged or it might not be XZ archive at
    +
    +
      +
    • +
      + + + + ZipError + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum ZipError: Error
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + ZlibError + +
      +
      +
      +
      +
      +
      +

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

      Declaration

      +
      +

      Swift

      + 
      public enum ZlibError: Error
      + +
      +
      +
      + 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 2630076f..137e8fb8 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 - (97% documented) + (100% documented)

    @@ -50,7 +50,7 @@

    @@ -172,8 +177,7 @@

    Protocols

    -

    The following protocols are available globally.

    - +
    @@ -212,37 +216,6 @@
    • -
  • - -
    -
    -
    -
    -
    -

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

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public protocol DecompressionAlgorithm
    - -
    -
    -
    - Show on GitHub -
    -
    -
    -
  • @@ -300,7 +273,38 @@
    - Show on GitHub + Show on GitHub +
    + + +
    • +
  • + +
    +
    +
    +
    +
    +

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

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public protocol DecompressionAlgorithm
    + +
    +
    +
    + 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 8513feff..5debefde 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 b7a8edc1..33bca1a3 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 51fa9c4b..a8bb049a 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    @@ -278,6 +283,42 @@
    • +
  • +
    + + + + entryAttributes + +
    +
    +
    +
    +
    +
    +

    Provides a dictionary with various attributes of the entry. +FileAttributeKey values are used as dictionary keys.

    +
    +

    Note

    + Will be renamed to attributes in 4.0. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    var entryAttributes: [FileAttributeKey: Any]
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
  • @@ -303,7 +344,7 @@
    - 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 a1f94025..1c990471 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 64c2f425..a6257042 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 bceb4de7..c6af7cf4 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 235a0059..2a299823 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 80eec57d..815f6229 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 1e256c4d..30919717 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    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 3ded2f85..e4ee3e72 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 - (97% documented) + (100% documented)

    @@ -51,7 +51,7 @@

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html index a10ec1d6..2535f684 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 - (97% documented) + (100% documented)

    @@ -50,7 +50,7 @@

    @@ -338,26 +343,28 @@ For example:

    There is a small program, swcomp, which uses SWCompression for unarchiving several types of archives.

    -

    Why is it so slow?

    +

    Performace

    -

    Version 2.0 came with a great performance improvement. -Just look at the Tests Results. -So if it’s slow the first thing you should do is to make sure you are using version >= 2.0.

    +

    TL;DR Constantly trying to improve performance; +use whole module optimizations, which are enabled by default for Release configurations.

    -

    Is it still slow? -Maybe you are compiling SWCompression not for ‘Release’ but with ‘Debug’ build configuration? -For some reason, when framework is built for ‘Debug’ its performance significantly worse. -You can once again check test results if you want to convince yourself that this is the case.

    +

    Further thoughts, details and notes about performance you can read in a separate document.

    -

    Finally, SWCompression’s code is not as optimized as original C/C++ versions of corresponding algorithms, -so some difference in speed is expected.

    +

    Tests Results document contains results of performance testing of various algorithms.

    +

    Known issues

    -

    To sum up, it is highly recommended to build SWCompression with ‘Release’ configuration and use the latest version (at least 2.0).

    +
      +
    • wrongCRC and wrongCheck errors for XZ and GZip multi-member archives +contain only last member’s data as their associated value instead of all successfully processed members.
      • +
    + +

    Comment: Philosophy for such errors is that by the time these errors are thrown, +decompression was already performed, so we can still provide the result of decompression to the caller. +It is intended to fix this problem, but solution requires backwards-incompatible API changes so it is delayed until 4.0 release.

    Future plans

    • Better Deflate compression.
      • -
    • Support for additional attributes in containers.
    • 7zip containers.
    • BZip2 compression.
    • Something else…
      • diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/search.json b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/search.json index 07c84080..a8ea549a 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. 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/XZArchive.html#/s:ZFC13SWCompression9XZArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaS2__":{"name":"multiUnarchive(archive:)","abstract":"

      Undocumented

      ","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:vC13SWCompression8TarEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

      Provides a dictionary with various attributes of 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 a linked file.

      ","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:vC13SWCompression8ZipEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

      Provides a dictionary with various attributes of the entry.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"

      Returns data associated with this entry.

      ","parent_name":"ZipEntry"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member6headerVS_10GzipHeader":{"name":"header","abstract":"

      Undocumented

      ","parent_name":"Member"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member4dataV10Foundation4Data":{"name":"data","abstract":"

      Undocumented

      ","parent_name":"Member"},"Classes/GzipArchive/Member.html":{"name":"Member","abstract":"

      Undocumented

      ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"

      Unarchives GZip archive.

      ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaVS0_6Member_":{"name":"multiUnarchive(archive:)","abstract":"

      Undocumented

      ","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 +{"Protocols/DecompressionAlgorithm.html#/s:ZFP13SWCompression22DecompressionAlgorithm10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

      Decompress data compressed with particular algorithm.

      ","parent_name":"DecompressionAlgorithm"},"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:vP13SWCompression14ContainerEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

      Provides a dictionary with various attributes of the entry.","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/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/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.

      "},"Protocols/DecompressionAlgorithm.html":{"name":"DecompressionAlgorithm","abstract":"

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

      "},"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/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/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/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/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/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/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/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/BZip2Error.html":{"name":"BZip2Error","abstract":"

      Represents an error, which happened during BZip2 decompression."},"Enums/DeflateError.html":{"name":"DeflateError","abstract":"

      Represents an error, which happened during Deflate compression or decompression."},"Enums/GzipError.html":{"name":"GzipError","abstract":"

      Represents an error, which happened during processing GZip archive."},"Enums/LZMA2Error.html":{"name":"LZMA2Error","abstract":"

      Represents an error, which happened during LZMA2 decompression."},"Enums/LZMAError.html":{"name":"LZMAError","abstract":"

      Represents an error, which happened during LZMA 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."},"Enums/ZipError.html":{"name":"ZipError","abstract":"

      Represents an error, which happened during processing ZIP container."},"Enums/ZlibError.html":{"name":"ZlibError","abstract":"

      Represents an error, which happened during processing Zlib archive."},"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:vC13SWCompression8TarEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

      Provides a dictionary with various attributes of 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 a linked file.

      ","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/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/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:vC13SWCompression8ZipEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

      Provides a dictionary with various attributes of the entry.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"

      Returns data associated with this entry.

      ","parent_name":"ZipEntry"},"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/ZipContainer.html":{"name":"ZipContainer","abstract":"

      Provides open function for ZIP containers.

      "},"Classes/ZipEntry.html":{"name":"ZipEntry","abstract":"

      Represents either a file or directory entry in ZIP container.

      "},"Classes/TarContainer.html":{"name":"TarContainer","abstract":"

      Provides open function for TAR containers.

      "},"Classes/TarEntry.html":{"name":"TarEntry","abstract":"

      Represents either a file or directory entry in TAR container.

      "},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"

      Unarchives XZ archive.

      ","parent_name":"XZArchive"},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaS2__":{"name":"multiUnarchive(archive:)","abstract":"

      Unarchives XZ archive which contains one or more streams.

      ","parent_name":"XZArchive"},"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"},"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"},"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"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member6headerVS_10GzipHeader":{"name":"header","abstract":"

      GZip header of a member.

      ","parent_name":"Member"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member4dataV10Foundation4Data":{"name":"data","abstract":"

      Unarchived data from a member.

      ","parent_name":"Member"},"Classes/GzipArchive/Member.html":{"name":"Member","abstract":"

      Represents a member of multi-member of GZip archive.

      ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"

      Unarchives GZip archive.

      ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaVS0_6Member_":{"name":"multiUnarchive(archive:)","abstract":"

      Unarchives multi-member 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/GzipArchive.html":{"name":"GzipArchive","abstract":"

      Provides unarchive and archive functions for GZip archives.

      "},"Structs/GzipHeader.html":{"name":"GzipHeader","abstract":"

      Represents a GZip archive’s header.

      "},"Classes/ZlibArchive.html":{"name":"ZlibArchive","abstract":"

      Provides unarchive and archive functions for Zlib archives.

      "},"Structs/ZlibHeader.html":{"name":"ZlibHeader","abstract":"

      Represents a Zlib archive’s header.

      "},"Classes/XZArchive.html":{"name":"XZArchive","abstract":"

      Provides unarchive function for XZ archives.

      "},"Classes/LZMA2.html#/s:ZFC13SWCompression5LZMA210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

      Decompresses data using LZMA2 algortihm.

      ","parent_name":"LZMA2"},"Classes/LZMA.html#/s:ZFC13SWCompression4LZMA10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

      Decompresses data using LZMA algortihm.

      ","parent_name":"LZMA"},"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/BZip2.html#/s:ZFC13SWCompression5BZip210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

      Decompresses data using BZip2 algortihm.

      ","parent_name":"BZip2"},"Classes/BZip2.html":{"name":"BZip2","abstract":"

      Provides decompression function for BZip2 algorithm.

      "},"Classes/Deflate.html":{"name":"Deflate","abstract":"

      Provides compression and decompression functions for Deflate algorithm.

      "},"Classes/LZMA.html":{"name":"LZMA","abstract":"

      Provides decompression function for LZMA algorithm.

      "},"Classes/LZMA2.html":{"name":"LZMA2","abstract":"

      Provides decompression function for LZMA2 algorithm.

      "},"Compression.html":{"name":"Compression"},"Archives.html":{"name":"Archives"},"Containers.html":{"name":"Containers"},"Errors.html":{"name":"Errors"},"Protocols.html":{"name":"Protocols"}} \ 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 d9123cd2..3ef057dc 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 3c0dcaab..a22a20ce 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 a10ec1d6..2535f684 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@ SWCompression Docs - (97% documented) + (100% documented)

      @@ -50,7 +50,7 @@

      @@ -338,26 +343,28 @@ For example:

      There is a small program, swcomp, which uses SWCompression for unarchiving several types of archives.

      -

      Why is it so slow?

      +

      Performace

      -

      Version 2.0 came with a great performance improvement. -Just look at the Tests Results. -So if it’s slow the first thing you should do is to make sure you are using version >= 2.0.

      +

      TL;DR Constantly trying to improve performance; +use whole module optimizations, which are enabled by default for Release configurations.

      -

      Is it still slow? -Maybe you are compiling SWCompression not for ‘Release’ but with ‘Debug’ build configuration? -For some reason, when framework is built for ‘Debug’ its performance significantly worse. -You can once again check test results if you want to convince yourself that this is the case.

      +

      Further thoughts, details and notes about performance you can read in a separate document.

      -

      Finally, SWCompression’s code is not as optimized as original C/C++ versions of corresponding algorithms, -so some difference in speed is expected.

      +

      Tests Results document contains results of performance testing of various algorithms.

      +

      Known issues

      -

      To sum up, it is highly recommended to build SWCompression with ‘Release’ configuration and use the latest version (at least 2.0).

      +
        +
      • wrongCRC and wrongCheck errors for XZ and GZip multi-member archives +contain only last member’s data as their associated value instead of all successfully processed members.
        • +
      + +

      Comment: Philosophy for such errors is that by the time these errors are thrown, +decompression was already performed, so we can still provide the result of decompression to the caller. +It is intended to fix this problem, but solution requires backwards-incompatible API changes so it is delayed until 4.0 release.

      Future plans

      • Better Deflate compression.
        • -
      • Support for additional attributes in containers.
      • 7zip containers.
      • BZip2 compression.
      • Something else…
        • diff --git a/docs/search.json b/docs/search.json index 07c84080..a8ea549a 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. 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/XZArchive.html#/s:ZFC13SWCompression9XZArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaS2__":{"name":"multiUnarchive(archive:)","abstract":"

        Undocumented

        ","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:vC13SWCompression8TarEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

        Provides a dictionary with various attributes of 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 a linked file.

        ","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:vC13SWCompression8ZipEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

        Provides a dictionary with various attributes of the entry.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"

        Returns data associated with this entry.

        ","parent_name":"ZipEntry"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member6headerVS_10GzipHeader":{"name":"header","abstract":"

        Undocumented

        ","parent_name":"Member"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member4dataV10Foundation4Data":{"name":"data","abstract":"

        Undocumented

        ","parent_name":"Member"},"Classes/GzipArchive/Member.html":{"name":"Member","abstract":"

        Undocumented

        ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"

        Unarchives GZip archive.

        ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaVS0_6Member_":{"name":"multiUnarchive(archive:)","abstract":"

        Undocumented

        ","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 +{"Protocols/DecompressionAlgorithm.html#/s:ZFP13SWCompression22DecompressionAlgorithm10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

        Decompress data compressed with particular algorithm.

        ","parent_name":"DecompressionAlgorithm"},"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:vP13SWCompression14ContainerEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

        Provides a dictionary with various attributes of the entry.","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/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/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.

        "},"Protocols/DecompressionAlgorithm.html":{"name":"DecompressionAlgorithm","abstract":"

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

        "},"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/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/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/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/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/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/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/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/BZip2Error.html":{"name":"BZip2Error","abstract":"

        Represents an error, which happened during BZip2 decompression."},"Enums/DeflateError.html":{"name":"DeflateError","abstract":"

        Represents an error, which happened during Deflate compression or decompression."},"Enums/GzipError.html":{"name":"GzipError","abstract":"

        Represents an error, which happened during processing GZip archive."},"Enums/LZMA2Error.html":{"name":"LZMA2Error","abstract":"

        Represents an error, which happened during LZMA2 decompression."},"Enums/LZMAError.html":{"name":"LZMAError","abstract":"

        Represents an error, which happened during LZMA 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."},"Enums/ZipError.html":{"name":"ZipError","abstract":"

        Represents an error, which happened during processing ZIP container."},"Enums/ZlibError.html":{"name":"ZlibError","abstract":"

        Represents an error, which happened during processing Zlib archive."},"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:vC13SWCompression8TarEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

        Provides a dictionary with various attributes of 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 a linked file.

        ","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/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/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:vC13SWCompression8ZipEntry15entryAttributesGVs10DictionaryVSC16FileAttributeKeyP__":{"name":"entryAttributes","abstract":"

        Provides a dictionary with various attributes of the entry.","parent_name":"ZipEntry"},"Classes/ZipEntry.html#/s:FC13SWCompression8ZipEntry4dataFzT_V10Foundation4Data":{"name":"data()","abstract":"

        Returns data associated with this entry.

        ","parent_name":"ZipEntry"},"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/ZipContainer.html":{"name":"ZipContainer","abstract":"

        Provides open function for ZIP containers.

        "},"Classes/ZipEntry.html":{"name":"ZipEntry","abstract":"

        Represents either a file or directory entry in ZIP container.

        "},"Classes/TarContainer.html":{"name":"TarContainer","abstract":"

        Provides open function for TAR containers.

        "},"Classes/TarEntry.html":{"name":"TarEntry","abstract":"

        Represents either a file or directory entry in TAR container.

        "},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"

        Unarchives XZ archive.

        ","parent_name":"XZArchive"},"Classes/XZArchive.html#/s:ZFC13SWCompression9XZArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaS2__":{"name":"multiUnarchive(archive:)","abstract":"

        Unarchives XZ archive which contains one or more streams.

        ","parent_name":"XZArchive"},"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"},"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"},"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"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member6headerVS_10GzipHeader":{"name":"header","abstract":"

        GZip header of a member.

        ","parent_name":"Member"},"Classes/GzipArchive/Member.html#/s:vVC13SWCompression11GzipArchive6Member4dataV10Foundation4Data":{"name":"data","abstract":"

        Unarchived data from a member.

        ","parent_name":"Member"},"Classes/GzipArchive/Member.html":{"name":"Member","abstract":"

        Represents a member of multi-member of GZip archive.

        ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive9unarchiveFzT7archiveV10Foundation4Data_S2_":{"name":"unarchive(archive:)","abstract":"

        Unarchives GZip archive.

        ","parent_name":"GzipArchive"},"Classes/GzipArchive.html#/s:ZFC13SWCompression11GzipArchive14multiUnarchiveFzT7archiveV10Foundation4Data_GSaVS0_6Member_":{"name":"multiUnarchive(archive:)","abstract":"

        Unarchives multi-member 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/GzipArchive.html":{"name":"GzipArchive","abstract":"

        Provides unarchive and archive functions for GZip archives.

        "},"Structs/GzipHeader.html":{"name":"GzipHeader","abstract":"

        Represents a GZip archive’s header.

        "},"Classes/ZlibArchive.html":{"name":"ZlibArchive","abstract":"

        Provides unarchive and archive functions for Zlib archives.

        "},"Structs/ZlibHeader.html":{"name":"ZlibHeader","abstract":"

        Represents a Zlib archive’s header.

        "},"Classes/XZArchive.html":{"name":"XZArchive","abstract":"

        Provides unarchive function for XZ archives.

        "},"Classes/LZMA2.html#/s:ZFC13SWCompression5LZMA210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

        Decompresses data using LZMA2 algortihm.

        ","parent_name":"LZMA2"},"Classes/LZMA.html#/s:ZFC13SWCompression4LZMA10decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

        Decompresses data using LZMA algortihm.

        ","parent_name":"LZMA"},"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/BZip2.html#/s:ZFC13SWCompression5BZip210decompressFzT4dataV10Foundation4Data_S2_":{"name":"decompress(data:)","abstract":"

        Decompresses data using BZip2 algortihm.

        ","parent_name":"BZip2"},"Classes/BZip2.html":{"name":"BZip2","abstract":"

        Provides decompression function for BZip2 algorithm.

        "},"Classes/Deflate.html":{"name":"Deflate","abstract":"

        Provides compression and decompression functions for Deflate algorithm.

        "},"Classes/LZMA.html":{"name":"LZMA","abstract":"

        Provides decompression function for LZMA algorithm.

        "},"Classes/LZMA2.html":{"name":"LZMA2","abstract":"

        Provides decompression function for LZMA2 algorithm.

        "},"Compression.html":{"name":"Compression"},"Archives.html":{"name":"Archives"},"Containers.html":{"name":"Containers"},"Errors.html":{"name":"Errors"},"Protocols.html":{"name":"Protocols"}} \ No newline at end of file diff --git a/docs/undocumented.json b/docs/undocumented.json index 11080fec..f43c0df0 100644 --- a/docs/undocumented.json +++ b/docs/undocumented.json @@ -1,40 +1,6 @@ { "warnings": [ - { - "file": "/Users/timofeysolomko/Developer/Compression/SWCompression/Sources/GzipArchive.swift", - "line": 191, - "symbol": "GzipArchive.Member", - "symbol_kind": "source.lang.swift.decl.struct", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/Compression/SWCompression/Sources/GzipArchive.swift", - "line": 192, - "symbol": "GzipArchive.Member.header", - "symbol_kind": "source.lang.swift.decl.var.instance", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/Compression/SWCompression/Sources/GzipArchive.swift", - "line": 193, - "symbol": "GzipArchive.Member.data", - "symbol_kind": "source.lang.swift.decl.var.instance", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/Compression/SWCompression/Sources/GzipArchive.swift", - "line": 220, - "symbol": "GzipArchive.multiUnarchive(archive:)", - "symbol_kind": "source.lang.swift.decl.function.method.static", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/Compression/SWCompression/Sources/XZArchive.swift", - "line": 96, - "symbol": "XZArchive.multiUnarchive(archive:)", - "symbol_kind": "source.lang.swift.decl.function.method.static", - "warning": "undocumented" - } + ], "source_directory": "/Users/timofeysolomko/Developer/Compression/SWCompression" } \ No newline at end of file