eneko / GzipSwift

Swift framework that enables gzip/gunzip Data using zlib

GzipSwift

GzipSwift is a framework with an extension of Data written in Swift. It enables compress/decompress gzip using zlib.

• Requirements: OS X 10.9 / iOS 12 / watchOS 2 / tvOS 12 or later
• Swift version: Swift 5.6

Usage

import Gzip

// gzip
let compressedData: Data = try! data.gzipped()
let optimizedData: Data = try! data.gzipped(level: .bestCompression)

// gunzip
let decompressedData: Data
if data.isGzipped {
    decompressedData = try! data.gunzipped()
} else {
    decompressedData = data
}

Installation

Swift Package Manager

GzipSwift is SwiftPM-compatible. To install, add this package to your Package.swift or your Xcode project.

For Linux

1. Install zlib if you haven't installed yet:

   $ apt-get install zlib-dev

2. Add this package to your package.swift.

3. If Swift build failed with a linker error:

   • check if libz.so is in your /usr/local/lib
     • if no, reinstall zlib as step (1)
     • if yes, link the library manually by passing '-Xlinker -L/usr/local/lib' with swift build

Carthage

GzipSwift is Carthage-compatible. To install, add the following line to your Cartfile:

github "1024jp/GzipSwift"

CocoaPods

GzipSwift is available through CocoaPods. To install, add the following line to your Podfile:

pod 'GzipSwift'

Manual Installation

1. Open Gzip.xcodeproj on Xcode and build Gzip framework for your target platform.
2. Append the built Gzip.framework to your project.
3. Go to General pane of the application target in your project. Add Gzip.framework to the Embedded Binaries section.

License

© 2014-2022 1024jp

GzipSwift is distributed under the terms of the MIT License. See LICENSE for details.