UnixCompress Ruby Reference Documentation

CkUnixCompress

Current Version: 10.1.2

Requires Chilkat Bundle License

UNIX (.Z) compression component.

Object Creation

obj = Chilkat::CkUnixCompress.new()

Properties

AbortCurrent

# boolVal is a boolean
boolVal = unixCompress.get_AbortCurrent();
unixCompress.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.)

DebugLogFilePath

# strVal is a string
# ckStr is a CkString
unixCompress.get_DebugLogFilePath(ckStr);
strVal = unixCompress.debugLogFilePath();
unixCompress.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.

LastErrorHtml

# strVal is a string
# ckStr is a CkString
unixCompress.get_LastErrorHtml(ckStr);
strVal = unixCompress.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
unixCompress.get_LastErrorText(ckStr);
strVal = unixCompress.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
unixCompress.get_LastErrorXml(ckStr);
strVal = unixCompress.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 = unixCompress.get_LastMethodSuccess();
unixCompress.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.

Utf8

# boolVal is a boolean
boolVal = unixCompress.get_Utf8();
unixCompress.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

VerboseLogging

# boolVal is a boolean
boolVal = unixCompress.get_VerboseLogging();
unixCompress.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
unixCompress.get_Version(ckStr);
strVal = unixCompress.version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressFile

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

Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.

Returns true for success, false for failure.

CompressFileAsync ⁽¹⁾

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

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

Returns nil on failure

CompressFileToMem

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

Unix compresses a file to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

CompressFileToMemAsync ⁽¹⁾

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

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

Returns nil on failure

CompressMemory

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

Compresses in-memory data to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

CompressMemToFile

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

Unix compresses and creates a .Z file from in-memory data. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

CompressString

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

Compresses a string to an in-memory image of a .Z file. Prior to compression, the string is converted to the character encoding specified by charset. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns true for success, false for failure.

More Information and Examples

List of Valid Charsets

CompressStringToFile

# inStr is a string
# charset is a string
# destPath is a string
status = unixCompress.CompressStringToFile(inStr, charset, destPath);

Unix compresses and creates a .Z file from string data. The charset specifies the character encoding used for the byte representation of the characters when compressed. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns true for success, false for failure.

More Information and Examples

List of Valid Charsets

LoadTaskCaller

# task is a CkTask
status = unixCompress.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.

UncompressFile

# inFilename is a string
# destPath is a string
status = unixCompress.UncompressFile(inFilename, destPath);

Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

# returns a CkTask
# inFilename is a string
# destPath is a string
ret_task = unixCompress.UncompressFileAsync(inFilename, destPath);

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

Returns nil on failure

UncompressFileToMem

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

Uncompresses a .Z file directly to memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

UncompressFileToMemAsync ⁽¹⁾

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

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

Returns nil on failure

UncompressFileToString

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

Uncompresses a .Z 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
# zFilename is a string
# charset is a string
ret_task = unixCompress.UncompressFileToStringAsync(zFilename, charset);

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

Returns nil on failure

UncompressMemory

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

Uncompresses from an in-memory image of a .Z file directly into memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

UncompressMemToFile

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

Uncompresses from an in-memory image of a .Z file to a file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

UncompressString

# inCompressedData is a CkByteData
# charset is a string
# outStr is a CkString (output)
status = unixCompress.UncompressString(inCompressedData, charset, outStr);
retStr = unixCompress.uncompressString(inCompressedData, charset);

Uncompresses from an in-memory image of a .Z file directly to a string. The charset specifies the character encoding used to interpret the bytes resulting from the decompression. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns true for success, false for failure.

More Information and Examples

List of Valid Charsets

UnTarZ

# zFilename is a string
# destDir is a string
# bNoAbsolute is a boolean
status = unixCompress.UnTarZ(zFilename, destDir, bNoAbsolute);

Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring.

Returns true for success, false for failure.

UnTarZAsync ⁽¹⁾

# returns a CkTask
# zFilename is a string
# destDir is a string
# bNoAbsolute is a boolean
ret_task = unixCompress.UnTarZAsync(zFilename, destDir, bNoAbsolute);

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

Returns nil on failure