GitHub/SWCompression
1
0
Fork 0
mirror of https://github.com/tsolomko/SWCompression.git synced 2026-06-23 14:56:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rebuild jazzy docs

Browse Source
This commit is contained in:
Timofey Solomko
2017-10-28 13:16:58 +03:00
parent 86d1026d68
commit f99ef86611
116 changed files with 10990 additions and 7376 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Classes/BZip2.html
+41 -20
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -276,7 +297,7 @@ It may indicate that either data is damaged or it might not be compressed with B
<p>Decompressed data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2.swift#L23-L27">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2.swift#L23-L27">Show on GitHub</a>
</div>
</section>
</div>
@@ -335,7 +356,7 @@ Use <code><a href="../Classes/BZip2.html#/s:13SWCompression5BZip2C8compress10Fou
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+Compress.swift#L18-L20">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+Compress.swift#L18-L20">Show on GitHub</a>
</div>
</section>
</div>
@@ -396,7 +417,7 @@ Use <code><a href="../Classes/BZip2.html#/s:13SWCompression5BZip2C8compress10Fou
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+Compress.swift#L40-L70">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+Compress.swift#L40-L70">Show on GitHub</a>
</div>
</section>
</div>
@@ -431,7 +452,7 @@ Use <code><a href="../Classes/BZip2.html#/s:13SWCompression5BZip2C8compress10Fou
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L13-L56">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L13-L56">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/BZip2/BlockSize.html
+46 -25
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -245,7 +266,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L15">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L15">Show on GitHub</a>
</div>
</section>
</div>
@@ -279,7 +300,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L17">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L17">Show on GitHub</a>
</div>
</section>
</div>
@@ -313,7 +334,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L19">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L19">Show on GitHub</a>
</div>
</section>
</div>
@@ -347,7 +368,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L21">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L21">Show on GitHub</a>
</div>
</section>
</div>
@@ -381,7 +402,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L23">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L23">Show on GitHub</a>
</div>
</section>
</div>
@@ -415,7 +436,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L25">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L25">Show on GitHub</a>
</div>
</section>
</div>
@@ -449,7 +470,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L27">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L27">Show on GitHub</a>
</div>
</section>
</div>
@@ -483,7 +504,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L29">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L29">Show on GitHub</a>
</div>
</section>
</div>
@@ -517,7 +538,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/BZip2+BlockSize.swift#L31">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/BZip2/BZip2+BlockSize.swift#L31">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/Deflate.html
+39 -18
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -281,7 +302,7 @@ It may indicate that either data is damaged or it might not be compressed with D
<p>Decompressed data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/Deflate.swift#L25-L29">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/Deflate/Deflate.swift#L25-L29">Show on GitHub</a>
</div>
</section>
</div>
@@ -343,7 +364,7 @@ then static Huffman block will be created.</p>
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/Deflate+Compress.swift#L21-L72">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/Deflate/Deflate+Compress.swift#L21-L72">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/GzipArchive.html
+41 -20
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -246,7 +267,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/GzipArchive.swift#L12-L20">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/GZip/GzipArchive.swift#L12-L20">Show on GitHub</a>
</div>
</section>
</div>
@@ -315,7 +336,7 @@ it might not be archived with GZip or compressed with Deflate at all.</p>
<p>Unarchived data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/GzipArchive.swift#L39-L44">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/GZip/GzipArchive.swift#L39-L44">Show on GitHub</a>
</div>
</section>
</div>
@@ -384,7 +405,7 @@ it might not be archived with GZip or compressed with Deflate at all.</p>
<p>Unarchived data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/GzipArchive.swift#L63-L73">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/GZip/GzipArchive.swift#L63-L73">Show on GitHub</a>
</div>
</section>
</div>
@@ -527,7 +548,7 @@ then <code><a href="../Enums/GzipError.html#/s:13SWCompression9GzipErrorO21canno
<p>Resulting archive&rsquo;s data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/GzipArchive.swift#L114-L206">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/GZip/GzipArchive.swift#L114-L206">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/GzipArchive/Member.html
+39 -18
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -245,7 +266,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/GzipArchive.swift#L15">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/GZip/GzipArchive.swift#L15">Show on GitHub</a>
</div>
</section>
</div>
@@ -275,7 +296,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/GzipArchive.swift#L18">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/GZip/GzipArchive.swift#L18">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/LZMA.html
+38 -17
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -276,7 +297,7 @@ It may indicate that either data is damaged or it might not be compressed with L
<p>Decompressed data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/LZMA.swift#L23-L28">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/LZMA/LZMA.swift#L23-L28">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/LZMA2.html
+38 -17
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -276,7 +297,7 @@ It may indicate that either data is damaged or it might not be compressed with L
<p>Decompressed data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/LZMA2.swift#L23-L30">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/LZMA/LZMA2.swift#L23-L30">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/SevenZipContainer.html
+45 -24
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -207,7 +228,7 @@
<h1>SevenZipContainer</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SevenZipContainer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Container.html">Container</a></span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SevenZipContainer</span></code></pre>
</div>
</div>
@@ -223,9 +244,9 @@
<li class="item">
<div>
<code>
<a name="/s:13SWCompression17SevenZipContainerC4openSayAA0D5Entry_pG10Foundation4DataV9container_tKFZ"></a>
<a name="/s:13SWCompression17SevenZipContainerC4openSayAA0bC5EntryVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/open(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression17SevenZipContainerC4openSayAA0D5Entry_pG10Foundation4DataV9container_tKFZ">open(container:)</a>
<a class="token" href="#/s:13SWCompression17SevenZipContainerC4openSayAA0bC5EntryVG10Foundation4DataV9container_tKFZ">open(container:)</a>
</code>
</div>
<div class="height-container">
@@ -233,7 +254,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Processes 7-Zip container and returns an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code> (which are actually <code><a href="../Classes/SevenZipEntry.html">SevenZipEntry</a></code>).</p>
<p>Processes 7-Zip container and returns an array of <code><a href="../Structs/SevenZipEntry.html">SevenZipEntry</a></code>.</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
<p>The order of entries is defined by 7-Zip container and,
@@ -255,7 +276,7 @@ It may indicate that either container is damaged or it might not be 7-Zip contai
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span><span class="p">]</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Structs/SevenZipEntry.html">SevenZipEntry</a></span><span class="p">]</span></code></pre>
</div>
</div>
@@ -280,10 +301,10 @@ It may indicate that either container is damaged or it might not be 7-Zip contai
</div>
<div>
<h4>Return Value</h4>
<p>Array of <code><a href="../Classes/SevenZipEntry.html">SevenZipEntry</a></code> as an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code>.</p>
<p>Array of <code><a href="../Structs/SevenZipEntry.html">SevenZipEntry</a></code> as an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zContainer.swift#L29-L179">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/7-Zip/7zContainer.swift#L29-L179">Show on GitHub</a>
</div>
</section>
</div>
@@ -353,7 +374,7 @@ It may indicate that either container is damaged or it might not be 7-Zip contai
<p>Array of <code><a href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a></code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zContainer.swift#L199-L220">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/7-Zip/7zContainer.swift#L199-L221">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/SevenZipEntry.html
-525
View File
@@ -1,525 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>SevenZipEntry Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/SevenZipEntry" class="dashAnchor"></a>
<a title="SevenZipEntry Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/tsolomko/SWCompression">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">SWCompression Reference</a>
<img class="carat" src="../img/carat.png" />
SevenZipEntry Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Compression.html">Compression</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/BZip2.html">BZip2</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/BZip2/BlockSize.html">– BlockSize</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Deflate.html">Deflate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/LZMA.html">LZMA</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/LZMA2.html">LZMA2</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Archives.html">Archives</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/GzipArchive.html">GzipArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/GzipArchive/Member.html">– Member</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader.html">GzipHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader/FileSystemType.html">– FileSystemType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/XZArchive.html">XZArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZlibArchive.html">ZlibArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader.html">ZlibHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader/CompressionLevel.html">– CompressionLevel</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Containers.html">Containers</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Errors.html">Errors</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/BZip2Error.html">BZip2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DeflateError.html">DeflateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/LZMAError.html">LZMAError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/LZMA2Error.html">LZMA2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/SevenZipError.html">SevenZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/TarError.html">TarError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ZipError.html">ZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/GzipError.html">GzipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/XZError.html">XZError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ZlibError.html">ZlibError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Archive.html">Archive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Container.html">Container</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntry.html">ContainerEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/CompressionAlgorithm.html">CompressionAlgorithm</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content">
<h1>SevenZipEntry</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SevenZipEntry</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span></code></pre>
</div>
</div>
<p>Represents an entry in 7-Zip container.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC4infoAA0bcD4InfoVv"></a>
<a name="//apple_ref/swift/Property/info" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC4infoAA0bcD4InfoVv">info</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Various information about entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">info</span><span class="p">:</span> <span class="kt"><a href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L12">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC4nameSSv"></a>
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC4nameSSv">name</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Entry&rsquo;s name.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L15-L17">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC4sizeSiv"></a>
<a name="//apple_ref/swift/Property/size" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC4sizeSiv">size</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Entry&rsquo;s data size.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L20-L22">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC11isDirectorySbv"></a>
<a name="//apple_ref/swift/Property/isDirectory" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC11isDirectorySbv">isDirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True, if entry is a directory.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isDirectory</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L25-L27">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC6isLinkSbv"></a>
<a name="//apple_ref/swift/Property/isLink" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC6isLinkSbv">isLink</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True, if entry is a symbolic link.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">isLink</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L30">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC8linkPathSSSgv"></a>
<a name="//apple_ref/swift/Property/linkPath" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC8linkPathSSSgv">linkPath</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Path to a linked file for symbolic link entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">linkPath</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L33">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC15entryAttributess10DictionaryVySC16FileAttributeKeyVypGv"></a>
<a name="//apple_ref/swift/Property/entryAttributes" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC15entryAttributess10DictionaryVySC16FileAttributeKeyVypGv">entryAttributes</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Provides a dictionary with various attributes of the entry.
<code>FileAttributeKey</code> values are used as dictionary keys.</p>
<h2 id='possible-attributes' class='heading'>Possible attributes:</h2>
<ul>
<li><code>FileAttributeKey.posixPermissions</code>,</li>
<li><code>FileAttributeKey.size</code>,</li>
<li><code>FileAttributeKey.modificationDate</code>,</li>
<li><code>FileAttributeKey.creationDate</code>,</li>
<li><code>FileAttributeKey.type</code>,</li>
<li><code>FileAttributeKey.appendOnly</code>.</li>
</ul>
<p>Most modern TAR containers are in UStar format.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">entryAttributes</span><span class="p">:</span> <span class="p">[</span><span class="kt">FileAttributeKey</span><span class="p">:</span> <span class="kt">Any</span><span class="p">]</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L50">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC15dataIsAvailableSbv"></a>
<a name="//apple_ref/swift/Property/dataIsAvailable" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC15dataIsAvailableSbv">dataIsAvailable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True, if data for entry is available.
It might not be depending on the content of the container.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">dataIsAvailable</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L56">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression13SevenZipEntryC4data10Foundation4DataVyKF"></a>
<a name="//apple_ref/swift/Method/data()" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression13SevenZipEntryC4data10Foundation4DataVyKF">data()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns data associated with this entry.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Enums/SevenZipError.html#/s:13SWCompression13SevenZipErrorO17dataIsUnavailableA2CmF">SevenZipError.dataIsUnavailable</a></code> if data for entry isn&rsquo;t available.
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">data</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/7zEntry.swift#L139-L145">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2017 Timofey Solomko</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
docs/Classes/TarContainer.html
+73 -22
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -223,9 +244,9 @@
<li class="item">
<div>
<code>
<a name="/s:13SWCompression12TarContainerC4openSayAA0C5Entry_pG10Foundation4DataV9container_tKFZ"></a>
<a name="/s:13SWCompression12TarContainerC4openSayAA0B5EntryVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/open(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression12TarContainerC4openSayAA0C5Entry_pG10Foundation4DataV9container_tKFZ">open(container:)</a>
<a class="token" href="#/s:13SWCompression12TarContainerC4openSayAA0B5EntryVG10Foundation4DataV9container_tKFZ">open(container:)</a>
</code>
</div>
<div class="height-container">
@@ -233,7 +254,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Processes TAR container and returns an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code> (which are actually <code><a href="../Classes/TarEntry.html">TarEntry</a></code>).</p>
<p>Processes TAR container and returns an array of <code><a href="../Structs/TarEntry.html">TarEntry</a></code>.</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
<p>The order of entries is defined by TAR container and,
@@ -253,7 +274,7 @@ but one SHOULD NOT rely on any particular order.</p>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span><span class="p">]</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Structs/TarEntry.html">TarEntry</a></span><span class="p">]</span></code></pre>
</div>
</div>
@@ -278,10 +299,40 @@ but one SHOULD NOT rely on any particular order.</p>
</div>
<div>
<h4>Return Value</h4>
<p>Array of <code><a href="../Classes/TarEntry.html">TarEntry</a></code> as an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code>.</p>
<p>Array of <code><a href="../Structs/TarEntry.html">TarEntry</a></code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarContainer.swift#L25-L88">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/TAR/TarContainer.swift#L25-L37">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression12TarContainerC4infoSayAA0B9EntryInfoVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/info(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression12TarContainerC4infoSayAA0B9EntryInfoVG10Foundation4DataV9container_tKFZ">info(container:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">TarContainer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Container.html">Container</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/TAR/TarContainer.swift#L39-L94">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/TarEntry.html
-853
View File
@@ -1,853 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>TarEntry Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/TarEntry" class="dashAnchor"></a>
<a title="TarEntry Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/tsolomko/SWCompression">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">SWCompression Reference</a>
<img class="carat" src="../img/carat.png" />
TarEntry Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Compression.html">Compression</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/BZip2.html">BZip2</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/BZip2/BlockSize.html">– BlockSize</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Deflate.html">Deflate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/LZMA.html">LZMA</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/LZMA2.html">LZMA2</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Archives.html">Archives</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/GzipArchive.html">GzipArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/GzipArchive/Member.html">– Member</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader.html">GzipHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader/FileSystemType.html">– FileSystemType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/XZArchive.html">XZArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZlibArchive.html">ZlibArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader.html">ZlibHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader/CompressionLevel.html">– CompressionLevel</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Containers.html">Containers</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Errors.html">Errors</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/BZip2Error.html">BZip2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DeflateError.html">DeflateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/LZMAError.html">LZMAError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/LZMA2Error.html">LZMA2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/SevenZipError.html">SevenZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/TarError.html">TarError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ZipError.html">ZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/GzipError.html">GzipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/XZError.html">XZError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ZlibError.html">ZlibError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Archive.html">Archive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Container.html">Container</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntry.html">ContainerEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/CompressionAlgorithm.html">CompressionAlgorithm</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content">
<h1>TarEntry</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">TarEntry</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span></code></pre>
</div>
</div>
<p>Represents either a file or directory entry in TAR container.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO"></a>
<a name="//apple_ref/swift/Enum/EntryType" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO">EntryType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Represents a type of an entry.</p>
<a href="../Classes/TarEntry/EntryType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">EntryType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L12-L35">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC4nameSSv"></a>
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC4nameSSv">name</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Name of the file or directory.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L38-L40">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC11isDirectorySbv"></a>
<a name="//apple_ref/swift/Property/isDirectory" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC11isDirectorySbv">isDirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True, if entry is a directory.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isDirectory</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L43-L45">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC4sizeSiv"></a>
<a name="//apple_ref/swift/Property/size" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC4sizeSiv">size</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Size of the data associated with the entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L48">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC15entryAttributess10DictionaryVySC16FileAttributeKeyVypGv"></a>
<a name="//apple_ref/swift/Property/entryAttributes" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC15entryAttributess10DictionaryVySC16FileAttributeKeyVypGv">entryAttributes</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Provides a dictionary with various attributes of the entry.
<code>FileAttributeKey</code> values are used as dictionary keys.</p>
<h2 id='possible-attributes' class='heading'>Possible attributes:</h2>
<ul>
<li><code>FileAttributeKey.posixPermissions</code>,</li>
<li><code>FileAttributeKey.ownerAccountID</code>,</li>
<li><code>FileAttributeKey.groupOwnerAccountID</code>,</li>
<li><code>FileAttributeKey.size</code>,</li>
<li><code>FileAttributeKey.modificationDate</code>,</li>
<li><code>FileAttributeKey.type</code>,</li>
<li><code>FileAttributeKey.ownerAccountName</code>, if format of container is UStar,</li>
<li><code>FileAttributeKey.groupOwnerAccountName</code>, if format of container is UStar,</li>
<li><code>FileAttributeKey.creationDate</code>, if format of container is PAX.</li>
</ul>
<p>Most modern TAR containers are in UStar format.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">entryAttributes</span><span class="p">:</span> <span class="p">[</span><span class="kt">FileAttributeKey</span><span class="p">:</span> <span class="kt">Any</span><span class="p">]</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L68">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC4modeSiSgv"></a>
<a name="//apple_ref/swift/Property/mode" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC4modeSiSgv">mode</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>File mode.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">mode</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L73">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC7ownerIDSiSgv"></a>
<a name="//apple_ref/swift/Property/ownerID" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC7ownerIDSiSgv">ownerID</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Owner&rsquo;s ID.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">ownerID</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L78">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC7groupIDSiSgv"></a>
<a name="//apple_ref/swift/Property/groupID" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC7groupIDSiSgv">groupID</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Owner&rsquo;s group ID.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">groupID</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L83">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC16modificationTime10Foundation4DateVv"></a>
<a name="//apple_ref/swift/Property/modificationTime" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC16modificationTime10Foundation4DateVv">modificationTime</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The most recent modification time of the original file or directory.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">modificationTime</span><span class="p">:</span> <span class="kt">Date</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L88">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC4typeAC0C4TypeOv"></a>
<a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC4typeAC0C4TypeOv">type</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type of entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/TarEntry/EntryType.html">EntryType</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L93">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC13ownerUserNameSSSgv"></a>
<a name="//apple_ref/swift/Property/ownerUserName" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC13ownerUserNameSSSgv">ownerUserName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Owner&rsquo;s user name.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">ownerUserName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L98">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC14ownerGroupNameSSSgv"></a>
<a name="//apple_ref/swift/Property/ownerGroupName" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC14ownerGroupNameSSSgv">ownerGroupName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Owner&rsquo;s group name.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">ownerGroupName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L103">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC10accessTime10Foundation4DateVSgv"></a>
<a name="//apple_ref/swift/Property/accessTime" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC10accessTime10Foundation4DateVSgv">accessTime</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The most recent access time of the original file or directory (PAX only).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">accessTime</span><span class="p">:</span> <span class="kt">Date</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L114">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC12creationTime10Foundation4DateVSgv"></a>
<a name="//apple_ref/swift/Property/creationTime" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC12creationTime10Foundation4DateVSgv">creationTime</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The creation time of the original file or directory (PAX only).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">creationTime</span><span class="p">:</span> <span class="kt">Date</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L117">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC7charsetSSSgv"></a>
<a name="//apple_ref/swift/Property/charset" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC7charsetSSSgv">charset</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Name of the character set used to encode entry&rsquo;s data (PAX only).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">charset</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L120">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC7commentSSSgv"></a>
<a name="//apple_ref/swift/Property/comment" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC7commentSSSgv">comment</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Comment associated with the entry (PAX only).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">comment</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L123">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC6isLinkSbv"></a>
<a name="//apple_ref/swift/Property/isLink" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC6isLinkSbv">isLink</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True if entry is a symbolic link.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">isLink</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L126">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC8linkPathSSSgv"></a>
<a name="//apple_ref/swift/Property/linkPath" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC8linkPathSSSgv">linkPath</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Path to a linked file for symbolic link entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">linkPath</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L129-L131">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC28unknownExtendedHeaderEntriess10DictionaryVyS2SGv"></a>
<a name="//apple_ref/swift/Property/unknownExtendedHeaderEntries" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC28unknownExtendedHeaderEntriess10DictionaryVyS2SGv">unknownExtendedHeaderEntries</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Other entries from PAX extended headers.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">unknownExtendedHeaderEntries</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">String</span><span class="p">]</span> <span class="o">=</span> <span class="p">[:]</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L136">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC4data10Foundation4DataVyF"></a>
<a name="//apple_ref/swift/Method/data()" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC4data10Foundation4DataVyF">data()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns data associated with this entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">data</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L139-L141">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2017 Timofey Solomko</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
docs/Classes/TarEntry/EntryType.html
-606
View File
@@ -1,606 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>EntryType Enumeration Reference</title>
<link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
<meta charset="utf-8">
<script src="../../js/jquery.min.js" defer></script>
<script src="../../js/jazzy.js" defer></script>
<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Enum/EntryType" class="dashAnchor"></a>
<a title="EntryType Enumeration Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../../index.html">
SWCompression Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/tsolomko/SWCompression">
<img class="header-icon" src="../../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../../index.html">SWCompression Reference</a>
<img class="carat" src="../../img/carat.png" />
EntryType Enumeration Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Compression.html">Compression</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/BZip2.html">BZip2</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/BZip2/BlockSize.html">– BlockSize</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Deflate.html">Deflate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/LZMA.html">LZMA</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/LZMA2.html">LZMA2</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Archives.html">Archives</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/GzipArchive.html">GzipArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/GzipArchive/Member.html">– Member</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/GzipHeader.html">GzipHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/GzipHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/GzipHeader/FileSystemType.html">– FileSystemType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/XZArchive.html">XZArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZlibArchive.html">ZlibArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ZlibHeader.html">ZlibHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ZlibHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ZlibHeader/CompressionLevel.html">– CompressionLevel</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Containers.html">Containers</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/TarEntry/EntryType.html">– EntryType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Errors.html">Errors</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/BZip2Error.html">BZip2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/DeflateError.html">DeflateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/LZMAError.html">LZMAError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/LZMA2Error.html">LZMA2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/SevenZipError.html">SevenZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/TarError.html">TarError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/ZipError.html">ZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/GzipError.html">GzipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/XZError.html">XZError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/ZlibError.html">ZlibError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/Archive.html">Archive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/Container.html">Container</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/ContainerEntry.html">ContainerEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/CompressionAlgorithm.html">CompressionAlgorithm</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content">
<h1>EntryType</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">EntryType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<p>Represents a type of an entry.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO6normalA2EmF"></a>
<a name="//apple_ref/swift/Element/normal" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO6normalA2EmF">normal</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Normal file.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">normal</span> <span class="o">=</span> <span class="s">"0"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L14">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO8hardLinkA2EmF"></a>
<a name="//apple_ref/swift/Element/hardLink" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO8hardLinkA2EmF">hardLink</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Hard linked entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">hardLink</span> <span class="o">=</span> <span class="s">"1"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L16">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO12symbolicLinkA2EmF"></a>
<a name="//apple_ref/swift/Element/symbolicLink" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO12symbolicLinkA2EmF">symbolicLink</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Symbolically linked entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">symbolicLink</span> <span class="o">=</span> <span class="s">"2"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L18">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO16characterSpecialA2EmF"></a>
<a name="//apple_ref/swift/Element/characterSpecial" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO16characterSpecialA2EmF">characterSpecial</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Character special file.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">characterSpecial</span> <span class="o">=</span> <span class="s">"3"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L20">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO12blockSpecialA2EmF"></a>
<a name="//apple_ref/swift/Element/blockSpecial" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO12blockSpecialA2EmF">blockSpecial</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Block special file.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">blockSpecial</span> <span class="o">=</span> <span class="s">"4"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L22">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO9directoryA2EmF"></a>
<a name="//apple_ref/swift/Element/directory" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO9directoryA2EmF">directory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Directory.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">directory</span> <span class="o">=</span> <span class="s">"5"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L24">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO4fifoA2EmF"></a>
<a name="//apple_ref/swift/Element/fifo" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO4fifoA2EmF">fifo</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>FIFO special file.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">fifo</span> <span class="o">=</span> <span class="s">"6"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L26">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO10contiguousA2EmF"></a>
<a name="//apple_ref/swift/Element/contiguous" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO10contiguousA2EmF">contiguous</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Contiguous file.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">contiguous</span> <span class="o">=</span> <span class="s">"7"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L28">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO20globalExtendedHeaderA2EmF"></a>
<a name="//apple_ref/swift/Element/globalExtendedHeader" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO20globalExtendedHeaderA2EmF">globalExtendedHeader</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>PAX global extended header. (Should not be encountered separately).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">globalExtendedHeader</span> <span class="o">=</span> <span class="s">"g"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L30">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO19localExtendedHeaderA2EmF"></a>
<a name="//apple_ref/swift/Element/localExtendedHeader" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO19localExtendedHeaderA2EmF">localExtendedHeader</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>PAX local extended header. (Should not be encountered separately).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">localExtendedHeader</span> <span class="o">=</span> <span class="s">"x"</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L32">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8TarEntryC0C4TypeO23vendorUnknownOrReservedA2EmF"></a>
<a name="//apple_ref/swift/Element/vendorUnknownOrReserved" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8TarEntryC0C4TypeO23vendorUnknownOrReservedA2EmF">vendorUnknownOrReserved</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Either unknown type, vendor specific or reserved value.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">vendorUnknownOrReserved</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/TarEntry.swift#L34">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2017 Timofey Solomko</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
docs/Classes/XZArchive.html
+41 -86
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -233,7 +254,9 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Unarchives XZ archive.</p>
<p>Unarchives XZ archive.
Archives with multiple streams are supported,
but uncompressed data from each stream will be combined into single <code>Data</code> object.</p>
<p>If data passed is not actually XZ archive, <code><a href="../Enums/XZError.html">XZError</a></code> will be thrown.
Particularly, if filters other than LZMA2 are used in archive,
@@ -281,75 +304,7 @@ It may indicate that either the archive is damaged or it might not be compressed
<p>Unarchived data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/XZArchive.swift#L46-L76">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression9XZArchiveC14multiUnarchiveSay10Foundation4DataVGAG7archive_tKFZ"></a>
<a name="//apple_ref/swift/Method/multiUnarchive(archive:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression9XZArchiveC14multiUnarchiveSay10Foundation4DataVGAG7archive_tKFZ">multiUnarchive(archive:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Unarchives XZ archive which contains one or more streams.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<p><code>wrongCheck</code> error contains only last processed stream&rsquo;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.</p>
</div>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<p><code><a href="../Enums/LZMAError.html">LZMAError</a></code>, <code><a href="../Enums/LZMA2Error.html">LZMA2Error</a></code> or <code><a href="../Enums/XZError.html">XZError</a></code> 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.</p>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">multiUnarchive</span><span class="p">(</span><span class="n">archive</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">Data</span><span class="p">]</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>archive</em>
</code>
</td>
<td>
<div>
<p>XZ archive with one or more streams.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>Unarchived data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/XZArchive.swift#L94-L133">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/XZ/XZArchive.swift#L48-L87">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/ZipContainer.html
+73 -22
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -223,9 +244,9 @@
<li class="item">
<div>
<code>
<a name="/s:13SWCompression12ZipContainerC4openSayAA0C5Entry_pG10Foundation4DataV9container_tKFZ"></a>
<a name="/s:13SWCompression12ZipContainerC4openSayAA0B5EntryVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/open(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression12ZipContainerC4openSayAA0C5Entry_pG10Foundation4DataV9container_tKFZ">open(container:)</a>
<a class="token" href="#/s:13SWCompression12ZipContainerC4openSayAA0B5EntryVG10Foundation4DataV9container_tKFZ">open(container:)</a>
</code>
</div>
<div class="height-container">
@@ -233,7 +254,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Processes ZIP container and returns an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code> (which are actually <code><a href="../Classes/ZipEntry.html">ZipEntry</a></code>).</p>
<p>Processes ZIP container and returns an array of <code><a href="../Structs/ZipEntry.html">ZipEntry</a></code>.</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
<p>The order of entries is defined by ZIP container and,
@@ -255,7 +276,7 @@ It may indicate that either container is damaged or it might not be ZIP containe
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span><span class="p">]</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Structs/ZipEntry.html">ZipEntry</a></span><span class="p">]</span></code></pre>
</div>
</div>
@@ -280,10 +301,40 @@ It may indicate that either container is damaged or it might not be ZIP containe
</div>
<div>
<h4>Return Value</h4>
<p>Array of <code><a href="../Classes/ZipEntry.html">ZipEntry</a></code> as an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code>.</p>
<p>Array of <code><a href="../Structs/ZipEntry.html">ZipEntry</a></code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipContainer.swift#L27-L57">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/ZIP/ZipContainer.swift#L27-L37">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression12ZipContainerC4infoSayAA0B9EntryInfoVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/info(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression12ZipContainerC4infoSayAA0B9EntryInfoVG10Foundation4DataV9container_tKFZ">info(container:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ZipContainer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Container.html">Container</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/ZIP/ZipContainer.swift#L114-L151">Show on GitHub</a>
</div>
</section>
</div>
docs/Classes/ZipEntry.html
-554
View File
@@ -1,554 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>ZipEntry Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/ZipEntry" class="dashAnchor"></a>
<a title="ZipEntry Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/tsolomko/SWCompression">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">SWCompression Reference</a>
<img class="carat" src="../img/carat.png" />
ZipEntry Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Compression.html">Compression</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/BZip2.html">BZip2</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/BZip2/BlockSize.html">– BlockSize</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Deflate.html">Deflate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/LZMA.html">LZMA</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/LZMA2.html">LZMA2</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Archives.html">Archives</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/GzipArchive.html">GzipArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/GzipArchive/Member.html">– Member</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader.html">GzipHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/GzipHeader/FileSystemType.html">– FileSystemType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/XZArchive.html">XZArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZlibArchive.html">ZlibArchive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader.html">ZlibHeader</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader/CompressionMethod.html">– CompressionMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZlibHeader/CompressionLevel.html">– CompressionLevel</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Containers.html">Containers</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Errors.html">Errors</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/BZip2Error.html">BZip2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DeflateError.html">DeflateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/LZMAError.html">LZMAError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/LZMA2Error.html">LZMA2Error</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/SevenZipError.html">SevenZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/TarError.html">TarError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ZipError.html">ZipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/GzipError.html">GzipError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/XZError.html">XZError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ZlibError.html">ZlibError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Archive.html">Archive</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Container.html">Container</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntry.html">ContainerEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/CompressionAlgorithm.html">CompressionAlgorithm</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content">
<h1>ZipEntry</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ZipEntry</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span></code></pre>
</div>
</div>
<p>Represents either a file or directory entry in ZIP container.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC4nameSSv"></a>
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC4nameSSv">name</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Name of the file or directory.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L16-L18">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC7commentSSSgv"></a>
<a name="//apple_ref/swift/Property/comment" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC7commentSSSgv">comment</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Comment associated with the entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">comment</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L21-L23">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC10attributess6UInt32Vv"></a>
<a name="//apple_ref/swift/Property/attributes" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC10attributess6UInt32Vv">attributes</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>File or directory attributes related to the file system of the container&rsquo;s creator.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">attributes</span><span class="p">:</span> <span class="kt">UInt32</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L26-L28">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC4sizeSiv"></a>
<a name="//apple_ref/swift/Property/size" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC4sizeSiv">size</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Size of the data associated with the entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L31-L33">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC11isDirectorySbv"></a>
<a name="//apple_ref/swift/Property/isDirectory" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC11isDirectorySbv">isDirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True, if entry is a directory.
For MS-DOS and UNIX-like container creator&rsquo;s OS, the result is based on &lsquo;external file attributes&rsquo;.
Otherwise, it is true if size of data is 0 AND last character of entry&rsquo;s name is &lsquo;/&rsquo;.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isDirectory</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L40-L46">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC6isLinkSbv"></a>
<a name="//apple_ref/swift/Property/isLink" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC6isLinkSbv">isLink</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True, if entry is a symbolic link.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">isLink</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L49">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC8linkPathSSSgv"></a>
<a name="//apple_ref/swift/Property/linkPath" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC8linkPathSSSgv">linkPath</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Path to a linked file for symbolic link entry.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">linkPath</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L52">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC10isTextFileSbv"></a>
<a name="//apple_ref/swift/Property/isTextFile" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC10isTextFileSbv">isTextFile</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>True if entry is likely to be text or ASCII file.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isTextFile</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L59-L61">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC15entryAttributess10DictionaryVySC16FileAttributeKeyVypGv"></a>
<a name="//apple_ref/swift/Property/entryAttributes" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC15entryAttributess10DictionaryVySC16FileAttributeKeyVypGv">entryAttributes</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Provides a dictionary with various attributes of the entry.
<code>FileAttributeKey</code> values are used as dictionary keys.</p>
<h2 id='possible-attributes' class='heading'>Possible attributes:</h2>
<ul>
<li><code>FileAttributeKey.modificationDate</code></li>
<li><code>FileAttributeKey.size</code></li>
<li><code>FileAttributeKey.type</code>, only if origin OS was UNIX- or DOS-like.</li>
<li><code>FileAttributeKey.posixPermissions</code>, only if origin OS was UNIX-like.</li>
<li><code>FileAttributeKey.appendOnly</code>, only if origin OS was DOS-like.</li>
</ul>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">entryAttributes</span><span class="p">:</span> <span class="p">[</span><span class="kt">FileAttributeKey</span><span class="p">:</span> <span class="kt">Any</span><span class="p">]</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L75">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression8ZipEntryC4data10Foundation4DataVyKF"></a>
<a name="//apple_ref/swift/Method/data()" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression8ZipEntryC4data10Foundation4DataVyKF">data()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns data associated with this entry.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Enums/ZipError.html">ZipError</a></code> or any other error associated with compression type,
depending on the type of the problem. An error can indicate that container is damaged.
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">data</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipEntry.swift#L83-L170">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2017 Timofey Solomko</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
docs/Classes/ZlibArchive.html
+39 -18
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -284,7 +305,7 @@ it might not be archived with Zlib or compressed with Deflate at all.</p>
<p>Unarchived data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZlibArchive.swift#L28-L40">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/Zlib/ZlibArchive.swift#L28-L40">Show on GitHub</a>
</div>
</section>
</div>
@@ -346,7 +367,7 @@ It will also be specified in archive&rsquo;s header that the compressor used the
<p>Resulting archive&rsquo;s data.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZlibArchive.swift#L55-L71">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/Zlib/ZlibArchive.swift#L55-L71">Show on GitHub</a>
</div>
</section>
</div>