Bz2 Go Reference Documentation

Bz2

Current Version: 10.1.0

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

bz2 := chilkat.NewBz2()
...
bz2.DisposeBz2()

Properties

AbortCurrent
func (bz2 *Bz2) AbortCurrent() bool
func (bz2 *Bz2) 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 (bz2 *Bz2) DebugLogFilePath() string
func (bz2 *Bz2) 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 (bz2 *Bz2) 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 (bz2 *Bz2) 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 (bz2 *Bz2) 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 (bz2 *Bz2) LastMethodSuccess() bool
func (bz2 *Bz2) 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 (bz2 *Bz2) VerboseLogging() bool
func (bz2 *Bz2) 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 (bz2 *Bz2) Version() string

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

More Information and Examples
top

Methods

CompressFile
func (bz2 *Bz2) CompressFile(inFilename string, toPath string) bool

Compresses a file to create a BZip2 compressed file (.bz2).

Note: Both inFilename and toPath should be relative or absolute file paths (not just a path to a directory). For example "someDir1/someDir2/myFile.txt" or "c:/someDir1/myFile.bz2".

Returns true for success, false for failure.

More Information and Examples
top
CompressFileAsync (1)
func (bz2 *Bz2) CompressFileAsync(inFilename string, toPath string, task chan *Task)

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

Returns nil on failure

top
CompressFileToMem
func (bz2 *Bz2) CompressFileToMem(inFilename string) []byte

BZip2 compresses a file to an in-memory image of a .bz2 file.

Returns nil on failure

top
CompressFileToMemAsync (1)
func (bz2 *Bz2) 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 (bz2 *Bz2) CompressMemory(inData []byte) []byte

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

Returns nil on failure

top
CompressMemoryAsync (1)
func (bz2 *Bz2) CompressMemoryAsync(inData []byte, task chan *Task)

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

Returns nil on failure

top
CompressMemToFile
func (bz2 *Bz2) CompressMemToFile(inData []byte, toPath string) bool

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

top
CompressMemToFileAsync (1)
func (bz2 *Bz2) CompressMemToFileAsync(inData []byte, toPath string, task chan *Task)

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

Returns nil on failure

top
LoadTaskCaller
func (bz2 *Bz2) 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 (bz2 *Bz2) UncompressFile(inFilename string, toPath string) bool

Unzips a .bz2 file.

Returns true for success, false for failure.

top
UncompressFileAsync (1)
func (bz2 *Bz2) UncompressFileAsync(inFilename string, toPath string, task chan *Task)

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

Returns nil on failure

top
UncompressFileToMem
func (bz2 *Bz2) UncompressFileToMem(inFilename string) []byte

Unzips a .bz2 file directly to memory.

Returns nil on failure

top
UncompressFileToMemAsync (1)
func (bz2 *Bz2) UncompressFileToMemAsync(inFilename string, task chan *Task)

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

Returns nil on failure

top
UncompressMemory
func (bz2 *Bz2) UncompressMemory(inData []byte) []byte

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns nil on failure

top
UncompressMemoryAsync (1)
func (bz2 *Bz2) UncompressMemoryAsync(inData []byte, task chan *Task)

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

Returns nil on failure

top
UncompressMemToFile
func (bz2 *Bz2) UncompressMemToFile(inData []byte, toPath string) bool

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

top
UncompressMemToFileAsync (1)
func (bz2 *Bz2) UncompressMemToFileAsync(inData []byte, toPath string, task chan *Task)

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

Returns nil on failure

top