https://github.com/1024jp/GzipSwift

Swift package that enables gzip/gunzip Data using zlib
https://github.com/1024jp/GzipSwift

carthage cocoapods framework gzip spm swift zlib

Last synced: 19 days ago
JSON representation

Swift package that enables gzip/gunzip Data using zlib

• Host: GitHub
• URL: https://github.com/1024jp/GzipSwift
• Owner: 1024jp
• License: mit
• Created: 2014-12-07T21:00:29.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T04:00:27.000Z (6 months ago)
• Last Synced: 2024-10-25T07:15:10.451Z (about 2 months ago)
• Topics: carthage, cocoapods, framework, gzip, spm, swift, zlib
• Language: Swift
• Homepage:
• Size: 279 KB
• Stars: 538
• Watchers: 11
• Forks: 133
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - GzipSwift - Swift package that enables gzip/gunzip Data using zlib. (OOM-Leaks-Crash / Zip)

README

        

GzipSwift

========================

[![platform](https://img.shields.io/badge/platform-macOS%20|%20iOS%20|%20watchOS%20|%20tvOS%20|%20Linux-blue.svg)]()

[![CI Status](https://github.com/1024jp/GzipSwift/workflows/CI/badge.svg)](https://github.com/1024jp/GzipSwift/actions)

[![SwiftPM-compatible](https://img.shields.io/badge/SwiftPM-✔-4BC51D.svg?style=flat)](https://swift.org/package-manager/)

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

GzipSwift requires no privacy manifests since it does not access to any privacy information.

## Usage

```swift

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

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

```swift

dependencies: [

    .package(name: "Gzip", url: "https://github.com/1024jp/GzipSwift", from: Version(6, 0, 0)),

],

```

#### For Linux

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

    ```bash

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

## License

© 2014-2024 1024jp

GzipSwift is distributed under the terms of the __MIT License__. See [LICENSE](LICENSE) for details.