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

Rephrased docs for DeflateError.UnknownBlockType.

Browse Source
This commit is contained in:
Timofey Solomko
2016-12-15 23:25:08 +03:00
parent b342918566
commit 443dcbe076
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/Deflate.swift
+4 -2
View File
@@ -9,6 +9,7 @@
import Foundation
// TODO: Rename HuffmanTableError to HuffmanTreeError.
// TODO: Expand HuffmanTreeError to more specific errors.
/**
Error happened during deflate decompression.
It may indicate that either the data is damaged or it might not be compressed with DEFLATE at all.
@@ -16,14 +17,15 @@ import Foundation
- `WrongBlockLengths`: `length` and `nlength` bytes of uncompressed block were not compatible.
- `HuffmanTableError`: either error occured while parsing bytes related to Huffman coding or
problem is happened during various calculations of Huffman coding.
- `UnknownBlockType`: block type was 3, which is unknown block type.
- `UnknownBlockType`: unsupported block type (not 0, 1 or 2).
*/
public enum DeflateError: Error {
/// Uncompressed block' `length` and `nlength` bytes were not compatible.
case WrongBlockLengths
/// Either error occured while parsing bytes related to Huffman coding or problem is happened during various calculations of Huffman coding.
case HuffmanTableError
/// Block type was 3, which is unknown block type.
// TODO: Rename to WrongBlockType.
/// Unknown block type (not from 0 to 2).
case UnknownBlockType
}