Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mapbox/gzip-hpp
Gzip header-only C++ library
https://github.com/mapbox/gzip-hpp
Last synced: about 1 month ago
JSON representation
Gzip header-only C++ library
- Host: GitHub
- URL: https://github.com/mapbox/gzip-hpp
- Owner: mapbox
- License: bsd-2-clause
- Created: 2017-08-24T21:24:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-26T14:55:53.000Z (over 1 year ago)
- Last Synced: 2024-08-02T01:25:36.987Z (4 months ago)
- Language: C++
- Size: 216 KB
- Stars: 316
- Watchers: 107
- Forks: 66
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-hpp - Gzip - hpp?style=social)](https://github.com/mapbox/gzip-hpp/stargazers/) | Gzip header-only C++ library. | [](https://opensource.org/licenses/BSD-2-Clause) | (Compression)
README
Gzip C++ lib for gzip compression and decompression. Extracted from [mapnik-vector-tile](https://github.com/mapbox/mapnik-vector-tile) for light-weight modularity.
[](https://travis-ci.com/mapbox/gzip-hpp)
[](https://github.com/mapbox/hpp-skel)
## Usage
```c++
// Include the specific gzip headers your code needs, for example...
#include
#include
#include
#include
#include
// All function calls must pass in a pointer of an
// immutable character sequence (aka a string in C) and its size
std::string data = "hello";
const char * pointer = data.data();
std::size_t size = data.size();
// Check if compressed. Can check both gzip and zlib.
bool c = gzip::is_compressed(pointer, size); // false
// Compress returns a std::string
std::string compressed_data = gzip::compress(pointer, size);
// Decompress returns a std::string and decodes both zlib and gzip
const char * compressed_pointer = compressed_data.data();
std::string decompressed_data = gzip::decompress(compressed_pointer, compressed_data.size());
// Or like so
std::string compressed_data = gzip::compress(tile->data(), tile->data.size());
// Or like so
std::string value = gzip::compress(node::Buffer::Data(obj), node::Buffer::Length(obj));
// Or...etc
```
#### Compress
```c++
// Optionally include compression level
std::size_t size; // No default value, but what happens when not passed??
int level = Z_DEFAULT_COMPRESSION; // Z_DEFAULT_COMPRESSION is the default if no arg is passed
std::string compressed_data = gzip::compress(tile->data(), size, level);
```
#### Decompress
```c++
// No args other than the std:string
std::string data = "hello";
std::string compressed_data = gzip::compress(data);
const char * compressed_pointer = compressed_data.data();
std::string decompressed_data = gzip::decompress(compressed_pointer, compressed_data.size());
```
## Test
```shell
# build test binaries
make
# run tests
make test
```
You can make Release test binaries as well
```shell
BUILDTYPE=Release make
BUILDTYPE=Release make test
```
## Versioning
This library is semantically versioned using the /include/gzip/version.cpp file. This defines a number of macros that can be used to check the current major, minor, or patch versions, as well as the full version string.
Here's how you can check for a particular version to use specific API methods
```c++
#if GZIP_VERSION_MAJOR > 2
// use version 2 api
#else
// use older verion apis
#endif
```
Here's how to check the version string
```c++
std::cout << "version: " << GZIP_VERSION_STRING << "/n";
// => version: 0.2.0
```
And lastly, mathematically checking for a specific version:
```c++
#if GZIP_VERSION_CODE > 20001
// use feature provided in v2.0.1
#endif
```