# SwiftBrotli

**Repository Path**: comzxb/SwiftBrotli

## Basic Information

- **Project Name**: SwiftBrotli
- **Description**: SwiftBrotliSwiftBrotliSwiftBrotli
- **Primary Language**: Swift
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-17
- **Last Updated**: 2023-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SwiftBrotli

![Swift 5.1](https://img.shields.io/badge/Swift-5.1-blue.svg)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

A lightweight Swift wrapper for Google's [brotli](https://github.com/google/brotli)

### What is Brotli?
Brotli is a generic-purpose lossless compression algorithm that compresses data using a combination of a modern variant of the LZ77 algorithm, Huffman coding and 2nd order context modeling, with a compression ratio comparable to the best currently available general-purpose compression methods. It is similar in speed with deflate but offers more dense compression.

The specification of the Brotli Compressed Data Format is defined in [RFC 7932](https://tools.ietf.org/html/rfc7932).

### Why use Brotli?
Brotli uses a dictionary of common keywords and phrases on both client and server side and thus gives a better compression ratio for text data.

#### Articles and comparisons:
- https://medium.com/oyotech/how-brotli-compression-gave-us-37-latency-improvement-14d41e50fee4
- https://expeditedsecurity.com/blog/nginx-brotli/
- https://wp-rocket.me/blog/brotli-vs-gzip-compression/

### Usage

#### Compress data
```swift
let brotli = Brotli()
brotli.compress(data)
```

#### Decompress data
```swift
let brotli = Brotli()
brotli.decompress(data)
```

#### Encode JSON object
```swift
let encoder = BrotliJSONEncoder()
encoder.encode(object)
```

#### Decode JSON object
```swift
let decoder = BrotliJSONDecoder()
let result: Result<Object, Error> = decoder.decode(data)
```