UnixCompress Go Reference Documentation

UnixCompress

Current Version: 10.1.2

UNIX (.Z) compression component.

Object Creation

uc := chilkat.NewUnixCompress()
...
uc.DisposeUnixCompress()

Properties

AbortCurrent
func (uc *UnixCompress) AbortCurrent() bool
func (uc *UnixCompress) SetAbortCurrent(b bool)
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.)

top
DebugLogFilePath
func (uc *UnixCompress) DebugLogFilePath() string
func (uc *UnixCompress) SetDebugLogFilePath(s string)

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
top
LastErrorHtml
func (uc *UnixCompress) LastErrorHtml() string

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.

top
LastErrorText
func (uc *UnixCompress) LastErrorText() string

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.

top
LastErrorXml
func (uc *UnixCompress) LastErrorXml() string

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.

top
LastMethodSuccess
func (uc *UnixCompress) LastMethodSuccess() bool
func (uc *UnixCompress) SetLastMethodSuccess(b bool)

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.

top
VerboseLogging
func (uc *UnixCompress) VerboseLogging() bool
func (uc *UnixCompress) SetVerboseLogging(b bool)

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.

top
Version
func (uc *UnixCompress) Version() string

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

More Information and Examples
top

Methods

CompressFile
func (uc *UnixCompress) CompressFile(inFilename string, destPath string) bool

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.

top
CompressFileAsync (1)
func (uc *UnixCompress) CompressFileAsync(inFilename string, destPath string, task chan *Task)

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

Returns nil on failure

top
CompressFileToMem
func (uc *UnixCompress) CompressFileToMem(inFilename string) []byte

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

Returns nil on failure

top
CompressFileToMemAsync (1)
func (uc *UnixCompress) CompressFileToMemAsync(inFilename string, task chan *Task)

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

Returns nil on failure

top
CompressMemory
func (uc *UnixCompress) CompressMemory(inData []byte) []byte

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

Returns nil on failure

top
CompressMemToFile
func (uc *UnixCompress) CompressMemToFile(inData []byte, destPath string) bool

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.

top
CompressString
func (uc *UnixCompress) CompressString(inStr string, charset string) []byte

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 nil on failure

More Information and Examples
top
CompressStringToFile
func (uc *UnixCompress) CompressStringToFile(inStr string, charset string, destPath string) bool

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
top
LoadTaskCaller
func (uc *UnixCompress) LoadTaskCaller(task *Task) bool
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
UncompressFile
func (uc *UnixCompress) UncompressFile(inFilename string, destPath string) bool

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

Returns true for success, false for failure.

top
UncompressFileAsync (1)
func (uc *UnixCompress) UncompressFileAsync(inFilename string, destPath string, task chan *Task)

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

Returns nil on failure

top
UncompressFileToMem
func (uc *UnixCompress) UncompressFileToMem(inFilename string) []byte

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

Returns nil on failure

top
UncompressFileToMemAsync (1)
func (uc *UnixCompress) UncompressFileToMemAsync(inFilename string, task chan *Task)

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

Returns nil on failure

top
UncompressFileToString
func (uc *UnixCompress) UncompressFileToString(zFilename string, charset string) *string

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 nil on failure

More Information and Examples
top
UncompressFileToStringAsync (1)
func (uc *UnixCompress) UncompressFileToStringAsync(zFilename string, charset string, task chan *Task)

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

Returns nil on failure

top
UncompressMemory
func (uc *UnixCompress) UncompressMemory(inData []byte) []byte

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

Returns nil on failure

top
UncompressMemToFile
func (uc *UnixCompress) UncompressMemToFile(inData []byte, destPath string) bool

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.

top
UncompressString
func (uc *UnixCompress) UncompressString(inCompressedData []byte, charset string) *string

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 nil on failure

More Information and Examples
top
UnTarZ
func (uc *UnixCompress) UnTarZ(zFilename string, destDir string, bNoAbsolute bool) bool

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.

top
UnTarZAsync (1)
func (uc *UnixCompress) UnTarZAsync(zFilename string, destDir string, bNoAbsolute bool, task chan *Task)

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

Returns nil on failure

top