Objective-C

Add Custom Extra Data to a Gzip File

This example demonstrates how to use the SetExtraData method to include custom binary data in the Gzip header using a hex-encoded string.

The hex string represents the raw bytes to embed in the Gzip metadata. When a compression method is called, this data is included in the Gzip header.

The example also shows how to retrieve the metadata using GetGzipInfo to verify that the extra data was successfully embedded. The retrieved value is returned as a Base64-encoded string.

Objective-C

#import <CkoGzip.h>
#import <CkoJsonObject.h>
#import <NSString.h>

BOOL success = NO;

//  This example demonstrates how to include custom extra data
//  in the Gzip header when compressing.

//  The extra data is provided as a hex-encoded string.

CkoGzip *gzip = [[CkoGzip alloc] init];
CkoJsonObject *json = [[CkoJsonObject alloc] init];

//  Set extra data using a hex string.
//  This example represents 4 bytes: 00 01 02 03
success = [gzip SetExtraData: @"00010203" encoding: @"hex"];
if (success == NO) {
    NSLog(@"%@",gzip.LastErrorText);
    return;
}

//  Compress a file so the extra data is embedded in the Gzip header:
NSString *inputFile = @"example.txt";
NSString *outputFile = @"example.txt.gz";

success = [gzip CompressFile: inputFile destPath: outputFile];
if (success == NO) {
    NSLog(@"%@",gzip.LastErrorText);
    return;
}

NSLog(@"%@",@"Gzip file created with extra data.");

//  (Optional) Retrieve the metadata to verify:
success = [gzip GetGzipInfo: outputFile json: json];
if (success == NO) {
    NSLog(@"%@",gzip.LastErrorText);
    return;
}

NSLog(@"%@",@"Metadata JSON:");
NSLog(@"%@",[json Emit]);