Gzip Ruby Reference Documentation

CkGzip

Current Version: 11.0.0

Requires Chilkat Bundle License

GZip compression component.

Object Creation

obj = Chilkat::CkGzip.new()

Properties

AbortCurrent

# boolVal is a boolean
boolVal = gzip.get_AbortCurrent();
gzip.put_AbortCurrent(boolVal);

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

Comment

# strVal is a string
# ckStr is a CkString
gzip.get_Comment(ckStr);
strVal = gzip.comment();
gzip.put_Comment(strVal);

Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.

CompressionLevel

# intVal is an integer
intVal = gzip.get_CompressionLevel();
gzip.put_CompressionLevel(intVal);

Introduced in version 9.5.0.50

The compression level to be used when compressing. The default is 6, which is the typical value used for zip utility programs when compressing data. The compression level may range from 0 (no compression) to 9 (the most compression). The benefits of trying to increase compression may not be worth the added expense in compression time. In many cases (which is data dependent), the improvement in compression is minimal while the increase in computation time is significant.

DebugLogFilePath

# strVal is a string
# ckStr is a CkString
gzip.get_DebugLogFilePath(ckStr);
strVal = gzip.debugLogFilePath();
gzip.put_DebugLogFilePath(strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

Filename

# strVal is a string
# ckStr is a CkString
gzip.get_Filename(ckStr);
strVal = gzip.filename();
gzip.put_Filename(strVal);

The filename that is embedded within the .gz during any Compress* method call. When extracting from a .gz using applications such as WinZip, this will be the filename that is created.

LastErrorHtml

# strVal is a string
# ckStr is a CkString
gzip.get_LastErrorHtml(ckStr);
strVal = gzip.lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

# strVal is a string
# ckStr is a CkString
gzip.get_LastErrorText(ckStr);
strVal = gzip.lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# strVal is a string
# ckStr is a CkString
gzip.get_LastErrorXml(ckStr);
strVal = gzip.lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

# boolVal is a boolean
boolVal = gzip.get_LastMethodSuccess();
gzip.put_LastMethodSuccess(boolVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastModStr

# strVal is a string
# ckStr is a CkString
gzip.get_LastModStr(ckStr);
strVal = gzip.lastModStr();
gzip.put_LastModStr(strVal);

The last-modification date/time to be embedded within the .gz when a Compress* method is called. By default, the current system date/time is used. Uses the RFC822 string format.

UseCurrentDate

# boolVal is a boolean
boolVal = gzip.get_UseCurrentDate();
gzip.put_UseCurrentDate(boolVal);

If set to true, the file produced by an Uncompress* method will use the current date/time for the last-modification date instead of the date/time found within the Gzip format.

VerboseLogging

# boolVal is a boolean
boolVal = gzip.get_VerboseLogging();
gzip.put_VerboseLogging(boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

# strVal is a string
# ckStr is a CkString
gzip.get_Version(ckStr);
strVal = gzip.version();

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressBd

# binDat is a CkBinData
status = gzip.CompressBd(binDat);

Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns true for success, false for failure.

More Information and Examples

Gzip Compress In Memory and Base64 Encode

CompressBdAsync ⁽¹⁾

# returns a CkTask
# binDat is a CkBinData
ret_task = gzip.CompressBdAsync(binDat);

Introduced in version 9.5.0.67

Creates an asynchronous task to call the CompressBd method with the arguments provided.

Returns nil on failure

CompressFile

# inFilename is a string
# destPath is a string
status = gzip.CompressFile(inFilename, destPath);

Compresses a file to create a GZip compressed file (.gz).

Returns true for success, false for failure.

More Information and Examples

CompressFileAsync ⁽¹⁾

# returns a CkTask
# inFilename is a string
# destPath is a string
ret_task = gzip.CompressFileAsync(inFilename, destPath);

Creates an asynchronous task to call the CompressFile method with the arguments provided.

Returns nil on failure

CompressFile2

# inFilename is a string
# embeddedFilename is a string
# destPath is a string
status = gzip.CompressFile2(inFilename, embeddedFilename, destPath);

Compresses a file to create a GZip compressed file (.gz). inFilename is the actual filename on disk. embeddedFilename is the filename to be embedded in the .gz such that when it is un-gzipped, this is the name of the file that will be created.

Returns true for success, false for failure.

More Information and Examples

CompressFile2Async ⁽¹⁾

# returns a CkTask
# inFilename is a string
# embeddedFilename is a string
# destPath is a string
ret_task = gzip.CompressFile2Async(inFilename, embeddedFilename, destPath);

Creates an asynchronous task to call the CompressFile2 method with the arguments provided.

Returns nil on failure

CompressFileBd

# filePath is a string
# bd is a CkBinData
status = gzip.CompressFileBd(filePath, bd);

Introduced in version 11.0.0

Gzip compresses a file into an in-memory .gz file stored in bd, with a maximum compressed size of 4GB.

Returns true for success, false for failure.

CompressFileBdAsync ⁽¹⁾

# returns a CkTask
# filePath is a string
# bd is a CkBinData
ret_task = gzip.CompressFileBdAsync(filePath, bd);

Introduced in version 11.0.0

Creates an asynchronous task to call the CompressFileBd method with the arguments provided.

Returns nil on failure

CompressFileToMem Deprecated

# inFilename is a string
# outData is a CkByteData (output)
status = gzip.CompressFileToMem(inFilename, outData);

Gzip compresses a file into an in-memory .gz image with a maximum size limit of 4GB.

Returns true for success, false for failure.

CompressFileToMemAsync Deprecated ⁽¹⁾

# returns a CkTask
# inFilename is a string
ret_task = gzip.CompressFileToMemAsync(inFilename);

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.

Returns nil on failure

CompressMemory Deprecated

# inData is a CkByteData
# outData is a CkByteData (output)
status = gzip.CompressMemory(inData, outData);

Compresses in-memory data to an in-memory image of a .gz file.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns true for success, false for failure.

CompressMemoryAsync Deprecated ⁽¹⁾

# returns a CkTask
# inData is a CkByteData
ret_task = gzip.CompressMemoryAsync(inData);

Creates an asynchronous task to call the CompressMemory method with the arguments provided.

Returns nil on failure

CompressMemToFile Deprecated

# inData is a CkByteData
# destPath is a string
status = gzip.CompressMemToFile(inData, destPath);

Gzip compresses and creates a .gz file from in-memory data.

Returns true for success, false for failure.

CompressMemToFileAsync Deprecated ⁽¹⁾

# returns a CkTask
# inData is a CkByteData
# destPath is a string
ret_task = gzip.CompressMemToFileAsync(inData, destPath);

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.

Returns nil on failure

CompressSb

# sb is a CkStringBuilder
# charset is a string
# bd is a CkBinData
status = gzip.CompressSb(sb, charset, bd);

Introduced in version 11.0.0

Gzip compresses the byte representation of the string using the specified charset from charset (e.g., utf-8, iso-8859-1, or shift_JIS) and writes the compressed output to charset.

Returns true for success, false for failure.

CompressSbAsync ⁽¹⁾

# returns a CkTask
# sb is a CkStringBuilder
# charset is a string
# bd is a CkBinData
ret_task = gzip.CompressSbAsync(sb, charset, bd);

Introduced in version 11.0.0

Creates an asynchronous task to call the CompressSb method with the arguments provided.

Returns nil on failure

CompressString Deprecated

# inStr is a string
# destCharset is a string
# outBytes is a CkByteData (output)
status = gzip.CompressString(inStr, destCharset, outData);

Gzip compresses a string and writes the output to a byte array. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns true for success, false for failure.

More Information and Examples

Full List of Charset Names

CompressStringAsync Deprecated ⁽¹⁾

# returns a CkTask
# inStr is a string
# destCharset is a string
ret_task = gzip.CompressStringAsync(inStr, destCharset);

Creates an asynchronous task to call the CompressString method with the arguments provided.

Returns nil on failure

CompressStringENC

# inStr is a string
# charset is a string
# encoding is a string
# outStr is a CkString (output)
status = gzip.CompressStringENC(inStr, charset, encoding, outStr);
retStr = gzip.compressStringENC(inStr, charset, encoding);

The same as CompressString, except the binary output is returned in encoded string form according to the encoding. The encoding can be any of the following: "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns true for success, false for failure.

CompressStringToFile

# inStr is a string
# destCharset is a string
# destPath is a string
status = gzip.CompressStringToFile(inStr, destCharset, destPath);

Gzip compresses a string and writes the output to a .gz compressed file. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns true for success, false for failure.

More Information and Examples

Full List of Charset Names

CompressStringToFileAsync ⁽¹⁾

# returns a CkTask
# inStr is a string
# destCharset is a string
# destPath is a string
ret_task = gzip.CompressStringToFileAsync(inStr, destCharset, destPath);

Creates an asynchronous task to call the CompressStringToFile method with the arguments provided.

Returns nil on failure

Decode Deprecated

# encodedStr is a string
# encoding is a string
# outBytes is a CkByteData (output)
status = gzip.Decode(encodedStr, encoding, outData);

Decodes an encoded string and returns the original data. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns true for success, false for failure.

DeflateStringENC

# inString is a string
# charsetName is a string
# outputEncoding is a string
# outStr is a CkString (output)
status = gzip.DeflateStringENC(inString, charsetName, outputEncoding, outStr);
retStr = gzip.deflateStringENC(inString, charsetName, outputEncoding);

Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".

Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output.

Returns true for success, false for failure.

More Information and Examples

Full List of Charset Names

Encode Deprecated

# byteData is a CkByteData
# encoding is a string
# outStr is a CkString (output)
status = gzip.Encode(byteData, encoding, outStr);
retStr = gzip.encode(byteData, encoding);

Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns true for success, false for failure.

ExamineFile

# inGzFilename is a string
retBool = gzip.ExamineFile(inGzFilename);

Determines if the inGzFilename is a Gzip formatted file. Returns true if it is a Gzip formatted file, otherwise returns false.

ExamineMemory Deprecated

# inGzData is a CkByteData
retBool = gzip.ExamineMemory(inGzData);

Determines if the in-memory bytes (inGzData) contain a Gzip formatted file. Returns true if it is Gzip format, otherwise returns false.

InflateStringENC

# inString is a string
# convertFromCharset is a string
# inputEncoding is a string
# outStr is a CkString (output)
status = gzip.InflateStringENC(inString, convertFromCharset, inputEncoding, outStr);
retStr = gzip.inflateStringENC(inString, convertFromCharset, inputEncoding);

This the reverse of DeflateStringENC.

The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string.

Returns true for success, false for failure.

IsGzip

# bd is a CkBinData
retBool = gzip.IsGzip(bd);

Introduced in version 11.0.0

Checks if the data in bd is in Gzip format. Returns true if it is, otherwise returns false.

LoadTaskCaller

# task is a CkTask
status = gzip.LoadTaskCaller(task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

ReadFile Deprecated

# path is a string
# outBytes is a CkByteData (output)
status = gzip.ReadFile(path, outData);

Reads a binary file into memory and returns the byte array. Note: This method does not parse a Gzip, it is only a convenience method for reading a binary file into memory.

Returns true for success, false for failure.

SetDt

# dt is a CkDateTime
status = gzip.SetDt(dt);

Sets the last-modification date/time to be embedded within the .gz when a Compress* method is called. If not explicitly set, the current system date/time is used.

Returns true for success, false for failure.

SetExtraData

# encodedData is a string
# encoding is a string
status = gzip.SetExtraData(encodedData, encoding);

Introduced in version 11.0.0

Sets the optional extra data that can be included within a .gz when a Compress* method is called. The extra binary data is passed in encoded form, where the encoding can be base64, hex, or ascii if simple text.

Returns true for success, false for failure.

UncompressBd

# binDat is a CkBinData
status = gzip.UncompressBd(binDat);

Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns true for success, false for failure.

UncompressBdAsync ⁽¹⁾

# returns a CkTask
# binDat is a CkBinData
ret_task = gzip.UncompressBdAsync(binDat);

Introduced in version 9.5.0.67

Creates an asynchronous task to call the UncompressBd method with the arguments provided.

Returns nil on failure

UncompressBdToFile

# bd is a CkBinData
# filePath is a string
status = gzip.UncompressBdToFile(bd, filePath);

Introduced in version 11.0.0

Un-Gzips from a GZip stored in bd to a file.

Returns true for success, false for failure.

UncompressBdToFileAsync ⁽¹⁾

# returns a CkTask
# bd is a CkBinData
# filePath is a string
ret_task = gzip.UncompressBdToFileAsync(bd, filePath);

Introduced in version 11.0.0

Creates an asynchronous task to call the UncompressBdToFile method with the arguments provided.

Returns nil on failure

UncompressFile

# srcPath is a string
# destPath is a string
status = gzip.UncompressFile(srcPath, destPath);

Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz.

Returns true for success, false for failure.

More Information and Examples

GZip Decompress File

UncompressFileAsync ⁽¹⁾

# returns a CkTask
# srcPath is a string
# destPath is a string
ret_task = gzip.UncompressFileAsync(srcPath, destPath);

Creates an asynchronous task to call the UncompressFile method with the arguments provided.

Returns nil on failure

UncompressFileToMem Deprecated

# inFilename is a string
# outData is a CkByteData (output)
status = gzip.UncompressFileToMem(inFilename, outData);

Un-Gzips a .gz file directly to memory.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns true for success, false for failure.

UncompressFileToMemAsync Deprecated ⁽¹⁾

# returns a CkTask
# inFilename is a string
ret_task = gzip.UncompressFileToMemAsync(inFilename);

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.

Returns nil on failure

UncompressFileToString

# gzFilename is a string
# charset is a string
# outStr is a CkString (output)
status = gzip.UncompressFileToString(gzFilename, charset, outStr);
retStr = gzip.uncompressFileToString(gzFilename, charset);

Uncompresses a .gz file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc.

Returns true for success, false for failure.

More Information and Examples

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

# returns a CkTask
# gzFilename is a string
# charset is a string
ret_task = gzip.UncompressFileToStringAsync(gzFilename, charset);

Creates an asynchronous task to call the UncompressFileToString method with the arguments provided.

Returns nil on failure

UncompressMemory Deprecated

# inData is a CkByteData
# outData is a CkByteData (output)
status = gzip.UncompressMemory(inData, outData);

Un-Gzips from an in-memory image of a .gz file directly into memory.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns true for success, false for failure.

UncompressMemoryAsync Deprecated ⁽¹⁾

# returns a CkTask
# inData is a CkByteData
ret_task = gzip.UncompressMemoryAsync(inData);

Creates an asynchronous task to call the UncompressMemory method with the arguments provided.

Returns nil on failure

UncompressMemToFile Deprecated

# inData is a CkByteData
# destPath is a string
status = gzip.UncompressMemToFile(inData, destPath);

Un-Gzips from an in-memory image of a .gz file to a file.

Returns true for success, false for failure.

UncompressMemToFileAsync Deprecated ⁽¹⁾

# returns a CkTask
# inData is a CkByteData
# destPath is a string
ret_task = gzip.UncompressMemToFileAsync(inData, destPath);

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.

Returns nil on failure

UncompressString Deprecated

# inData is a CkByteData
# inCharset is a string
# outStr is a CkString (output)
status = gzip.UncompressString(inData, inCharset, outStr);
retStr = gzip.uncompressString(inData, inCharset);

The reverse of CompressString.

The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string.

Returns true for success, false for failure.

More Information and Examples

Full List of Charset Names

UncompressStringAsync Deprecated ⁽¹⁾

# returns a CkTask
# inData is a CkByteData
# inCharset is a string
ret_task = gzip.UncompressStringAsync(inData, inCharset);

Creates an asynchronous task to call the UncompressString method with the arguments provided.

Returns nil on failure

UncompressStringENC

# inStr is a string
# charset is a string
# encoding is a string
# outStr is a CkString (output)
status = gzip.UncompressStringENC(inStr, charset, encoding, outStr);
retStr = gzip.uncompressStringENC(inStr, charset, encoding);

The same as UncompressString, except the compressed data is provided in encoded string form based on the value of encoding. The encoding can be "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns true for success, false for failure.

UnTarGz

# tgzFilename is a string
# destDir is a string
# bNoAbsolute is a boolean
status = gzip.UnTarGz(tgzFilename, destDir, bNoAbsolute);

Unpacks a .tar.gz file. The ungzip and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. bNoAbsolute may be true or false. A value of true protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32)

Returns true for success, false for failure.

UnTarGzAsync ⁽¹⁾

# returns a CkTask
# tgzFilename is a string
# destDir is a string
# bNoAbsolute is a boolean
ret_task = gzip.UnTarGzAsync(tgzFilename, destDir, bNoAbsolute);

Creates an asynchronous task to call the UnTarGz method with the arguments provided.

Returns nil on failure

WriteFile Deprecated

# path is a string
# binaryData is a CkByteData
status = gzip.WriteFile(path, binaryData);

A convenience method for writing a binary byte array to a file.

Returns true for success, false for failure.

XfdlToXml

# xfldData is a string
# outStr is a CkString (output)
status = gzip.XfdlToXml(xfldData, outStr);
retStr = gzip.xfdlToXml(xfldData);

Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string.

Returns true for success, false for failure.

Deprecated

GetDt

# returns a CkDateTime
ret_ckDateTime = gzip.GetDt();

This method is deprecated.

Applications should instead access the LastModStr property.

Gets the last-modification date/time to be embedded within the .gz.

Returns nil on failure