{"id":23168843,"url":"https://github.com/chris-huxtable/cbhcompresskit","last_synced_at":"2025-04-04T22:44:59.442Z","repository":{"id":56904207,"uuid":"174635693","full_name":"chris-huxtable/CBHCompressKit","owner":"chris-huxtable","description":"An easy-to-use interface for compression and a `NSData` category.","archived":false,"fork":false,"pushed_at":"2019-12-05T08:05:08.000Z","size":35,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T07:23:06.377Z","etag":null,"topics":["compression","lz4","lzfse","lzma","objective-c","objective-c-library","zlib"],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chris-huxtable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-09T01:50:39.000Z","updated_at":"2019-12-05T08:05:11.000Z","dependencies_parsed_at":"2022-08-20T18:50:40.561Z","dependency_job_id":null,"html_url":"https://github.com/chris-huxtable/CBHCompressKit","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-huxtable%2FCBHCompressKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-huxtable%2FCBHCompressKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-huxtable%2FCBHCompressKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-huxtable%2FCBHCompressKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chris-huxtable","download_url":"https://codeload.github.com/chris-huxtable/CBHCompressKit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247261581,"owners_count":20910107,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compression","lz4","lzfse","lzma","objective-c","objective-c-library","zlib"],"created_at":"2024-12-18T03:13:51.377Z","updated_at":"2025-04-04T22:44:59.415Z","avatar_url":"https://github.com/chris-huxtable.png","language":"Objective-C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CBHCompressKit\n\n[![release](https://img.shields.io/github/release/chris-huxtable/CBHCompressKit.svg)](https://github.com/chris-huxtable/CBHCompressKit/releases)\n[![pod](https://img.shields.io/cocoapods/v/CBHCompressKit.svg)](https://cocoapods.org/pods/CBHCompressKit)\n[![licence](https://img.shields.io/badge/licence-ISC-lightgrey.svg?cacheSeconds=2592000)](https://github.com/chris-huxtable/CBHCompressKit/blob/master/LICENSE)\n[![coverage](https://img.shields.io/badge/coverage-97%25-brightgreen.svg?cacheSeconds=2592000)](https://github.com/chris-huxtable/CBHCompressKit)\n\nCBHCompressKit provides `CBHCompressor` and `CBHDecompressor` which provide an easy-to-use means of compressing `NSData`.  They support one-call  and stream compression. Additionally CBHCompressKit provides a `NSData` category to make one-call compression even easier.\n\n\n## Supported Algorithms:\n\n-  LZ4: A high-speed compression algorithm.\n-  LZMA: A high compression ratio algorithm.\n-  ZLib: A balanced, cross platform compression algorithm/format.\n-  LZFSE: A balanced,  Apple only compression algorithm.\n\n\n## Use\n\nMost use cases will only need to use the `NSData`  categories.\n\n#### Examples:\n\nCompress `NSData` with LZ4:\n```objective-c\nNSData *data = /* some data */\nNSData *compressed = [data compressUsingLZ4];\n```\n\nDecompress `NSData` with LZ4:\n```objective-c\nNSData *compressed = /* some compressed data */\nNSData *data = [compressed decompressUsingLZ4];\n```\n\nCompress `NSData` with LZMA:\n```objective-c\nNSData *data = /* some data */\nNSData *compressed = [data compressUsingLZMA];\n```\n\nDecompress `NSData` with LZMA:\n```objective-c\nNSData *compressed = /* some compressed data */\nNSData *data = [compressed decompressUsingLZMA];\n```\n\nCompress `NSData` with ZLib:\n```objective-c\nNSData *data = /* some data */\nNSData *compressed = [data compressUsingZLib];\n```\n\nDecompress `NSData` with ZLib:\n```objective-c\nNSData *compressed = /* some compressed data */\nNSData *data = [compressed decompressUsingZLib];\n```\n\nCompress `NSData` with LZFSE:\n```objective-c\nNSData *data = /* some data */\nNSData *compressed = [data compressUsingLZFSE];\n```\n\nDecompress `NSData` with LZFSE:\n```objective-c\nNSData *compressed = /* some compressed data */\nNSData *data = [compressed decompressUsingLZFSE];\n```\n\nMore complicated examples such as with a stream.\n\n#### Examples:\n\nCompress a stream:\n```objective-c\nid io = /* an object that returns data in chunks */\n\nCBHCompressAlgorithm algorithm = CBHCompressAlgorithm_LZMA;\nNSData *compressed = [CBHCompressor compressUsingAlgorithm:algorithm inBlock:^(CBHCompressor *compressor) {\n\twhile ( [io hasMoreData] )\n\t{\n\t\t[compressor appendData:[io data]];\n\t}\n}];\n```\n\nDecompress a stream:\n```objective-c\nid io = /* an object that returns data in chunks */\n\nCBHCompressAlgorithm algorithm = CBHCompressAlgorithm_LZMA;\nNSData *decompressed = [CBHDecompressor decompressUsingAlgorithm:algorithm inBlock:^(CBHDecompressor *decompressor) {\n\twhile ( [io hasMoreData] )\n\t{\n\t\t[decompressor appendData:[io data]];\n\t}\n}];\n```\n\n\n## Licence\nCBHCompressKit is available under the [ISC license](https://github.com/chris-huxtable/CBHCompressKit/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-huxtable%2Fcbhcompresskit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchris-huxtable%2Fcbhcompresskit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-huxtable%2Fcbhcompresskit/lists"}